PaneContainer

extends Element

PaneContainer is an abstraction of Splitter Could be used as an aggregation of ResponsiveSplitter or other PaneContainers.

Since: 1.38.

Constructor Summary

new sap.ui.layout.PaneContainer(sId?, mSettings?)Constructor for a new PaneContainer.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.ui.layout.PaneContainer.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.layout.PaneContainer with name sClassName and enriches it with the information contained in oClassInfo.

sap.ui.layout.PaneContainer.getMetadata()Returns a metadata object for class sap.ui.layout.PaneContainer.

addPane(oPane)Adds some pane to the aggregation panes.

destroyPanes()Destroys all the panes in the aggregation panes.

getOrientation()Gets current value of property orientation.

getPanes()Gets content of aggregation panes.

indexOfPane(oPane)Checks for the provided sap.ui.core.Element in the aggregation panes.

insertPane(oPane, iIndex)Inserts a pane into the aggregation panes.

removeAllPanes()Removes all the controls from the aggregation panes.

removePane(vPane)Removes a pane from the aggregation panes.

setLayoutData(oLayoutData)Setter for property layoutData.

setOrientation(sOrientation)Setter for property orientation.

Methods borrowed from class sap.ui.core.Element

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.layout.PaneContainer(sId?, mSettings?)

Constructor for a new PaneContainer.

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
- orientation : sap.ui.core.Orientation (default: Horizontal)
Aggregations
- panes : sap.ui.core.Element[] (default)

In addition, all settings applicable to the base type sap.ui.core.Element 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.layout.PaneContainer.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.layout.PaneContainer 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.Element.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.layout.PaneContainer.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.layout.PaneContainer.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addPane(oPane): sap.ui.layout.PaneContainer

Adds some pane to the aggregation panes.

Parameters:

{sap.ui.core.Element}

oPane

the pane to add; if empty, nothing is inserted

Returns:

{sap.ui.layout.PaneContainer} Reference to this in order to allow method chaining

destroyPanes(): sap.ui.layout.PaneContainer

Destroys all the panes in the aggregation panes.

Returns:

{sap.ui.layout.PaneContainer} Reference to this in order to allow method chaining

getOrientation(): sap.ui.core.Orientation

Gets current value of property orientation.

The orientation of the Splitter

Default value is Horizontal.

Returns:

{sap.ui.core.Orientation} Value of property orientation

getPanes(): sap.ui.core.Element[]

Gets content of aggregation panes.

The Pane that will be shown when there is no suitable pane for ResponsiveSplitter's current width.

Returns:

{sap.ui.core.Element[]}

indexOfPane(oPane): int

Checks for the provided sap.ui.core.Element in the aggregation panes. and returns its index if found or -1 otherwise.

Parameters:

{sap.ui.core.Element}

oPane

The pane whose index is looked for

Returns:

{int}

The index of the provided control in the aggregation if found, or -1 otherwise

insertPane(oPane, iIndex): sap.ui.layout.PaneContainer

Inserts a pane into the aggregation panes.

Parameters:

{sap.ui.core.Element}	oPane	the pane to insert; if empty, nothing is inserted
{int}	iIndex	the `0`-based index the pane should be inserted at; for a negative value of `iIndex`, the pane is inserted at position 0; for a value greater than the current size of the aggregation, the pane is inserted at the last position

Returns:

{sap.ui.layout.PaneContainer} Reference to this in order to allow method chaining

removeAllPanes(): sap.ui.core.Element[]

Removes all the controls from the aggregation panes.

Additionally, it unregisters them from the hosting UIArea.

Returns:

{sap.ui.core.Element[]}

An array of the removed elements (might be empty)

removePane(vPane): sap.ui.core.Element

Removes a pane from the aggregation panes.

Parameters:

{int|string|sap.ui.core.Element}