Class sap.ui.vk.ListPanelStackModule: sap/ui/vk/ListPanelStack

extends Control

ListPanelStack control

Experimental API:Since 1.38.0 This class is experimental and might be modified or removed in future versions.

Constructor Summary
new sap.ui.vk.ListPanelStack(sId?, mSettings?)Constructor for a new ListPanelStack.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.vk.ListPanelStack.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.ListPanelStack with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vk.ListPanelStack.getMetadata()Returns a metadata object for class sap.ui.vk.ListPanelStack.
addContent(oContent)Adds some content to the aggregation content.
destroyContent()Destroys all the content in the aggregation content.
getCollapsible()Gets current value of property collapsible.
getContent()Gets content of aggregation content.
getExpandAnimation()Gets current value of property expandAnimation.
getExpanded()Gets current value of property expanded.
getWidth()Gets current value of property width.
indexOfContent(oContent)Checks for the provided sap.ui.vk.ListPanel 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.
setCollapsible(bCollapsible)Sets a new value for property collapsible.
setExpandAnimation(bExpandAnimation)Sets a new value for property expandAnimation.
setExpanded(bExpanded)Sets a new value for property expanded.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.ui.vk.ListPanelStack(sId?, mSettings?)
Constructor for a new ListPanelStack.

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.Control 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.vk.ListPanelStack.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vk.ListPanelStack 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:
{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.vk.ListPanelStack.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vk.ListPanelStack.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addContent(oContent): sap.ui.vk.ListPanelStack
Adds some content to the aggregation content.
Parameters:
{sap.ui.vk.ListPanel}oContent the content to add; if empty, nothing is inserted
Returns:
{sap.ui.vk.ListPanelStack} Reference to this in order to allow method chaining
destroyContent(): sap.ui.vk.ListPanelStack
Destroys all the content in the aggregation content.
Returns:
{sap.ui.vk.ListPanelStack} Reference to this in order to allow method chaining
getCollapsible(): boolean
Gets current value of property collapsible.

Ability to collapse

Default value is true.

Returns:
{boolean} Value of property collapsible
getContent(): sap.ui.vk.ListPanel[]
Gets content of aggregation content.
Returns:
{sap.ui.vk.ListPanel[]}
getExpandAnimation(): boolean
Gets current value of property expandAnimation.

Expand animation

Default value is true.

Returns:
{boolean} Value of property expandAnimation
getExpanded(): boolean
Gets current value of property expanded.

Expansion state

Default value is true.

Returns:
{boolean} Value of property expanded
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Control width

Default value is 100%.

Returns:
{sap.ui.core.CSSSize} Value of property width
indexOfContent(oContent): int
Checks for the provided sap.ui.vk.ListPanel in the aggregation content. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.vk.ListPanel}oContent The content whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertContent(oContent, iIndex): sap.ui.vk.ListPanelStack
Inserts a content into the aggregation content.
Parameters:
{sap.ui.vk.ListPanel}oContent the content to insert; if empty, nothing is inserted
{int}iIndex 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
Returns:
{sap.ui.vk.ListPanelStack} Reference to this in order to allow method chaining
removeAllContent(): sap.ui.vk.ListPanel[]
Removes all the controls from the aggregation content.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.vk.ListPanel[]} An array of the removed elements (might be empty)
removeContent(vContent): sap.ui.vk.ListPanel
Removes a content from the aggregation content.
Parameters:
{int|string|sap.ui.vk.ListPanel}vContent The contentto remove or its index or id
Returns:
{sap.ui.vk.ListPanel} The removed content or null
setCollapsible(bCollapsible): sap.ui.vk.ListPanelStack
Sets a new value for property collapsible.

Ability to collapse

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

Default value is true.

Parameters:
{boolean}bCollapsible New value for property collapsible
Returns:
{sap.ui.vk.ListPanelStack} Reference to this in order to allow method chaining
setExpandAnimation(bExpandAnimation): sap.ui.vk.ListPanelStack
Sets a new value for property expandAnimation.

Expand animation

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

Default value is true.

Parameters:
{boolean}bExpandAnimation New value for property expandAnimation
Returns:
{sap.ui.vk.ListPanelStack} Reference to this in order to allow method chaining
setExpanded(bExpanded): sap.ui.vk.ListPanelStack
Sets a new value for property expanded.

Expansion state

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

Default value is true.

Parameters:
{boolean}bExpanded New value for property expanded
Returns:
{sap.ui.vk.ListPanelStack} Reference to this in order to allow method chaining
setWidth(sWidth): sap.ui.vk.ListPanelStack
Sets a new value for property width.

Control width

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

Default value is 100%.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.vk.ListPanelStack} Reference to this in order to allow method chaining