com.sap.ui.commons.client
Class SplitterWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.SplitterWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class SplitterWidget
extends com.sap.ui.core.client.ControlWidget

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: )

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	SplitterWidget() constructs the class SplitterWidget
protected	SplitterWidget(Splitter control) constructs the class SplitterWidget
	SplitterWidget(String id) constructs the class SplitterWidget

Method Summary

void	addFirstPaneContent(com.sap.ui.core.client.Control firstPaneContent) Appends some firstPaneContent to the firstPaneContent-aggregation.
void	addSecondPaneContent(com.sap.ui.core.client.Control secondPaneContent) Appends some secondPaneContent to the secondPaneContent-aggregation.
void	destroyFirstPaneContent() Destroys all the firstPaneContent in the FirstPaneContent-aggregation.
void	destroySecondPaneContent() Destroys all the secondPaneContent in the SecondPaneContent-aggregation.
Splitter	getControl() returns the reference to the Phoenix Control
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.
void	insertFirstPaneContent(com.sap.ui.core.client.Control firstPaneContent, int index) Inserts some firstPaneContent into the aggregation named firstPaneContent.
void	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.
void	removeAllFirstPaneContent() Removes all the items in the firstPaneContent-aggregation.
void	removeAllSecondPaneContent() Removes all the items in the secondPaneContent-aggregation.
void	removeFirstPaneContent(int index) Removes the firstPaneContent at position index in the firstPaneContent-aggregation named.
void	removeSecondPaneContent(int index) Removes the secondPaneContent at position index in the secondPaneContent-aggregation named.
void	setHeight(String value) Setter for property height Default value is: 100%
void	setMinSizeFirstPane(String value) Setter for property minSizeFirstPane Default value is: 0%
void	setMinSizeSecondPane(String value) Setter for property minSizeSecondPane Default value is: 0%
void	setShowScrollBars(boolean value) Setter for property showScrollBars Default value is: true
void	setSplitterOrientation(Orientation value) Setter for property splitterOrientation Default value is: vertical
void	setSplitterPosition(String value) Setter for property splitterPosition Default value is: 50%
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setWidth(String value) Setter for property width Default value is: 100%

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SplitterWidget

public SplitterWidget()

constructs the class SplitterWidget

SplitterWidget

public SplitterWidget(String id)

constructs the class SplitterWidget

Parameters:

id - id of the SplitterWidget

SplitterWidget

protected SplitterWidget(Splitter control)

constructs the class SplitterWidget

Parameters:

control - reference to an existing Splitter

Method Detail

getControl

public Splitter getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getSplitterOrientation

public Orientation getSplitterOrientation()

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

Returns:

the value of property splitterOrientation

setSplitterOrientation

public void setSplitterOrientation(Orientation value)

Setter for property splitterOrientation
Default value is: vertical

Parameters:

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

getSplitterPosition

public 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 void setSplitterPosition(String value)

Setter for property splitterPosition
Default value is: 50%

Parameters:

value - String

getMinSizeFirstPane

public 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 void setMinSizeFirstPane(String value)

Setter for property minSizeFirstPane
Default value is: 0%

Parameters:

value - String

getMinSizeSecondPane

public 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 void setMinSizeSecondPane(String value)

Setter for property minSizeSecondPane
Default value is: 0%

Parameters:

value - String

getWidth

public String getWidth()

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

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width
Default value is: 100%

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

getHeight

public String getHeight()

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

Returns:

the value of property height

setHeight

public void setHeight(String value)

Setter for property height
Default value is: 100%

Overrides:

setHeight in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

isVisible

public boolean isVisible()

Getter for property visible Invisible splitters are not rendered.

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

setVisible in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - boolean

isShowScrollBars

public 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 void setShowScrollBars(boolean value)

Setter for property showScrollBars
Default value is: true

Parameters:

value - boolean

getFirstPaneContent

public 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 void 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.

addFirstPaneContent

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

Appends some firstPaneContent to the firstPaneContent-aggregation.

Parameters:

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

removeFirstPaneContent

public void removeFirstPaneContent(int index)

Removes the firstPaneContent at position index in the firstPaneContent-aggregation named.

Parameters:

index - int the position of the firstPaneContent to remove.

removeAllFirstPaneContent

public void removeAllFirstPaneContent()

Removes all the items in the firstPaneContent-aggregation.

indexOfFirstPaneContent

public 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 void destroyFirstPaneContent()

Destroys all the firstPaneContent in the FirstPaneContent-aggregation.

getSecondPaneContent

public 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 void 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.

addSecondPaneContent

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

Appends some secondPaneContent to the secondPaneContent-aggregation.

Parameters:

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

removeSecondPaneContent

public void removeSecondPaneContent(int index)

Removes the secondPaneContent at position index in the secondPaneContent-aggregation named.

Parameters:

index - int the position of the secondPaneContent to remove.

removeAllSecondPaneContent

public void removeAllSecondPaneContent()

Removes all the items in the secondPaneContent-aggregation.

indexOfSecondPaneContent

public 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 void destroySecondPaneContent()

Destroys all the secondPaneContent in the SecondPaneContent-aggregation.