Class sap.ui.vbm.BoxesModule: sap/ui/vbm/Boxes

Type specific Visual Object aggregation for Box instances.

Constructor Summary
new sap.ui.vbm.Boxes(sId?, mSettings?)Constructor for a new Boxes.
Method Summary
sap.ui.vbm.Boxes.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Boxes with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Boxes.getMetadata()Returns a metadata object for class sap.ui.vbm.Boxes.
addItem(oItem)Adds some item to the aggregation items.
destroyItems()Destroys all the items in the aggregation items.
getItems()Gets content of aggregation items.
getPosChangeable()Gets current value of property posChangeable.
getScaleChangeable()Gets current value of property scaleChangeable.
indexOfItem(oItem)Checks for the provided sap.ui.vbm.Box in the aggregation items.
insertItem(oItem, iIndex)Inserts a item into the aggregation items.
removeAllItems()Removes all the controls from the aggregation items.
removeItem(vItem)Removes a item from the aggregation items.
setPosChangeable(bPosChangeable)Sets a new value for property posChangeable.
setScaleChangeable(bScaleChangeable)Sets a new value for property scaleChangeable.
Constructor Detail
new sap.ui.vbm.Boxes(sId?, mSettings?)
Constructor for a new Boxes.

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:

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

oClassInfo might contain the same kind of information as described in Object.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.vbm.Boxes.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Boxes.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.ui.vbm.Boxes
Adds some item to the aggregation items.
Parameters:
{sap.ui.vbm.Box}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.ui.vbm.Boxes} Reference to this in order to allow method chaining
destroyItems(): sap.ui.vbm.Boxes
Destroys all the items in the aggregation items.
Returns:
{sap.ui.vbm.Boxes} Reference to this in order to allow method chaining
getItems(): sap.ui.vbm.Box[]
Gets content of aggregation items.

Box object aggregation

Returns:
{sap.ui.vbm.Box[]}
getPosChangeable(): boolean
Gets current value of property posChangeable.

Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

Default value is true.

Returns:
{boolean} Value of property posChangeable
getScaleChangeable(): boolean
Gets current value of property scaleChangeable.

Set to true if scale may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

Default value is true.

Returns:
{boolean} Value of property scaleChangeable
indexOfItem(oItem): int
Checks for the provided sap.ui.vbm.Box in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.Box}oItem The item whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertItem(oItem, iIndex): sap.ui.vbm.Boxes
Inserts a item into the aggregation items.
Parameters:
{sap.ui.vbm.Box}oItem the item to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the item should be inserted at; for a negative value of iIndex, the item is inserted at position 0; for a value greater than the current size of the aggregation, the item is inserted at the last position
Returns:
{sap.ui.vbm.Boxes} Reference to this in order to allow method chaining
removeAllItems(): sap.ui.vbm.Box[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vbm.Box[]} An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.vbm.Box
Removes a item from the aggregation items.
Parameters:
{int|string|sap.ui.vbm.Box}vItem The itemto remove or its index or id
Returns:
{sap.ui.vbm.Box} The removed item or null
setPosChangeable(bPosChangeable): sap.ui.vbm.Boxes
Sets a new value for property posChangeable.

Set to true if position may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

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

Default value is true.

Parameters:
{boolean}bPosChangeable New value for property posChangeable
Returns:
{sap.ui.vbm.Boxes} Reference to this in order to allow method chaining
setScaleChangeable(bScaleChangeable): sap.ui.vbm.Boxes
Sets a new value for property scaleChangeable.

Set to true if scale may be changed at runtime. The actual changeability is control on each aggregated element with property changeable.

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

Default value is true.

Parameters:
{boolean}bScaleChangeable New value for property scaleChangeable
Returns:
{sap.ui.vbm.Boxes} Reference to this in order to allow method chaining