Class sap.ui.commons.SplitterModule: sap/ui/commons/Splitter

extends Control

Allows to split the screen into two areas. Make sure that the container for the splitter has an absolute height or set an absolute height for the splitter using the height property. Otherwise the height of the splitter is calculated by the height of its contents.
Deprecated API:
Since version 1.38. Instead, use the sap.ui.layout.Splitter control.
Constructor Summary
new sap.ui.commons.Splitter(sId?, mSettings?)Constructor for a new Splitter.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.commons.Splitter.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.Splitter with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.Splitter.getMetadata()Returns a metadata object for class sap.ui.commons.Splitter.
addFirstPaneContent(oFirstPaneContent)Adds some firstPaneContent to the aggregation firstPaneContent.
addSecondPaneContent(oSecondPaneContent)Adds some secondPaneContent to the aggregation secondPaneContent.
destroyFirstPaneContent()Destroys all the firstPaneContent in the aggregation firstPaneContent.
destroySecondPaneContent()Destroys all the secondPaneContent in the aggregation secondPaneContent.
getFirstPaneContent()Gets content of aggregation firstPaneContent.
getHeight()Gets current value of property height.
getMinSizeFirstPane()Gets current value of property minSizeFirstPane.
getMinSizeSecondPane()Gets current value of property minSizeSecondPane.
getSecondPaneContent()Gets content of aggregation secondPaneContent.
getShowScrollBars()Gets current value of property showScrollBars.
getSplitterBarVisible()Gets current value of property splitterBarVisible.
getSplitterOrientation()Gets current value of property splitterOrientation.
getSplitterPosition()Gets current value of property splitterPosition.
getWidth()Gets current value of property width.
indexOfFirstPaneContent(oFirstPaneContent)Checks for the provided sap.ui.core.Control in the aggregation firstPaneContent.
indexOfSecondPaneContent(oSecondPaneContent)Checks for the provided sap.ui.core.Control in the aggregation secondPaneContent.
insertFirstPaneContent(oFirstPaneContent, iIndex)Inserts a firstPaneContent into the aggregation firstPaneContent.
insertSecondPaneContent(oSecondPaneContent, iIndex)Inserts a secondPaneContent into the aggregation secondPaneContent.
removeAllFirstPaneContent()Removes all the controls from the aggregation firstPaneContent.
removeAllSecondPaneContent()Removes all the controls from the aggregation secondPaneContent.
removeFirstPaneContent(vFirstPaneContent)Removes a firstPaneContent from the aggregation firstPaneContent.
removeSecondPaneContent(vSecondPaneContent)Removes a secondPaneContent from the aggregation secondPaneContent.
setHeight(sHeight)Sets a new value for property height.
setMinSizeFirstPane(sMinSizeFirstPane)Sets a new value for property minSizeFirstPane.
setMinSizeSecondPane(sMinSizeSecondPane)Sets a new value for property minSizeSecondPane.
setShowScrollBars(bShowScrollBars)Sets a new value for property showScrollBars.
setSplitterBarVisible(bSplitterBarVisible)Sets a new value for property splitterBarVisible.
setSplitterOrientation(sSplitterOrientation)Sets a new value for property splitterOrientation.
setSplitterPosition(sSplitterPosition)Sets a new value for property splitterPosition.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.ui.commons.Splitter(sId?, mSettings?)

Constructor for a new Splitter.

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:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Method Detail
sap.ui.commons.Splitter.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.commons.Splitter 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:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.commons.Splitter.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.Splitter.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addFirstPaneContent(oFirstPaneContent): sap.ui.commons.Splitter
Adds some firstPaneContent to the aggregation firstPaneContent.
Parameters:
sap.ui.core.ControloFirstPaneContentthe firstPaneContent to add; if empty, nothing is inserted
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
addSecondPaneContent(oSecondPaneContent): sap.ui.commons.Splitter
Adds some secondPaneContent to the aggregation secondPaneContent.
Parameters:
sap.ui.core.ControloSecondPaneContentthe secondPaneContent to add; if empty, nothing is inserted
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
destroyFirstPaneContent(): sap.ui.commons.Splitter
Destroys all the firstPaneContent in the aggregation firstPaneContent.
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
destroySecondPaneContent(): sap.ui.commons.Splitter
Destroys all the secondPaneContent in the aggregation secondPaneContent.
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
getFirstPaneContent(): sap.ui.core.Control[]

Gets content of aggregation firstPaneContent.

Controls inside the first pane. These are the left ones in case of defining a vertical splitter, and the top ones in case of using the horizontal splitter.

Returns:
sap.ui.core.Control[]

Gets current value of property height.

The height of the split area in px or in %

Default value is 100%.

Returns:
sap.ui.commons.SplitterSizeValue of property height
getMinSizeFirstPane(): sap.ui.core.Percentage

Gets current value of property minSizeFirstPane.

The minimum size (width for vertical splitter or height for horizontal splitter) of the first Pane

Default value is 0%.

Returns:
sap.ui.core.PercentageValue of property minSizeFirstPane
getMinSizeSecondPane(): sap.ui.core.Percentage

Gets current value of property minSizeSecondPane.

The minimum size (width for vertical splitter or height for horizontal splitter) of the second Pane

Default value is 0%.

Returns:
sap.ui.core.PercentageValue of property minSizeSecondPane
getSecondPaneContent(): sap.ui.core.Control[]

Gets content of aggregation secondPaneContent.

Controls inside the second pane. These are the right ones in case of defining a vertical splitter, and the bottom ones in case of using the horizontal splitter.

Returns:
sap.ui.core.Control[]
getShowScrollBars(): boolean

Gets current value of property showScrollBars.

Specifies if the browser should display scroll bars or simply cut the content of a splitter pane when the content does not fit into its pane.

Default value is true.

Returns:
booleanValue of property showScrollBars
getSplitterBarVisible(): boolean

Gets current value of property splitterBarVisible.

set the splitter bar to be visible or not.

Default value is true.

Returns:
booleanValue of property splitterBarVisible
getSplitterOrientation(): sap.ui.core.Orientation

Gets current value of property splitterOrientation.

The splitter can have horizontal or vertical orientation.

Default value is Vertical.

Returns:
sap.ui.core.OrientationValue of property splitterOrientation
getSplitterPosition(): sap.ui.core.Percentage

Gets current value of property splitterPosition.

Position of splitter bar in percentage. The default value means that the splitter is positioned in the middle of the area that is available for the splitter.

Default value is 50%.

Returns:
sap.ui.core.PercentageValue of property splitterPosition

Gets current value of property width.

The width of the split area in px or in %

Default value is 100%.

Returns:
sap.ui.commons.SplitterSizeValue of property width
indexOfFirstPaneContent(oFirstPaneContent): int
Checks for the provided sap.ui.core.Control in the aggregation firstPaneContent. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloFirstPaneContentThe firstPaneContent whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
indexOfSecondPaneContent(oSecondPaneContent): int
Checks for the provided sap.ui.core.Control in the aggregation secondPaneContent. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloSecondPaneContentThe secondPaneContent whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertFirstPaneContent(oFirstPaneContent, iIndex): sap.ui.commons.Splitter
Inserts a firstPaneContent into the aggregation firstPaneContent.
Parameters:
sap.ui.core.ControloFirstPaneContentthe firstPaneContent to insert; if empty, nothing is inserted
intiIndexthe 0-based index the firstPaneContent should be inserted at; for a negative value of iIndex, the firstPaneContent is inserted at position 0; for a value greater than the current size of the aggregation, the firstPaneContent is inserted at the last position
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
insertSecondPaneContent(oSecondPaneContent, iIndex): sap.ui.commons.Splitter
Inserts a secondPaneContent into the aggregation secondPaneContent.
Parameters:
sap.ui.core.ControloSecondPaneContentthe secondPaneContent to insert; if empty, nothing is inserted
intiIndexthe 0-based index the secondPaneContent should be inserted at; for a negative value of iIndex, the secondPaneContent is inserted at position 0; for a value greater than the current size of the aggregation, the secondPaneContent is inserted at the last position
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
removeAllFirstPaneContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation firstPaneContent.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeAllSecondPaneContent(): sap.ui.core.Control[]

Removes all the controls from the aggregation secondPaneContent.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeFirstPaneContent(vFirstPaneContent): sap.ui.core.Control
Removes a firstPaneContent from the aggregation firstPaneContent.
Parameters:
int|string|sap.ui.core.ControlvFirstPaneContentThe firstPaneContent to remove or its index or id
Returns:
sap.ui.core.ControlThe removed firstPaneContent or null
removeSecondPaneContent(vSecondPaneContent): sap.ui.core.Control
Removes a secondPaneContent from the aggregation secondPaneContent.
Parameters:
int|string|sap.ui.core.ControlvSecondPaneContentThe secondPaneContent to remove or its index or id
Returns:
sap.ui.core.ControlThe removed secondPaneContent or null
setHeight(sHeight): sap.ui.commons.Splitter

Sets a new value for property height.

The height of the split area in px or in %

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.commons.SplitterSizesHeightNew value for property height
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
setMinSizeFirstPane(sMinSizeFirstPane): sap.ui.commons.Splitter

Sets a new value for property minSizeFirstPane.

The minimum size (width for vertical splitter or height for horizontal splitter) of the first Pane

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

Default value is 0%.

Parameters:
sap.ui.core.PercentagesMinSizeFirstPaneNew value for property minSizeFirstPane
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
setMinSizeSecondPane(sMinSizeSecondPane): sap.ui.commons.Splitter

Sets a new value for property minSizeSecondPane.

The minimum size (width for vertical splitter or height for horizontal splitter) of the second Pane

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

Default value is 0%.

Parameters:
sap.ui.core.PercentagesMinSizeSecondPaneNew value for property minSizeSecondPane
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
setShowScrollBars(bShowScrollBars): sap.ui.commons.Splitter

Sets a new value for property showScrollBars.

Specifies if the browser should display scroll bars or simply cut the content of a splitter pane when the content does not fit into its pane.

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

Default value is true.

Parameters:
booleanbShowScrollBarsNew value for property showScrollBars
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
setSplitterBarVisible(bSplitterBarVisible): sap.ui.commons.Splitter

Sets a new value for property splitterBarVisible.

set the splitter bar to be visible or not.

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

Default value is true.

Parameters:
booleanbSplitterBarVisibleNew value for property splitterBarVisible
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
setSplitterOrientation(sSplitterOrientation): sap.ui.commons.Splitter

Sets a new value for property splitterOrientation.

The splitter can have horizontal or vertical orientation.

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

Default value is Vertical.

Parameters:
sap.ui.core.OrientationsSplitterOrientationNew value for property splitterOrientation
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
setSplitterPosition(sSplitterPosition): sap.ui.commons.Splitter

Sets a new value for property splitterPosition.

Position of splitter bar in percentage. The default value means that the splitter is positioned in the middle of the area that is available for the splitter.

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

Default value is 50%.

Parameters:
sap.ui.core.PercentagesSplitterPositionNew value for property splitterPosition
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining
setWidth(sWidth): sap.ui.commons.Splitter

Sets a new value for property width.

The width of the split area in px or in %

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.commons.SplitterSizesWidthNew value for property width
Returns:
sap.ui.commons.SplitterReference to this in order to allow method chaining