|
NextApp Echo2 v2.1.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object nextapp.echo2.app.Component nextapp.echo2.app.SplitPane
public class SplitPane
A container which displays two components horizontally or vertically adjacent to one another.
Child LayoutData: Children of this component may provide
layout information using the
nextapp.echo2.app.layout.SplitPaneLayoutData
layout data object.
SplitPaneLayoutData
,
Serialized FormField 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_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_POSITION
|
static java.lang.String |
PROPERTY_SEPARATOR_VERTICAL_IMAGE
|
static java.lang.String |
PROPERTY_SEPARATOR_WIDTH
|
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,
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. |
Extent |
getSeparatorPosition()
Returns the position of the pane separator. |
FillImage |
getSeparatorVerticalImage()
Returns the 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 |
isResizable()
Determines if the SplitPane is resizable. |
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 |
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 |
setSeparatorPosition(Extent newValue)
Sets the position of the pane separator. |
void |
setSeparatorVerticalImage(FillImage newValue)
Sets the fill image of the pane separator that is displayed when the SplitPane has a vertical orientation. |
void |
setSeparatorWidth(Extent newValue)
Sets the width of the pane separator. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ORIENTATION_HORIZONTAL_LEADING_TRAILING
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.
public static final int ORIENTATION_HORIZONTAL_TRAILING_LEADING
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.
public static final int ORIENTATION_HORIZONTAL_LEFT_RIGHT
orientation
constant indicating that the
SplitPane
should be laid out horizontally with the
first (fixed-size) pane in the left position.
public static final int ORIENTATION_HORIZONTAL_RIGHT_LEFT
orientation
constant indicating that the
SplitPane
should be laid out horizontally with the
first (fixed-size) pane in the right position.
public static final int ORIENTATION_VERTICAL_TOP_BOTTOM
orientation
constant indicating that the
SplitPane
should be laid out vertically with the
first (fixed-size) pane in the top position.
public static final int ORIENTATION_VERTICAL_BOTTOM_TOP
orientation
constant indicating that the
SplitPane
should be laid out vertically with the
first (fixed-size) pane in the bottom position.
public static final int ORIENTATION_HORIZONTAL
ORIENTATION_HORIZONTAL_LEADING_TRAILING
.
public static final int ORIENTATION_VERTICAL
ORIENTATION_VERTICAL_TOP_BOTTOM
.
public static final java.lang.String PROPERTY_ORIENTATION
public static final java.lang.String PROPERTY_RESIZABLE
public static final java.lang.String PROPERTY_SEPARATOR_COLOR
public static final java.lang.String PROPERTY_SEPARATOR_HEIGHT
public static final java.lang.String PROPERTY_SEPARATOR_HORIZONTAL_IMAGE
public static final java.lang.String PROPERTY_SEPARATOR_POSITION
public static final java.lang.String PROPERTY_SEPARATOR_WIDTH
public static final java.lang.String PROPERTY_SEPARATOR_VERTICAL_IMAGE
Constructor Detail |
---|
public SplitPane()
SplitPane
with default (horizontal)
orientation.
public SplitPane(int orientation)
SplitPane
with the specified orientation.
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
public SplitPane(int orientation, Extent separatorPosition)
SplitPane
with the specified orientation and
separator position.
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
(in pixel units)Method Detail |
---|
public int getOrientation()
SplitPane
.
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
public Color getSeparatorColor()
public Extent getSeparatorHeight()
SplitPane
has a vertical orientation.
This property only supports Extent
s with
pixel units.
public FillImage getSeparatorHorizontalImage()
SplitPane
has a horizontal orientation.
public Extent getSeparatorPosition()
Extent
s with
pixel units.
public FillImage getSeparatorVerticalImage()
SplitPane
has a vertical orientation.
public Extent getSeparatorWidth()
SplitPane
has a horizontal orientation.
This property only supports Extent
s with
pixel units.
public boolean isResizable()
SplitPane
is resizable.
SplitPane
is resizablepublic boolean isValidChild(Component component)
isValidChild
in class Component
component
- the Component
to evaluate as a child
Component
is a valid childComponent.isValidChild(nextapp.echo2.app.Component)
public boolean isValidParent(Component parent)
Component
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.
isValidParent
in class Component
parent
- the Component
to evaluate as a parent
Component
is a valid parentComponent.isValidParent(nextapp.echo2.app.Component)
public void processInput(java.lang.String inputName, java.lang.Object inputValue)
Component
Component
received from the UpdateManager
.
Derivative implementations should take care to invoke
super.processInput()
.
processInput
in class Component
inputName
- the name of the inputinputValue
- the value of the inputComponent.processInput(java.lang.String, java.lang.Object)
public void setOrientation(int newValue)
SplitPane
.
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
public void setResizable(boolean newValue)
SplitPane
is resizable.
newValue
- true if the SplitPane
should allow the
resizing of panes by dragging the separator, false if it should
notpublic void setSeparatorColor(Color newValue)
newValue
- the new colorpublic void setSeparatorHeight(Extent newValue)
SplitPane
has a vertical orientation.
This property only supports Extent
s with
pixel units.
newValue
- the new heightpublic void setSeparatorHorizontalImage(FillImage newValue)
SplitPane
has a horizontal orientation.
newValue
- the new imagepublic void setSeparatorPosition(Extent newValue)
Extent
s with
pixel units.
newValue
- the new positionpublic void setSeparatorVerticalImage(FillImage newValue)
SplitPane
has a vertical orientation.
newValue
- the new imagepublic void setSeparatorWidth(Extent newValue)
SplitPane
has a horizontal orientation.
This property only supports Extent
s with
pixel units.
newValue
- the new width
|
NextApp Echo2 v2.1.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |