Class sap.ui.ux3.ThingGroupModule: sap/ui/ux3/ThingGroup

extends Element

Thing Group Area

Deprecated API:Since version 1.38.

Constructor Summary
new sap.ui.ux3.ThingGroup(sId?, mSettings?)Constructor for a new ThingGroup.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.ux3.ThingGroup.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.ux3.ThingGroup with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.ux3.ThingGroup.getMetadata()Returns a metadata object for class sap.ui.ux3.ThingGroup.
addAction(oAction)Adds some action to the aggregation actions.
addContent(oContent)Adds some content to the aggregation content.
destroyActions()Destroys all the actions in the aggregation actions.
destroyContent()Destroys all the content in the aggregation content.
getActions()Gets content of aggregation actions.
getColspan()Gets current value of property colspan.
getContent()Gets content of aggregation content.
getTitle()Gets current value of property title.
indexOfAction(oAction)Checks for the provided sap.ui.ux3.ThingGroup in the aggregation actions.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
insertAction(oAction, iIndex)Inserts a action into the aggregation actions.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
removeAction(vAction)Removes a action from the aggregation actions.
removeAllActions()Removes all the controls from the aggregation actions.
removeAllContent()Removes all the controls from the aggregation content.
removeContent(vContent)Removes a content from the aggregation content.
setColspan(bColspan)Sets a new value for property colspan.
setTitle(sTitle)Sets a new value for property title.
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.ux3.ThingGroup(sId?, mSettings?)
Constructor for a new ThingGroup.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
  • Aggregations
    • content : sap.ui.core.Control[] (default)
    • actions : sap.ui.ux3.ThingGroup[]

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Deprecated:
Since version 1.38.
Method Detail
sap.ui.ux3.ThingGroup.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.ux3.ThingGroup with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Element.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.ux3.ThingGroup.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.ux3.ThingGroup.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAction(oAction): sap.ui.ux3.ThingGroup
Adds some action to the aggregation actions.
Parameters:
{sap.ui.ux3.ThingGroup}oAction the action to add; if empty, nothing is inserted
Returns:
{sap.ui.ux3.ThingGroup} Reference to this in order to allow method chaining
addContent(oContent): sap.ui.ux3.ThingGroup
Adds some content to the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to add; if empty, nothing is inserted
Returns:
{sap.ui.ux3.ThingGroup} Reference to this in order to allow method chaining
destroyActions(): sap.ui.ux3.ThingGroup
Destroys all the actions in the aggregation actions.
Returns:
{sap.ui.ux3.ThingGroup} Reference to this in order to allow method chaining
destroyContent(): sap.ui.ux3.ThingGroup
Destroys all the content in the aggregation content.
Returns:
{sap.ui.ux3.ThingGroup} Reference to this in order to allow method chaining
getActions(): sap.ui.ux3.ThingGroup[]
Gets content of aggregation actions.

Actions of the groups content

Returns:
{sap.ui.ux3.ThingGroup[]}
getColspan(): boolean
Gets current value of property colspan.

If Group is used in a column layout the groups spans the all columns if set to true.

Default value is false.

Returns:
{boolean} Value of property colspan
getContent(): sap.ui.core.Control[]
Gets content of aggregation content.

Content of Group

Returns:
{sap.ui.core.Control[]}
getTitle(): string
Gets current value of property title.

Title of Group

Returns:
{string} Value of property title
indexOfAction(oAction): int
Checks for the provided sap.ui.ux3.ThingGroup in the aggregation actions. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.ux3.ThingGroup}oAction The action whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfContent(oContent): int
Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oContent The content whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertAction(oAction, iIndex): sap.ui.ux3.ThingGroup
Inserts a action into the aggregation actions.
Parameters:
{sap.ui.ux3.ThingGroup}oAction the action to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the action should be inserted at; for a negative value of iIndex, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
Returns:
{sap.ui.ux3.ThingGroup} Reference to this in order to allow method chaining
insertContent(oContent, iIndex): sap.ui.ux3.ThingGroup
Inserts a content into the aggregation content.
Parameters:
{sap.ui.core.Control}oContent the content to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position
Returns:
{sap.ui.ux3.ThingGroup} Reference to this in order to allow method chaining
removeAction(vAction): sap.ui.ux3.ThingGroup
Removes a action from the aggregation actions.
Parameters:
{int|string|sap.ui.ux3.ThingGroup}vAction The actionto remove or its index or id
Returns:
{sap.ui.ux3.ThingGroup} The removed action or null
removeAllActions(): sap.ui.ux3.ThingGroup[]
Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.ux3.ThingGroup[]} An array of the removed elements (might be empty)
removeAllContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation content.
Parameters:
{int|string|sap.ui.core.Control}vContent The contentto remove or its index or id
Returns:
{sap.ui.core.Control} The removed content or null
setColspan(bColspan): sap.ui.ux3.ThingGroup
Sets a new value for property colspan.

If Group is used in a column layout the groups spans the all columns if set to true.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is false.

Parameters:
{boolean}bColspan New value for property colspan
Returns:
{sap.ui.ux3.ThingGroup} Reference to this in order to allow method chaining
setTitle(sTitle): sap.ui.ux3.ThingGroup
Sets a new value for property title.

Title of Group

When called with a value of null or undefined, the default value of the property will be restored.

Parameters:
{string}sTitle New value for property title
Returns:
{sap.ui.ux3.ThingGroup} Reference to this in order to allow method chaining