nextapp.echo.app
Class SplitPane

java.lang.Object
  nextapp.echo.app.Component
      nextapp.echo.app.SplitPane

All Implemented Interfaces:

java.io.Serializable, Pane, PaneContainer, RenderIdSupport

public class SplitPane
extends Component
implements Pane, PaneContainer

SplitPane component: a pane component which displays two components horizontally or vertically adjacent to one another, optionally allowing the user to apportion space between the two using a resize handle. May have at most two child components. Supports Pane components as children.

Child LayoutData: Children of this component may provide layout information using the nextapp.echo.app.layout.SplitPaneLayoutData layout data object.

See Also:

SplitPaneLayoutData, Serialized Form

Field Summary

static int	ORIENTATION_HORIZONTAL Shorthand for ORIENTATION_HORIZONTAL_LEADING_TRAILING.
static int	ORIENTATION_HORIZONTAL_LEADING_TRAILING An orientation constant indicating that the SplitPane should be laid out horizontally with the first (fixed-size) pane in the leading position.
static int	ORIENTATION_HORIZONTAL_LEFT_RIGHT An orientation constant indicating that the SplitPane should be laid out horizontally with the first (fixed-size) pane in the left position.
static int	ORIENTATION_HORIZONTAL_RIGHT_LEFT An orientation constant indicating that the SplitPane should be laid out horizontally with the first (fixed-size) pane in the right position.
static int	ORIENTATION_HORIZONTAL_TRAILING_LEADING An orientation constant indicating that the SplitPane should be laid out horizontally with the first (fixed-size) pane in the trailing position.
static int	ORIENTATION_VERTICAL Shorthand for ORIENTATION_VERTICAL_TOP_BOTTOM.
static int	ORIENTATION_VERTICAL_BOTTOM_TOP An orientation constant indicating that the SplitPane should be laid out vertically with the first (fixed-size) pane in the bottom position.
static int	ORIENTATION_VERTICAL_TOP_BOTTOM An orientation constant indicating that the SplitPane should be laid out vertically with the first (fixed-size) pane in the top position.
static java.lang.String	PROPERTY_AUTO_POSITIONED
static java.lang.String	PROPERTY_ORIENTATION
static java.lang.String	PROPERTY_RESIZABLE
static java.lang.String	PROPERTY_SEPARATOR_COLOR
static java.lang.String	PROPERTY_SEPARATOR_HEIGHT
static java.lang.String	PROPERTY_SEPARATOR_HORIZONTAL_IMAGE
static java.lang.String	PROPERTY_SEPARATOR_HORIZONTAL_ROLLOVER_IMAGE
static java.lang.String	PROPERTY_SEPARATOR_POSITION
static java.lang.String	PROPERTY_SEPARATOR_ROLLOVER_COLOR
static java.lang.String	PROPERTY_SEPARATOR_VERTICAL_IMAGE
static java.lang.String	PROPERTY_SEPARATOR_VERTICAL_ROLLOVER_IMAGE
static java.lang.String	PROPERTY_SEPARATOR_VISIBLE
static java.lang.String	PROPERTY_SEPARATOR_WIDTH

Fields inherited from class nextapp.echo.app.Component

CHILD_VISIBLE_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

SplitPane()
Creates a new SplitPane with default (horizontal) orientation.

SplitPane(int orientation)
Creates a new SplitPane with the specified orientation.

SplitPane(int orientation, boolean autoPositioned)
Creates a new SplitPane with the specified orientation and auto-positioned state.

SplitPane(int orientation, Extent separatorPosition)
Creates a new SplitPane with the specified orientation and separator position.

Method Summary

int	getOrientation() Returns the orientation of the SplitPane.
Color	getSeparatorColor() Returns the color of the pane separator.
Extent	getSeparatorHeight() Returns the height of the pane separator.
FillImage	getSeparatorHorizontalImage() Returns the fill image of the pane separator that is displayed when the SplitPane has a horizontal orientation.
FillImage	getSeparatorHorizontalRolloverImage() Returns the rollover fill image of the pane separator that is displayed when the SplitPane has a horizontal orientation.
Extent	getSeparatorPosition() Returns the position of the pane separator.
Color	getSeparatorRolloverColor() Returns the color of the pane separator.
FillImage	getSeparatorVerticalImage() Returns the fill image of the pane separator that is displayed when the SplitPane has a vertical orientation.
FillImage	getSeparatorVerticalRolloverImage() Returns the rollover fill image of the pane separator that is displayed when the SplitPane has a vertical orientation.
Extent	getSeparatorWidth() Returns the width of the pane separator.
boolean	isAutoPositioned() Determines if the SplitPane is auto-positioned.
boolean	isResizable() Determines if the SplitPane is resizable.
boolean	isSeparatorVisible(boolean newValue) Determines if the separator should be rendered visible.
boolean	isValidChild(Component component) No more than two children may be added.
boolean	isValidParent(Component parent) Determines if this Component is valid to be added as a child of the given parent Component.
void	processInput(java.lang.String inputName, java.lang.Object inputValue) Processes client input specific to the Component received from the UpdateManager.
void	setAutoPositioned(boolean newValue) Sets whether the SplitPane is auto-positioned.
void	setOrientation(int newValue) Sets the orientation of the SplitPane.
void	setResizable(boolean newValue) Sets whether the SplitPane is resizable.
void	setSeparatorColor(Color newValue) Sets the color of the pane separator.
void	setSeparatorHeight(Extent newValue) Sets the height of the pane separator.
void	setSeparatorHorizontalImage(FillImage newValue) Sets the fill image of the pane separator that is displayed when the SplitPane has a horizontal orientation.
void	setSeparatorHorizontalRolloverImage(FillImage newValue) Sets the rollover fill image of the pane separator that is displayed when the SplitPane has a horizontal orientation.
void	setSeparatorPosition(Extent newValue) Sets the position of the pane separator.
void	setSeparatorRolloverColor(Color newValue) Sets the rollover color of the pane separator.
void	setSeparatorRolloverVerticalImage(FillImage newValue) Sets the rollover fill image of the pane separator that is displayed when the SplitPane has a vertical orientation.
void	setSeparatorVerticalImage(FillImage newValue) Sets the fill image of the pane separator that is displayed when the SplitPane has a vertical orientation.
void	setSeparatorVisible(boolean newValue) Sets whether the separator is visible.
void	setSeparatorWidth(Extent newValue) Sets the width of the pane separator.

Methods inherited from class nextapp.echo.app.Component

add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, get, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndex, getLayoutData, getLayoutDirection, getLocale, getLocalStyle, getParent, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, set, setBackground, setComponents, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndex, setLayoutData, setLayoutDirection, setLocale, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf

Methods inherited from class java.lang.Object

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

Field Detail

ORIENTATION_HORIZONTAL_LEADING_TRAILING

public static final int ORIENTATION_HORIZONTAL_LEADING_TRAILING

An orientation constant indicating that the SplitPane should be laid out horizontally with the first (fixed-size) pane in the leading position. The leading position is on the left side for left-to-right languages and on the right side for right-to-left languages.

See Also:

Constant Field Values

ORIENTATION_HORIZONTAL_TRAILING_LEADING

public static final int ORIENTATION_HORIZONTAL_TRAILING_LEADING

An orientation constant indicating that the SplitPane should be laid out horizontally with the first (fixed-size) pane in the trailing position. The trailing position is on the right side for left-to-right languages and on the left side for right-to-left languages.

See Also:

Constant Field Values

ORIENTATION_HORIZONTAL_LEFT_RIGHT

public static final int ORIENTATION_HORIZONTAL_LEFT_RIGHT

An orientation constant indicating that the SplitPane should be laid out horizontally with the first (fixed-size) pane in the left position.

See Also:

Constant Field Values

ORIENTATION_HORIZONTAL_RIGHT_LEFT

public static final int ORIENTATION_HORIZONTAL_RIGHT_LEFT

An orientation constant indicating that the SplitPane should be laid out horizontally with the first (fixed-size) pane in the right position.

See Also:

Constant Field Values

ORIENTATION_VERTICAL_TOP_BOTTOM

public static final int ORIENTATION_VERTICAL_TOP_BOTTOM

An orientation constant indicating that the SplitPane should be laid out vertically with the first (fixed-size) pane in the top position.

See Also:

Constant Field Values

ORIENTATION_VERTICAL_BOTTOM_TOP

public static final int ORIENTATION_VERTICAL_BOTTOM_TOP

An orientation constant indicating that the SplitPane should be laid out vertically with the first (fixed-size) pane in the bottom position.

See Also:

Constant Field Values

ORIENTATION_HORIZONTAL

public static final int ORIENTATION_HORIZONTAL

Shorthand for ORIENTATION_HORIZONTAL_LEADING_TRAILING.

See Also:

Constant Field Values

ORIENTATION_VERTICAL

public static final int ORIENTATION_VERTICAL

Shorthand for ORIENTATION_VERTICAL_TOP_BOTTOM.

See Also:

Constant Field Values

PROPERTY_AUTO_POSITIONED

public static final java.lang.String PROPERTY_AUTO_POSITIONED

See Also:

Constant Field Values

PROPERTY_ORIENTATION

public static final java.lang.String PROPERTY_ORIENTATION

See Also:

Constant Field Values

PROPERTY_RESIZABLE

public static final java.lang.String PROPERTY_RESIZABLE

See Also:

Constant Field Values

PROPERTY_SEPARATOR_COLOR

public static final java.lang.String PROPERTY_SEPARATOR_COLOR

See Also:

Constant Field Values

PROPERTY_SEPARATOR_HEIGHT

public static final java.lang.String PROPERTY_SEPARATOR_HEIGHT

See Also:

Constant Field Values

PROPERTY_SEPARATOR_HORIZONTAL_IMAGE

public static final java.lang.String PROPERTY_SEPARATOR_HORIZONTAL_IMAGE

See Also:

Constant Field Values

PROPERTY_SEPARATOR_HORIZONTAL_ROLLOVER_IMAGE

public static final java.lang.String PROPERTY_SEPARATOR_HORIZONTAL_ROLLOVER_IMAGE

See Also:

Constant Field Values

PROPERTY_SEPARATOR_POSITION

public static final java.lang.String PROPERTY_SEPARATOR_POSITION

See Also:

Constant Field Values

PROPERTY_SEPARATOR_ROLLOVER_COLOR

public static final java.lang.String PROPERTY_SEPARATOR_ROLLOVER_COLOR

See Also:

Constant Field Values

PROPERTY_SEPARATOR_WIDTH

public static final java.lang.String PROPERTY_SEPARATOR_WIDTH

See Also:

Constant Field Values

PROPERTY_SEPARATOR_VERTICAL_IMAGE

public static final java.lang.String PROPERTY_SEPARATOR_VERTICAL_IMAGE

See Also:

Constant Field Values

PROPERTY_SEPARATOR_VERTICAL_ROLLOVER_IMAGE

public static final java.lang.String PROPERTY_SEPARATOR_VERTICAL_ROLLOVER_IMAGE

See Also:

Constant Field Values

PROPERTY_SEPARATOR_VISIBLE

public static final java.lang.String PROPERTY_SEPARATOR_VISIBLE

See Also:

Constant Field Values

Constructor Detail

SplitPane

public SplitPane()

Creates a new SplitPane with default (horizontal) orientation.

SplitPane

public SplitPane(int orientation)

Creates a new SplitPane with the specified orientation.

Parameters:

orientation - a constant representing the orientation, one of the following values:

• ORIENTATION_HORIZONTAL
• ORIENTATION_VERTICAL
• ORIENTATION_HORIZONTAL_LEADING_TRAILING
• ORIENTATION_HORIZONTAL_TRAILING_LEADING
• ORIENTATION_HORIZONTAL_LEFT_RIGHT
• ORIENTATION_HORIZONTAL_RIGHT_LEFT
• ORIENTATION_VERTICAL_TOP_BOTTOM
• ORIENTATION_VERTICAL_BOTTOM_TOP

SplitPane

public SplitPane(int orientation,
                 boolean autoPositioned)

Creates a new SplitPane with the specified orientation and auto-positioned state.

Parameters:

orientation - a constant representing the orientation, one of the following values:

• ORIENTATION_HORIZONTAL
• ORIENTATION_VERTICAL
• ORIENTATION_HORIZONTAL_LEADING_TRAILING
• ORIENTATION_HORIZONTAL_TRAILING_LEADING
• ORIENTATION_HORIZONTAL_LEFT_RIGHT
• ORIENTATION_HORIZONTAL_RIGHT_LEFT
• ORIENTATION_VERTICAL_TOP_BOTTOM
• ORIENTATION_VERTICAL_BOTTOM_TOP

autoPositioned - flag indicating whether the separator position should be automatically positioned

SplitPane

public SplitPane(int orientation,
                 Extent separatorPosition)

Creates a new SplitPane with the specified orientation and separator position.

Parameters:

orientation - a constant representing the orientation, one of the following values:

• ORIENTATION_HORIZONTAL
• ORIENTATION_VERTICAL
• ORIENTATION_HORIZONTAL_LEADING_TRAILING
• ORIENTATION_HORIZONTAL_TRAILING_LEADING
• ORIENTATION_HORIZONTAL_LEFT_RIGHT
• ORIENTATION_HORIZONTAL_RIGHT_LEFT
• ORIENTATION_VERTICAL_TOP_BOTTOM
• ORIENTATION_VERTICAL_BOTTOM_TOP

separatorPosition - the initial position of the separator.

Method Detail

getOrientation

public int getOrientation()

Returns the orientation of the SplitPane.

Returns:

a constant representing the orientation, one of the following values:

• ORIENTATION_HORIZONTAL
• ORIENTATION_VERTICAL
• ORIENTATION_HORIZONTAL_LEADING_TRAILING
• ORIENTATION_HORIZONTAL_TRAILING_LEADING
• ORIENTATION_HORIZONTAL_LEFT_RIGHT
• ORIENTATION_HORIZONTAL_RIGHT_LEFT
• ORIENTATION_VERTICAL_TOP_BOTTOM
• ORIENTATION_VERTICAL_BOTTOM_TOP

getSeparatorColor

public Color getSeparatorColor()

Returns the color of the pane separator.

Returns:

the color

getSeparatorHeight

public Extent getSeparatorHeight()

Returns the height of the pane separator. This value is relevant only when the SplitPane has a vertical orientation.

Returns:

the separator width

getSeparatorHorizontalImage

public FillImage getSeparatorHorizontalImage()

Returns the fill image of the pane separator that is displayed when the SplitPane has a horizontal orientation.

Returns:

the image

getSeparatorHorizontalRolloverImage

public FillImage getSeparatorHorizontalRolloverImage()

Returns the rollover fill image of the pane separator that is displayed when the SplitPane has a horizontal orientation.

Returns:

the image

getSeparatorPosition

public Extent getSeparatorPosition()

Returns the position of the pane separator.

Returns:

the separator position

getSeparatorRolloverColor

public Color getSeparatorRolloverColor()

Returns the color of the pane separator.

Returns:

the color

getSeparatorVerticalImage

public FillImage getSeparatorVerticalImage()

Returns the fill image of the pane separator that is displayed when the SplitPane has a vertical orientation.

Returns:

the image

getSeparatorVerticalRolloverImage

public FillImage getSeparatorVerticalRolloverImage()

Returns the rollover fill image of the pane separator that is displayed when the SplitPane has a vertical orientation.

Returns:

the image

getSeparatorWidth

public Extent getSeparatorWidth()

Returns the width of the pane separator. This value is relevant only when the SplitPane has a horizontal orientation.

Returns:

the separator width

isAutoPositioned

public boolean isAutoPositioned()

Determines if the SplitPane is auto-positioned. Auto positioning indicates that the separator position should be set automatically based on the size of the first child. This feature is only available on vertically oriented panes, where the first child contains non-pane content.

Returns:

true if the SplitPane is auto-positioned

isResizable

public boolean isResizable()

Determines if the SplitPane is resizable.

Returns:

true if the SplitPane is resizable

isSeparatorVisible

public boolean isSeparatorVisible(boolean newValue)

Determines if the separator should be rendered visible. The separator will always be displayed if a SplitPane is resizable, regardless of the value of this property. This property has a default value of true.

Returns:

true if the SplitPane should provide a visible separator.

isValidChild

public boolean isValidChild(Component component)

No more than two children may be added.

Overrides:

isValidChild in class Component

Parameters:

component - the Component to evaluate as a child

Returns:

true if the Component is a valid child

See Also:

Component.isValidChild(nextapp.echo.app.Component)

isValidParent

public boolean isValidParent(Component parent)

Description copied from class: Component

Determines if this Component is valid to be added as a child of the given parent Component. Default implementation always returns true, may be overridden to provide specific behavior.

Overrides:

isValidParent in class Component

Parameters:

parent - the Component to evaluate as a parent

Returns:

true if the Component is a valid parent

See Also:

Component.isValidParent(nextapp.echo.app.Component)

processInput

public void processInput(java.lang.String inputName,
                         java.lang.Object inputValue)

Description copied from class: Component

Processes client input specific to the Component received from the UpdateManager. Derivative implementations should take care to invoke super.processInput(). Security note: Because input to this method is likely from a remote client, it should be treated as potentially hostile. All input to this method should be carefully verified. For example, directly invoking set() method with the provided input would constitute a security hole.

Overrides:

processInput in class Component

Parameters:

inputName - the name of the input

inputValue - the value of the input

See Also:

Component.processInput(java.lang.String, java.lang.Object)

setAutoPositioned

public void setAutoPositioned(boolean newValue)

Sets whether the SplitPane is auto-positioned. Auto positioning indicates that the separator position should be set automatically based on the size of the first child. This feature is only available on vertically oriented panes, where the first child contains non-pane content.

Parameters:

newValue - true if the SplitPane separator should be automatically positioned.

setOrientation

public void setOrientation(int newValue)

Sets the orientation of the SplitPane.

Parameters:

newValue - a constant representing the orientation, one of the following values:

• ORIENTATION_HORIZONTAL
• ORIENTATION_VERTICAL
• ORIENTATION_HORIZONTAL_LEADING_TRAILING
• ORIENTATION_HORIZONTAL_TRAILING_LEADING
• ORIENTATION_HORIZONTAL_LEFT_RIGHT
• ORIENTATION_HORIZONTAL_RIGHT_LEFT
• ORIENTATION_VERTICAL_TOP_BOTTOM
• ORIENTATION_VERTICAL_BOTTOM_TOP

setResizable

public void setResizable(boolean newValue)

Sets whether the SplitPane is resizable.

Parameters:

newValue - true if the SplitPane should allow the resizing of panes by dragging the separator, false if it should not

setSeparatorVisible

public void setSeparatorVisible(boolean newValue)

Sets whether the separator is visible. The separator will always be displayed if a SplitPane is resizable, regardless of the value of this property. This property has a default value of true.

Parameters:

newValue - true if the SplitPane should provide a visible separator.

setSeparatorColor

public void setSeparatorColor(Color newValue)

Sets the color of the pane separator.

Parameters:

newValue - the new color

setSeparatorHeight

public void setSeparatorHeight(Extent newValue)

Sets the height of the pane separator. This value is only relevant when the SplitPane has a vertical orientation. This property may not be specified in percent units.

Parameters:

newValue - the new height

setSeparatorHorizontalImage

public void setSeparatorHorizontalImage(FillImage newValue)

Sets the fill image of the pane separator that is displayed when the SplitPane has a horizontal orientation.

Parameters:

newValue - the new image

setSeparatorHorizontalRolloverImage

public void setSeparatorHorizontalRolloverImage(FillImage newValue)

Sets the rollover fill image of the pane separator that is displayed when the SplitPane has a horizontal orientation.

Parameters:

newValue - the new image

setSeparatorPosition

public void setSeparatorPosition(Extent newValue)

Sets the position of the pane separator.

Parameters:

newValue - the new position

setSeparatorRolloverColor

public void setSeparatorRolloverColor(Color newValue)

Sets the rollover color of the pane separator.

Parameters:

newValue - the new color

setSeparatorVerticalImage

public void setSeparatorVerticalImage(FillImage newValue)

Sets the fill image of the pane separator that is displayed when the SplitPane has a vertical orientation.

Parameters:

newValue - the new image

setSeparatorRolloverVerticalImage

public void setSeparatorRolloverVerticalImage(FillImage newValue)

Sets the rollover fill image of the pane separator that is displayed when the SplitPane has a vertical orientation.

Parameters:

newValue - the new image

setSeparatorWidth

public void setSeparatorWidth(Extent newValue)

Sets the width of the pane separator. This value is only relevant when the SplitPane has a horizontal orientation. This property may not be specified in percent units.

Parameters:

newValue - the new width