Class sap.ui.layout.VerticalLayoutModule: sap/ui/layout/VerticalLayout

extends Control
known direct subclasses: VerticalLayout

In this layout the content controls are rendered one below the other.
Since: 1.16.0.
Constructor Summary
new sap.ui.layout.VerticalLayout(sId?, mSettings?)Constructor for a new VerticalLayout.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.layout.VerticalLayout.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.layout.VerticalLayout with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.layout.VerticalLayout.getMetadata()Returns a metadata object for class sap.ui.layout.VerticalLayout.
addContent(oContent)Adds some content to the aggregation content.
destroyContent()Destroys all the content in the aggregation content.
getContent()Gets content of aggregation content.
getEnabled()Gets current value of property enabled.
getWidth()Gets current value of property width.
indexOfContent(oContent)Checks for the provided sap.ui.core.Control in the aggregation content.
insertContent(oContent, iIndex)Inserts a content into the aggregation content.
removeAllContent()Removes all the controls from the aggregation content.
removeContent(vContent)Removes a content from the aggregation content.
setEnabled(bEnabled)Sets a new value for property enabled.
Constructor Detail
new sap.ui.layout.VerticalLayout(sId?, mSettings?)

Constructor for a new VerticalLayout.

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

    • width : sap.ui.core.CSSSize
    • enabled : boolean (default: true)

  • Aggregations

    • content : sap.ui.core.Control[] (default)

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

Parameters:
stringsId?Id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Method Detail
sap.ui.layout.VerticalLayout.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.layout.VerticalLayout 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.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.layout.VerticalLayout.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.layout.VerticalLayout.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addContent(oContent): sap.ui.layout.VerticalLayout
Adds some content to the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to add; if empty, nothing is inserted
Returns:
sap.ui.layout.VerticalLayoutReference to this in order to allow method chaining
destroyContent(): sap.ui.layout.VerticalLayout
Destroys all the content in the aggregation content.
Returns:
sap.ui.layout.VerticalLayoutReference to this in order to allow method chaining
getAccessibilityInfo()
See:
sap.ui.core.Control#getAccessibilityInfo
getContent(): sap.ui.core.Control[]

Gets content of aggregation content.

Content controls within the layout.

Returns:
sap.ui.core.Control[]
getEnabled(): boolean

Gets current value of property enabled.

If not enabled, all controls inside are not enabled automatically.

Default value is true.

Returns:
booleanValue of property enabled
getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Width of the VerticalLayout. If no width is set, the width of the content is used. If the content of the layout has a larger width than the layout, it is cut off. There is no scrolling inside the layout.

Returns:
sap.ui.core.CSSSizeValue of property width
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.ControloContentThe content whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.ui.layout.VerticalLayout
Inserts a content into the aggregation content.
Parameters:
sap.ui.core.ControloContentthe content to insert; if empty, nothing is inserted
intiIndexthe 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.layout.VerticalLayoutReference to this in order to allow method chaining
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.ControlvContentThe content to remove or its index or id
Returns:
sap.ui.core.ControlThe removed content or null
setEnabled(bEnabled): sap.ui.layout.VerticalLayout

Sets a new value for property enabled.

If not enabled, all controls inside are not enabled automatically.

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

Default value is true.

Parameters:
booleanbEnabledNew value for property enabled
Returns:
sap.ui.layout.VerticalLayoutReference to this in order to allow method chaining