Class sap.ui.core.VariantLayoutDataModule: sap/ui/core/VariantLayoutData

extends LayoutData

Allows to add multiple LayoutData to one control in case that a easy switch of layouts (e.g. in a Form) is needed.


Since: 1.9.2.
Constructor Summary
new sap.ui.core.VariantLayoutData(sId?, mSettings?)Constructor for a new VariantLayoutData.
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.core.VariantLayoutData.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.core.VariantLayoutData with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.core.VariantLayoutData.getMetadata()Returns a metadata object for class sap.ui.core.VariantLayoutData.
addMultipleLayoutData(oMultipleLayoutData)Adds some multipleLayoutData to the aggregation multipleLayoutData.
destroyMultipleLayoutData()Destroys all the multipleLayoutData in the aggregation multipleLayoutData.
getMultipleLayoutData()Gets content of aggregation multipleLayoutData.
indexOfMultipleLayoutData(oMultipleLayoutData)Checks for the provided sap.ui.core.LayoutData in the aggregation multipleLayoutData.
insertMultipleLayoutData(oMultipleLayoutData, iIndex)Inserts a multipleLayoutData into the aggregation multipleLayoutData.
removeAllMultipleLayoutData()Removes all the controls from the aggregation multipleLayoutData.
removeMultipleLayoutData(vMultipleLayoutData)Removes a multipleLayoutData from the aggregation multipleLayoutData.
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.core.VariantLayoutData(sId?, mSettings?)
Constructor for a new VariantLayoutData.

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:

In addition, all settings applicable to the base type sap.ui.core.LayoutData 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.core.VariantLayoutData.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.core.VariantLayoutData 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.LayoutData.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.core.VariantLayoutData.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.core.VariantLayoutData.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addMultipleLayoutData(oMultipleLayoutData): sap.ui.core.VariantLayoutData
Adds some multipleLayoutData to the aggregation multipleLayoutData.
Parameters:
{sap.ui.core.LayoutData}oMultipleLayoutData the multipleLayoutData to add; if empty, nothing is inserted
Returns:
{sap.ui.core.VariantLayoutData} Reference to this in order to allow method chaining
destroyMultipleLayoutData(): sap.ui.core.VariantLayoutData
Destroys all the multipleLayoutData in the aggregation multipleLayoutData.
Returns:
{sap.ui.core.VariantLayoutData} Reference to this in order to allow method chaining
getMultipleLayoutData(): sap.ui.core.LayoutData[]
Gets content of aggregation multipleLayoutData.

Allows multiple LayoutData.

Returns:
{sap.ui.core.LayoutData[]}
indexOfMultipleLayoutData(oMultipleLayoutData): int
Checks for the provided sap.ui.core.LayoutData in the aggregation multipleLayoutData. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.LayoutData}oMultipleLayoutData The multipleLayoutData whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertMultipleLayoutData(oMultipleLayoutData, iIndex): sap.ui.core.VariantLayoutData
Inserts a multipleLayoutData into the aggregation multipleLayoutData.
Parameters:
{sap.ui.core.LayoutData}oMultipleLayoutData the multipleLayoutData to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the multipleLayoutData should be inserted at; for a negative value of iIndex, the multipleLayoutData is inserted at position 0; for a value greater than the current size of the aggregation, the multipleLayoutData is inserted at the last position
Returns:
{sap.ui.core.VariantLayoutData} Reference to this in order to allow method chaining
removeAllMultipleLayoutData(): sap.ui.core.LayoutData[]
Removes all the controls from the aggregation multipleLayoutData.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.LayoutData[]} An array of the removed elements (might be empty)
removeMultipleLayoutData(vMultipleLayoutData): sap.ui.core.LayoutData
Removes a multipleLayoutData from the aggregation multipleLayoutData.
Parameters:
{int|string|sap.ui.core.LayoutData}vMultipleLayoutData The multipleLayoutDatato remove or its index or id
Returns:
{sap.ui.core.LayoutData} The removed multipleLayoutData or null