Class sap.ui.layout.ResponsiveSplitterModule: sap/ui/layout/ResponsiveSplitter

extends Control

ResponsiveSplitter is a control that enables responsiveness of normal Splitter. ResponsiveSplitter consists of PaneContainers that further agregate other PaneContainers and SplitPanes. SplitPanes can be moved to the pagination when a minimum width of their parent is reached.


Since: 1.38.
Constructor Summary
new sap.ui.layout.ResponsiveSplitter(sId?, mSettings?)Constructor for a new ResponsiveSplitter.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.layout.ResponsiveSplitter.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.layout.ResponsiveSplitter with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.layout.ResponsiveSplitter.getMetadata()Returns a metadata object for class sap.ui.layout.ResponsiveSplitter.
destroyRootPaneContainer()Destroys the rootPaneContainer in the aggregation rootPaneContainer.
getDefaultPane()ID of the element which is the current target of the association defaultPane, or null.
getHeight()Gets current value of property height.
getRootPaneContainer()Gets content of aggregation rootPaneContainer.
getWidth()Gets current value of property width.
setDefaultPane(oDefaultPane)Sets the associated defaultPane.
setHeight(sHeight)Sets a new value for property height.
setRootPaneContainer(oRootPaneContainer)Sets the aggregated rootPaneContainer.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.ui.layout.ResponsiveSplitter(sId?, mSettings?)
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 for a general description of the syntax of the settings object.

The supported settings are:

  • Properties
    • width : sap.ui.core.CSSSize (default: 100%)
    • height : sap.ui.core.CSSSize (default: 100%)
  • Aggregations

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.layout.ResponsiveSplitter.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

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.ResponsiveSplitter.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.layout.ResponsiveSplitter.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
destroyRootPaneContainer(): sap.ui.layout.ResponsiveSplitter
Destroys the rootPaneContainer in the aggregation rootPaneContainer.
Returns:
{sap.ui.layout.ResponsiveSplitter} Reference to this in order to allow method chaining
getDefaultPane(): sap.ui.layout.SplitPane
ID of the element which is the current target of the association defaultPane, or null.
Returns:
{sap.ui.layout.SplitPane}
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

The height of the control

Default value is 100%.

Returns:
{sap.ui.core.CSSSize} Value of property height
getRootPaneContainer(): sap.ui.layout.PaneContainer
Gets content of aggregation rootPaneContainer.

The root PaneContainer of the ResponsiveSplitter

Returns:
{sap.ui.layout.PaneContainer}
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

The width of the control

Default value is 100%.

Returns:
{sap.ui.core.CSSSize} Value of property width
setDefaultPane(oDefaultPane): sap.ui.layout.ResponsiveSplitter
Sets the associated defaultPane.
Parameters:
{sap.ui.layout.SplitPane}oDefaultPane Id of an element which becomes the new target of this defaultPane association; alternatively, an element instance may be given
Returns:
{sap.ui.layout.ResponsiveSplitter} Reference to this in order to allow method chaining
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%.

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.ui.layout.ResponsiveSplitter} Reference to this in order to allow method chaining
setRootPaneContainer(oRootPaneContainer): sap.ui.layout.ResponsiveSplitter
Sets the aggregated rootPaneContainer.
Parameters:
{sap.ui.layout.PaneContainer}oRootPaneContainer The rootPaneContainer to set
Returns:
{sap.ui.layout.ResponsiveSplitter} Reference to this in order to allow method chaining
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%.

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