class sap.ui.ux3.ThingGroup

Control sample: sap.ui.ux3.ThingGroup
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/ux3/ThingGroup
Application Component: CA-UI5-CTR

Thing Group Area


Constructor

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#constructor for a general description of the syntax of the settings object.

new sap.ui.ux3.ThingGroup(sId?, mSettings?)
Param Type Default Value Description
sId? string

id for the new control, generated automatically if no id is given

mSettings? object

initial settings for the new control


Properties

Name Type Default Value Description
colspan boolean false

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

Visibility: public
title string

Title of Group

Visibility: public

Aggregations

Default Aggregation: content

Name Cardinality Type Description
actions 0..n sap.ui.ux3.ThingGroup

Actions of the groups content

content (default) 0..n sap.ui.core.Control

Content of Group


Methods Overview

Method Description
addAction

Adds some action to the aggregation actions.

addContent

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.

sap.ui.ux3.ThingGroup.extend

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.

getActions

Gets content of aggregation actions.

Actions of the groups content

getColspan

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.

getContent

Gets content of aggregation content.

Content of Group

sap.ui.ux3.ThingGroup.getMetadata

Returns a metadata object for class sap.ui.ux3.ThingGroup.

getTitle

Gets current value of property title.

Title of Group

indexOfAction

Checks for the provided sap.ui.ux3.ThingGroup in the aggregation actions. and returns its index if found or -1 otherwise.

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

insertAction

Inserts a action into the aggregation actions.

insertContent

Inserts a content into the aggregation content.

removeAction

Removes a action from the aggregation actions.

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

setColspan

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.

setTitle

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.

addAction

Adds some action to the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.ux3.ThingGroup

The action to add; if empty, nothing is inserted

addContent

Adds some content to the aggregation content.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content to add; if empty, nothing is inserted

destroyActions

Destroys all the actions in the aggregation actions.

destroyContent

Destroys all the content in the aggregation content.

sap.ui.ux3.ThingGroup.extend

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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

getActions

Gets content of aggregation actions.

Actions of the groups content

getColspan

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.

getContent

Gets content of aggregation content.

Content of Group

sap.ui.ux3.ThingGroup.getMetadata

Returns a metadata object for class sap.ui.ux3.ThingGroup.

getTitle

Gets current value of property title.

Title of Group

indexOfAction

Checks for the provided sap.ui.ux3.ThingGroup in the aggregation actions. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oAction sap.ui.ux3.ThingGroup

The action whose index is looked for

indexOfContent

Checks for the provided sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content whose index is looked for

insertAction

Inserts a action into the aggregation actions.

Param Type DefaultValue Description
oAction sap.ui.ux3.ThingGroup

The action to insert; if empty, nothing is inserted

iIndex int

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

insertContent

Inserts a content into the aggregation content.

Param Type DefaultValue Description
oContent sap.ui.core.Control

The content to insert; if empty, nothing is inserted

iIndex int

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

removeAction

Removes a action from the aggregation actions.

Param Type DefaultValue Description
vAction int string sap.ui.ux3.ThingGroup

The action to remove or its index or id

removeAllActions

Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

removeAllContent

Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

removeContent

Removes a content from the aggregation content.

Param Type DefaultValue Description
vContent int string sap.ui.core.Control

The content to remove or its index or id

setColspan

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.

Param Type DefaultValue Description
bColspan boolean false

New value for property colspan

setTitle

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.

Param Type DefaultValue Description
sTitle string

New value for property title