com.sap.ui.commons.client
Class Splitter

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.Splitter

public class Splitter
extends com.sap.ui.core.client.Control

The class Splitter is the GWT wrapper for the Phoenix control: sap.ui.commons.Splitter.

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.

• Properties
  • splitterOrientation : com.sap.ui.commons.client.Orientation
    The line can have horizontal or vertical orientation.
  • splitterPosition : String
    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.
  • minSizeFirstPane : String
    The minimum size (width for vertical splitter or height for horizontal splitter) of the first Pane
  • minSizeSecondPane : String
    The minimum size (width for vertical splitter or height for horizontal splitter) of the second Pane
  • width : String
    The width of the split area in px or in %
  • height : String
    The height of the split area in px or in %
  • visible : boolean
    Invisible splitters are not rendered.
  • showScrollBars : boolean
    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.
• Aggregations
  • firstPaneContent : com.sap.ui.core.client.Control
    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.
  • secondPaneContent : com.sap.ui.core.client.Control
    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.
• Associations
• Events

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.Splitter)

Constructor Summary

protected

Splitter() constructs the class Splitter hidden due to JavaScriptObject restriction

Method Summary

Splitter	addFirstPaneContent(com.sap.ui.core.client.Control firstPaneContent) Appends a firstPaneContent to the aggregation firstPaneContent.
Splitter	addSecondPaneContent(com.sap.ui.core.client.Control secondPaneContent) Appends a secondPaneContent to the aggregation secondPaneContent.
static Splitter	create() creates a new instance of the class Splitter
static Splitter	create(String idOrConfig) creates a new instance of the class Splitter
static Splitter	create(String id, String config) creates a new instance of the class Splitter
Splitter	destroyFirstPaneContent() Destroys all the firstPaneContent in the FirstPaneContent-aggregation.
Splitter	destroySecondPaneContent() Destroys all the secondPaneContent in the SecondPaneContent-aggregation.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	getFirstPaneContent() Getter for aggregation firstPaneContent Controls inside the first pane.
String	getHeight() Getter for property height The height of the split area in px or in %
String	getMinSizeFirstPane() Getter for property minSizeFirstPane The minimum size (width for vertical splitter or height for horizontal splitter) of the first Pane
String	getMinSizeSecondPane() Getter for property minSizeSecondPane The minimum size (width for vertical splitter or height for horizontal splitter) of the second Pane
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	getSecondPaneContent() Getter for aggregation secondPaneContent Controls inside the second pane.
Orientation	getSplitterOrientation() Getter for property splitterOrientation The line can have horizontal or vertical orientation.
String	getSplitterPosition() Getter for property splitterPosition Position of splitter bar in percentage.
String	getWidth() Getter for property width The width of the split area in px or in %
int	indexOfFirstPaneContent(com.sap.ui.core.client.Control firstPaneContent) Checks for the provided com.sap.ui.core.client.Control in the firstPaneContent-aggregation and returns its index if found or -1 otherwise.
int	indexOfSecondPaneContent(com.sap.ui.core.client.Control secondPaneContent) Checks for the provided com.sap.ui.core.client.Control in the secondPaneContent-aggregation and returns its index if found or -1 otherwise.
Splitter	insertFirstPaneContent(com.sap.ui.core.client.Control firstPaneContent, int index) Inserts some firstPaneContent into the aggregation named firstPaneContent.
Splitter	insertSecondPaneContent(com.sap.ui.core.client.Control secondPaneContent, int index) Inserts some secondPaneContent into the aggregation named secondPaneContent.
boolean	isShowScrollBars() Getter 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.
boolean	isVisible() Getter for property visible Invisible splitters are not rendered.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>>	removeAllFirstPaneContent() Removes all the items in the firstPaneContent-aggregation.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>>	removeAllSecondPaneContent() Removes all the items in the secondPaneContent-aggregation.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	removeFirstPaneContent(int index) Removes a firstPaneContent from the aggregation named firstPaneContent.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>	removeSecondPaneContent(int index) Removes a secondPaneContent from the aggregation named secondPaneContent.
Splitter	setHeight(String value) Setter for property height Default value is: 100%
Splitter	setMinSizeFirstPane(String value) Setter for property minSizeFirstPane Default value is: 0%
Splitter	setMinSizeSecondPane(String value) Setter for property minSizeSecondPane Default value is: 0%
Splitter	setShowScrollBars(boolean value) Setter for property showScrollBars Default value is: true
Splitter	setSplitterOrientation(Orientation value) Setter for property splitterOrientation Default value is: vertical
Splitter	setSplitterPosition(String value) Setter for property splitterPosition Default value is: 50%
Splitter	setVisible(boolean value) Setter for property visible Default value is: true
Splitter	setWidth(String value) Setter for property width Default value is: 100%

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Splitter

protected Splitter()

constructs the class Splitter
hidden due to JavaScriptObject restriction

Method Detail

create

public static Splitter create()

creates a new instance of the class Splitter

create

public static Splitter create(String idOrConfig)

creates a new instance of the class Splitter

Parameters:

id - id of the Splitter or configuration JSON string

create

public static Splitter create(String id,
                              String config)

creates a new instance of the class Splitter

Parameters:

id - id of the Splitter

config - configuration JSON string

getSplitterOrientation

public final Orientation getSplitterOrientation()

Getter for property splitterOrientation The line can have horizontal or vertical orientation.

Returns:

the value of property splitterOrientation

setSplitterOrientation

public final Splitter setSplitterOrientation(Orientation value)

Setter for property splitterOrientation
Default value is: vertical

Parameters:

value - com.sap.ui.commons.client.Orientation

Returns:

this to allow method chaining

getSplitterPosition

public final String getSplitterPosition()

Getter 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.

Returns:

the value of property splitterPosition

setSplitterPosition

public final Splitter setSplitterPosition(String value)

Setter for property splitterPosition
Default value is: 50%

Parameters:

value - String

Returns:

this to allow method chaining

getMinSizeFirstPane

public final String getMinSizeFirstPane()

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

Returns:

the value of property minSizeFirstPane

setMinSizeFirstPane

public final Splitter setMinSizeFirstPane(String value)

Setter for property minSizeFirstPane
Default value is: 0%

Parameters:

value - String

Returns:

this to allow method chaining

getMinSizeSecondPane

public final String getMinSizeSecondPane()

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

Returns:

the value of property minSizeSecondPane

setMinSizeSecondPane

public final Splitter setMinSizeSecondPane(String value)

Setter for property minSizeSecondPane
Default value is: 0%

Parameters:

value - String

Returns:

this to allow method chaining

getWidth

public final String getWidth()

Getter for property width The width of the split area in px or in %

Returns:

the value of property width

setWidth

public final Splitter setWidth(String value)

Setter for property width
Default value is: 100%

Parameters:

value - String

Returns:

this to allow method chaining

getHeight

public final String getHeight()

Getter for property height The height of the split area in px or in %

Returns:

the value of property height

setHeight

public final Splitter setHeight(String value)

Setter for property height
Default value is: 100%

Parameters:

value - String

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible splitters are not rendered.

Returns:

the value of property visible

setVisible

public final Splitter setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isShowScrollBars

public final boolean isShowScrollBars()

Getter 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.

Returns:

the value of property showScrollBars

setShowScrollBars

public final Splitter setShowScrollBars(boolean value)

Setter for property showScrollBars
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getFirstPaneContent

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control> getFirstPaneContent()

Getter for 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:

com.sap.ui.core.client.Control[]

insertFirstPaneContent

public final Splitter insertFirstPaneContent(com.sap.ui.core.client.Control firstPaneContent,
                                             int index)

Inserts some firstPaneContent into the aggregation named firstPaneContent.

Parameters:

firstPaneContent - the firstPaneContent to insert

index - int the 0-based index the firstPaneContent should be inserted at.

Returns:

this to allow method chaining

addFirstPaneContent

public final Splitter addFirstPaneContent(com.sap.ui.core.client.Control firstPaneContent)

Appends a firstPaneContent to the aggregation firstPaneContent.

Parameters:

firstPaneContent - com.sap.ui.core.client.Control the firstPaneContent to add

Returns:

this to allow method chaining

removeFirstPaneContent

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control> removeFirstPaneContent(int index)

Removes a firstPaneContent from the aggregation named firstPaneContent.

Parameters:

index - int the position of the firstPaneContent to remove.

Returns:

reference to this instance

removeAllFirstPaneContent

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>> removeAllFirstPaneContent()

Removes all the items in the firstPaneContent-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfFirstPaneContent

public final int indexOfFirstPaneContent(com.sap.ui.core.client.Control firstPaneContent)

Checks for the provided com.sap.ui.core.client.Control in the firstPaneContent-aggregation and returns its index if found or -1 otherwise.

Parameters:

firstPaneContent - the firstPaneContent whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyFirstPaneContent

public final Splitter destroyFirstPaneContent()

Destroys all the firstPaneContent in the FirstPaneContent-aggregation.

Returns:

this to allow method chaining

getSecondPaneContent

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control> getSecondPaneContent()

Getter for 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:

com.sap.ui.core.client.Control[]

insertSecondPaneContent

public final Splitter insertSecondPaneContent(com.sap.ui.core.client.Control secondPaneContent,
                                              int index)

Inserts some secondPaneContent into the aggregation named secondPaneContent.

Parameters:

secondPaneContent - the secondPaneContent to insert

index - int the 0-based index the secondPaneContent should be inserted at.

Returns:

this to allow method chaining

addSecondPaneContent

public final Splitter addSecondPaneContent(com.sap.ui.core.client.Control secondPaneContent)

Appends a secondPaneContent to the aggregation secondPaneContent.

Parameters:

secondPaneContent - com.sap.ui.core.client.Control the secondPaneContent to add

Returns:

this to allow method chaining

removeSecondPaneContent

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control> removeSecondPaneContent(int index)

Removes a secondPaneContent from the aggregation named secondPaneContent.

Parameters:

index - int the position of the secondPaneContent to remove.

Returns:

reference to this instance

removeAllSecondPaneContent

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Control>> removeAllSecondPaneContent()

Removes all the items in the secondPaneContent-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfSecondPaneContent

public final int indexOfSecondPaneContent(com.sap.ui.core.client.Control secondPaneContent)

Checks for the provided com.sap.ui.core.client.Control in the secondPaneContent-aggregation and returns its index if found or -1 otherwise.

Parameters:

secondPaneContent - the secondPaneContent whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroySecondPaneContent

public final Splitter destroySecondPaneContent()

Destroys all the secondPaneContent in the SecondPaneContent-aggregation.

Returns:

this to allow method chaining