A responsive splitter which divides the application into several areas.
The responsive splitter layout structures complex applications into defined areas. These areas may be resizable and are either distributed across one or multiple screen areas, some of which may also be off-canvas.
The control is intended for developing administrative tools and applications.
The responsive splitter holds the following hierarchy of containers and controls:
rootPaneContainer
holds all other pane containers and split panes.
Note: We don't recommend dynamically inserting/removing panes into/from the PaneContainer since this might lead to inconsistent layout. If it is necessary, you need to ensure the sum of all sizes of the SplitPanes doesn't exceed the width of the PaneContainer.
Constructor for a new ResponsiveSplitter.
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.ResponsiveSplitter(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 |
---|---|---|---|
height | sap.ui.core.CSSSize | 100% | The height of the control Visibility: public |
width | sap.ui.core.CSSSize | 100% | The width of the control Visibility: public |
Default Aggregation: rootPaneContainer
Name | Cardinality | Type | Description |
---|---|---|---|
_pages | 0..n | sap.ui.layout.ResponsiveSplitterPage |
Contains the internal pages that are used for pagination |
rootPaneContainer (default) | 0..1 | sap.ui.layout.PaneContainer |
The root PaneContainer of the ResponsiveSplitter |
Name | Cardinality | Type | Description |
---|---|---|---|
defaultPane | 0..1 | sap.ui.layout.SplitPane |
Defines which pane is displayed initially. If there is no defaultPane specified, the first pane is considered as default pane. |
Method | Description |
---|---|
destroyRootPaneContainer |
Destroys the rootPaneContainer in the aggregation rootPaneContainer. |
sap.ui.layout.ResponsiveSplitter.extend |
Creates a new subclass of class sap.ui.layout.ResponsiveSplitter with name
|
getDefaultPane |
ID of the element which is the current target of the association defaultPane, or |
getHeight |
Gets current value of property height. The height of the control Default value is |
sap.ui.layout.ResponsiveSplitter.getMetadata |
Returns a metadata object for class sap.ui.layout.ResponsiveSplitter. |
getRootPaneContainer |
Gets content of aggregation rootPaneContainer. The root PaneContainer of the ResponsiveSplitter |
getWidth |
Gets current value of property width. The width of the control Default value is |
setDefaultPane |
Sets the associated defaultPane. |
setHeight |
Sets a new value for property height. The height of the control When called with a value of Default value is |
setRootPaneContainer |
Sets the aggregated rootPaneContainer. |
setWidth |
Sets a new value for property width. The width of the control When called with a value of Default value is |
Creates a new subclass of class sap.ui.layout.ResponsiveSplitter 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.
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 |
ID of the element which is the current target of the association defaultPane, or null
.
Returns a metadata object for class sap.ui.layout.ResponsiveSplitter.
Gets content of aggregation rootPaneContainer.
The root PaneContainer of the ResponsiveSplitter
Sets the associated defaultPane.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDefaultPane | sap.ui.core.ID sap.ui.layout.SplitPane |
ID of an element which becomes the new target of this defaultPane association; alternatively, an element instance may be given |
Sets a new value for property height.
The height of the control
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is '100%'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHeight | sap.ui.core.CSSSize | '100%' |
New value for property |
Sets the aggregated rootPaneContainer.
Param | Type | DefaultValue | Description |
---|---|---|---|
oRootPaneContainer | sap.ui.layout.PaneContainer |
The rootPaneContainer to set |
Sets a new value for property width.
The width of the control
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is '100%'
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sWidth | sap.ui.core.CSSSize | '100%' |
New value for property |