PaneContainer is an abstraction of Splitter.
Could be used as an aggregation of ResponsiveSplitter or nested in other PaneContainers.
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#constructor for a general description of the syntax of the settings object.
new sap.ui.layout.PaneContainer(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
orientation | sap.ui.core.Orientation | Horizontal | The orientation of the Splitter Visibility: public |
Default Aggregation: panes
Name | Cardinality | Type | Description |
---|---|---|---|
panes (default) | 0..n | sap.ui.core.Element |
The panes to be split. The control will show n-1 splitter bars between n controls in this aggregation. |
Fired when contents are resized.
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
oldSizes | float[] |
An array of values representing the old (pixel)sizes of the split panes, which are inside the pane container. |
newSizes | float[] |
An array of values representing the new (pixel)sizes of the split panes, which are inside the pane container. |
Method | Description |
---|---|
addPane |
Adds some pane to the aggregation panes. |
attachResize |
Attaches event handler When called, the context of the event handler (its Fired when contents are resized. |
destroyPanes |
Destroys all the panes in the aggregation panes. |
detachResize |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.ui.layout.PaneContainer.extend |
Creates a new subclass of class sap.ui.layout.PaneContainer with name
|
fireResize |
Fires event resize to attached listeners. |
getLayoutData |
Getter for property layoutData. |
sap.ui.layout.PaneContainer.getMetadata |
Returns a metadata object for class sap.ui.layout.PaneContainer. |
getOrientation |
Gets current value of property orientation. The orientation of the Splitter Default value is |
getPanes |
Gets content of aggregation panes. The panes to be split. The control will show n-1 splitter bars between n controls in this aggregation. |
indexOfPane |
Checks for the provided |
insertPane |
Pane insertion |
removeAllPanes |
Removes all the controls from the aggregation panes. Additionally, it unregisters them from the hosting UIArea. |
removePane |
Pane removal |
setLayoutData |
Setter for property layoutData. |
setOrientation |
Setter for property orientation. Default value is sap.ui.core.Orientation.Horizontal |
Adds some pane to the aggregation panes.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPane | sap.ui.core.Element |
The pane to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the resize event of this sap.ui.layout.PaneContainer
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.ui.layout.PaneContainer
itself.
Fired when contents are resized.
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Detaches event handler fnFunction
from the resize event of this sap.ui.layout.PaneContainer
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event resize to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
oldSizes | float[] |
An array of values representing the old (pixel)sizes of the split panes, which are inside the pane container. |
|
newSizes | float[] |
An array of values representing the new (pixel)sizes of the split panes, which are inside the pane container. |
Returns a metadata object for class sap.ui.layout.PaneContainer.
Gets current value of property orientation.
The orientation of the Splitter
Default value is Horizontal
.
Gets content of aggregation panes.
The panes to be split. The control will show n-1 splitter bars between n controls in this aggregation.
Checks for the provided sap.ui.core.Element
in the aggregation panes. and returns its index if found or -1 otherwise.
Param | Type | DefaultValue | Description |
---|---|---|---|
oPane | sap.ui.core.Element |
The pane whose index is looked for |
Removes all the controls from the aggregation panes.
Additionally, it unregisters them from the hosting UIArea.
Setter for property layoutData.
Param | Type | DefaultValue | Description |
---|---|---|---|
oLayoutData | sap.ui.core.LayoutData |
The LayoutData object. |
Setter for property orientation. Default value is sap.ui.core.Orientation.Horizontal
Param | Type | DefaultValue | Description |
---|---|---|---|
sOrientation | sap.ui.core.Orientation |
The Orientation type. |