Class sap.ui.vbm.ContainersModule: sap/ui/vbm/Containers

extends VoAggregation

Type specific Visual Object aggregation for Container instances.

Constructor Summary
new sap.ui.vbm.Containers(sId?, mSettings?)Constructor for a new Containers.
Events borrowed from class sap.ui.vbm.VoAggregation
click, contextMenu, deselect, drop, handleClick, handleContextMenu, handleMoved, select
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.Containers.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.Containers with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.Containers.getMetadata()Returns a metadata object for class sap.ui.vbm.Containers.
addItem(oItem)Adds some item to the aggregation items.
destroyItems()Destroys all the items in the aggregation items.
getItems()Gets content of aggregation items.
indexOfItem(oItem)Checks for the provided sap.ui.vbm.Container 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.
Methods borrowed from class sap.ui.vbm.VoAggregation
attachClick, attachContextMenu, attachDeselect, attachDrop, attachHandleClick, attachHandleContextMenu, attachHandleMoved, attachSelect, detachClick, detachContextMenu, detachDeselect, detachDrop, detachHandleClick, detachHandleContextMenu, detachHandleMoved, detachSelect, fireClick, fireContextMenu, fireDeselect, fireDrop, fireHandleClick, fireHandleContextMenu, fireHandleMoved, fireSelect, getCustomProperties, getMaxSel, getMinSel, openDetailWindow, setCustomProperties, setMaxSel, setMinSel
Methods borrowed from class sap.ui.vbm.VoAbstract
openContextMenu
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.vbm.Containers(sId?, mSettings?)
Constructor for a new Containers.

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:

  • Aggregations
    • items : sap.ui.vbm.Container[] (default)

In addition, all settings applicable to the base type sap.ui.vbm.VoAggregation 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
Method Detail
sap.ui.vbm.Containers.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.Containers 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.vbm.VoAggregation.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.Containers.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.Containers.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addItem(oItem): sap.ui.vbm.Containers
Adds some item to the aggregation items.
Parameters:
{sap.ui.vbm.Container}oItem the item to add; if empty, nothing is inserted
Returns:
{sap.ui.vbm.Containers} Reference to this in order to allow method chaining
destroyItems(): sap.ui.vbm.Containers
Destroys all the items in the aggregation items.
Returns:
{sap.ui.vbm.Containers} Reference to this in order to allow method chaining
getItems(): sap.ui.vbm.Container[]
Gets content of aggregation items.

Container object aggregation

Returns:
{sap.ui.vbm.Container[]}
indexOfItem(oItem): int
Checks for the provided sap.ui.vbm.Container in the aggregation items. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vbm.Container}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.Containers
Inserts a item into the aggregation items.
Parameters:
{sap.ui.vbm.Container}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.Containers} Reference to this in order to allow method chaining
removeAllItems(): sap.ui.vbm.Container[]
Removes all the controls from the aggregation items.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vbm.Container[]} An array of the removed elements (might be empty)
removeItem(vItem): sap.ui.vbm.Container
Removes a item from the aggregation items.
Parameters:
{int|string|sap.ui.vbm.Container}vItem The itemto remove or its index or id
Returns:
{sap.ui.vbm.Container} The removed item or null