|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--javax.swing.JSplitPane
JSplitPane is used to divide two (and only two) Components. The two Components are graphically divided based on the look and feel implementation, and the two Components can then be interactively resized by the user.
The two Components can be aligned left to right using
JSplitPane.HORIZONTAL_SPLIT
, or top to bottom using
JSplitPane.VERTICAL_SPLIT
.
The preferred way to change the size of the Components is to invoke
setDividerLocation
where location
is either
the new x or y position, depending on the orientation of the
JSplitPane. If one component changes, JSplitPane also attempts to
reposition the other component.
To resize the Components to their preferred sizes invoke
resetToPreferredSizes
.
When the user is resizing the Components the minimum size of the
Components is used to determine the maximum/minimum position the
Components can be set to. So that if the minimum size of the two
components is greater than the size of the splitpane the divider
will not allow you to resize it. To alter the minimum size of a
JComponent, see JComponent.setMinimumSize(java.awt.Dimension)
.
For the keyboard keys used by this component in the standard Look and Feel (L&F) renditions, see the JSplitPane key assignments.
Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. A future release of Swing will provide support for long term persistence.
Inner Class Summary | |
protected class |
JSplitPane.AccessibleJSplitPane
The class used to obtain the accessible role for this object. |
Inner classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
Field Summary | |
static String |
BOTTOM
Used to add a Component below the other Component. |
static String |
CONTINUOUS_LAYOUT_PROPERTY
Bound property name for continuousLayout. |
protected boolean |
continuousLayout
Whether or not the views are continuously redisplayed while resizing. |
static String |
DIVIDER
Used to add a Component that will represent the divider. |
static String |
DIVIDER_SIZE_PROPERTY
Bound property name for border. |
protected int |
dividerSize
Size of the divider. |
static int |
HORIZONTAL_SPLIT
Horizontal split indicates the Components are split along the x axis, eg the two Components will be split one to the left of the other. |
static String |
LAST_DIVIDER_LOCATION_PROPERTY
Bound property for lastLocation. |
protected int |
lastDividerLocation
Previous location of the split pane. |
static String |
LEFT
Used to add a Component to the left of the other Component. |
protected Component |
leftComponent
The left or top component. |
static String |
ONE_TOUCH_EXPANDABLE_PROPERTY
Bound property for oneTouchExpandable. |
protected boolean |
oneTouchExpandable
Is a little widget provided to quickly expand/collapse the split pane? |
protected int |
orientation
How the views are split. |
static String |
ORIENTATION_PROPERTY
Bound property name for orientation (horizontal or vertical). |
static String |
RIGHT
Used to add a Component to the right of the other Component. |
protected Component |
rightComponent
The right or bottom component. |
static String |
TOP
Used to add a Component above the other Component. |
static int |
VERTICAL_SPLIT
Vertical split indicates the Components are split along the y axis, eg the two Components will be split one on top of the other. |
Fields inherited from class javax.swing.JComponent |
accessibleContext,
listenerList,
TOOL_TIP_TEXT_KEY,
ui,
UNDEFINED_CONDITION,
WHEN_ANCESTOR_OF_FOCUSED_COMPONENT,
WHEN_FOCUSED,
WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
BOTTOM_ALIGNMENT,
CENTER_ALIGNMENT,
LEFT_ALIGNMENT,
RIGHT_ALIGNMENT,
TOP_ALIGNMENT |
Constructor Summary | |
JSplitPane()
Returns a new JSplitPane configured to arrange the child components side-by-side horizontally with no continuous layout, using two buttons for the compoents. |
|
JSplitPane(int newOrientation)
Returns a new JSplitPane configured with the specified orientation and no continuous layout. |
|
JSplitPane(int newOrientation,
boolean newContinuousLayout)
Returns a new JSplitPane with the specified orientation and redrawing style. |
|
JSplitPane(int newOrientation,
boolean newContinuousLayout,
Component newLeftComponent,
Component newRightComponent)
Returns a new JSplitPane with the specified orientation and redrawing style, and with the specified components. |
|
JSplitPane(int newOrientation,
Component newLeftComponent,
Component newRightComponent)
Returns a new JSplitPane with the specified orientation and with the specifiied components that does not do continuous redrawing. |
Method Summary | |
protected void |
addImpl(Component comp,
Object constraints,
int index)
If constraints identifies the left/top or
right/bottom child component, and a component with that identifier
was previously added, it will be removed and then comp
will be added in its place. |
AccessibleContext |
getAccessibleContext()
Get the AccessibleContext associated with this JComponent |
Component |
getBottomComponent()
Returns the component below, or to the right of the divider. |
int |
getDividerLocation()
Returns the location of the divider from the look and feel implementation. |
int |
getDividerSize()
Returns the size of the divider. |
int |
getLastDividerLocation()
Returns the last location the divider was at. |
Component |
getLeftComponent()
Returns the component to the left (or above) the divider. |
int |
getMaximumDividerLocation()
Returns the maximum location of the divider from the look and feel implementation. |
int |
getMinimumDividerLocation()
Returns the minimum location of the divider from the look and feel implementation. |
int |
getOrientation()
Returns the orientation. |
Component |
getRightComponent()
Returns the component to the right (or below) the divider. |
Component |
getTopComponent()
Returns the component above, or to the left of the divider. |
SplitPaneUI |
getUI()
Returns the SplitPaneUI that is providing the current look and feel. |
String |
getUIClassID()
Returns the name of the L&F class that renders this component. |
boolean |
isContinuousLayout()
Returns true if the child comopnents are continuously redisplayed and layed out during user intervention. |
boolean |
isOneTouchExpandable()
Returns true if the pane provides a UI widget to collapse/expand the divider. |
boolean |
isValidateRoot()
Calls to revalidate() on any descendant of this JSplitPane, will cause a request to be queued that will validate the JSplitPane and all its descendants. |
protected void |
paintChildren(Graphics g)
Subclassed to message the UI with finishedPaintingChildren after super has been messaged, as well as painting the border. |
protected String |
paramString()
Returns a string representation of this JSplitPane. |
void |
remove(Component component)
Removes the child component, component from the
pane. |
void |
remove(int index)
Removes the Component at the specified index. |
void |
removeAll()
Removes all the child components from the receiver. |
void |
resetToPreferredSizes()
Messaged to relayout the JSplitPane based on the preferred size of the children components. |
void |
setBottomComponent(Component comp)
Sets the component below, or to the right of the divider. |
void |
setContinuousLayout(boolean newContinuousLayout)
Sets whether or not the child components are continuously redisplayed and layed out during user intervention. |
void |
setDividerLocation(double proportionalLocation)
Sets the divider location as a percentage of the JSplitPane's size. |
void |
setDividerLocation(int location)
Sets the location of the divider. |
void |
setDividerSize(int newSize)
Sets the size of the divider. |
void |
setLastDividerLocation(int newLastLocation)
Sets the last location the divider was at to newLastLocation . |
void |
setLeftComponent(Component comp)
Sets the component to the left (or above) the divider. |
void |
setOneTouchExpandable(boolean newValue)
Determines whether the JSplitPane provides a UI widget on the divider to quickly expand/collapse the divider. |
void |
setOrientation(int orientation)
Sets the orientation, or how the splitter is divided. |
void |
setRightComponent(Component comp)
Sets the component to the right (or below) the divider. |
void |
setTopComponent(Component comp)
Sets the component above, or to the left of the divider. |
void |
setUI(SplitPaneUI ui)
Sets the L&F object that renders this component. |
void |
updateUI()
Notification from the UIManager that the L&F has changed. |
Methods inherited from class java.awt.Container |
add,
add,
add,
add,
add,
addContainerListener,
countComponents,
deliverEvent,
doLayout,
findComponentAt,
findComponentAt,
getComponent,
getComponentAt,
getComponentAt,
getComponentCount,
getComponents,
getLayout,
insets,
invalidate,
isAncestorOf,
layout,
list,
list,
locate,
minimumSize,
paintComponents,
preferredSize,
print,
printComponents,
processContainerEvent,
processEvent,
removeContainerListener,
setCursor,
setLayout,
validate,
validateTree |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final int VERTICAL_SPLIT
public static final int HORIZONTAL_SPLIT
public static final String LEFT
public static final String RIGHT
public static final String TOP
public static final String BOTTOM
public static final String DIVIDER
public static final String ORIENTATION_PROPERTY
public static final String CONTINUOUS_LAYOUT_PROPERTY
public static final String DIVIDER_SIZE_PROPERTY
public static final String ONE_TOUCH_EXPANDABLE_PROPERTY
public static final String LAST_DIVIDER_LOCATION_PROPERTY
protected int orientation
protected boolean continuousLayout
protected Component leftComponent
protected Component rightComponent
protected int dividerSize
protected boolean oneTouchExpandable
protected int lastDividerLocation
Constructor Detail |
public JSplitPane()
public JSplitPane(int newOrientation)
newOrientation
- an int specifying the horizontal or vertical
orientationpublic JSplitPane(int newOrientation, boolean newContinuousLayout)
newOrientation
- an int specifying the horizontal or vertical
orientationnewContinuousLayout
- a boolean, true for the components to
redraw continuously as the divider changes position, false
to wait until the divider position stops changing to redrawpublic JSplitPane(int newOrientation, Component newLeftComponent, Component newRightComponent)
newOrientation
- an int specifying the horizontal or vertical
orientationnewContinuousLayout
- a boolean, true for the components to
redraw continuously as the divider changes position, false
to wait until the divider position stops changing to redrawnewLeftComponent
- the Component that will appear on the left
of a horizontally-split pane, or at the top of a
vertically-split pane.public JSplitPane(int newOrientation, boolean newContinuousLayout, Component newLeftComponent, Component newRightComponent)
newOrientation
- an int specifying the horizontal or vertical
orientationnewContinuousLayout
- a boolean, true for the components to
redraw continuously as the divider changes position, false
to wait until the divider position stops changing to redrawnewLeftComponent
- the Component that will appear on the left
of a horizontally-split pane, or at the top of a
vertically-split pane.Method Detail |
public void setUI(SplitPaneUI ui)
ui
- the SplitPaneUI L&F objectUIDefaults.getUI(javax.swing.JComponent)
public SplitPaneUI getUI()
public void updateUI()
JComponent.updateUI()
public String getUIClassID()
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
public void setDividerSize(int newSize)
newSize
- an int giving the size of the divider in pixelspublic int getDividerSize()
public void setLeftComponent(Component comp)
comp
- the Component to display in that positionpublic Component getLeftComponent()
public void setTopComponent(Component comp)
comp
- the Component to display in that positionpublic Component getTopComponent()
public void setRightComponent(Component comp)
comp
- the Component to display in that positionpublic Component getRightComponent()
public void setBottomComponent(Component comp)
comp
- the Component to display in that positionpublic Component getBottomComponent()
public void setOneTouchExpandable(boolean newValue)
newValue
- a boolean, where true means to provide a
collapse/expand widgetpublic boolean isOneTouchExpandable()
public void setLastDividerLocation(int newLastLocation)
newLastLocation
.newLastLocation
- an int specifying the last divider location
in pixels, from the left (or upper) edge of the pane to the
left (or upper) edge of the dividerpublic int getLastDividerLocation()
public void setOrientation(int orientation)
orientation
- an int specifying the orientationpublic int getOrientation()
setOrientation(int)
public void setContinuousLayout(boolean newContinuousLayout)
newContinuousLayout
- a boolean, true if the components
are continuously redrawn as the divider changes positionpublic boolean isContinuousLayout()
public void resetToPreferredSizes()
public void setDividerLocation(double proportionalLocation)
proportionalLocation
- a double-precision floating point value
that specifies a percentage, from zero (top/left) to 1.0
(bottom/right)public void setDividerLocation(int location)
location
- an int specifying a UI-specific value (typically a
pixel count)public int getDividerLocation()
public int getMinimumDividerLocation()
public int getMaximumDividerLocation()
public void remove(Component component)
component
from the
pane. Resets the leftComponent or rightComponent instance
variable, as necessary.component
- the Component to removepublic void remove(int index)
index
- an int specifying the component to remove, where
1 specifies the left/top component and 2 specifies the
bottom/right componentpublic void removeAll()
public boolean isValidateRoot()
JComponent.revalidate()
protected void addImpl(Component comp, Object constraints, int index)
constraints
identifies the left/top or
right/bottom child component, and a component with that identifier
was previously added, it will be removed and then comp
will be added in its place. If constraints
is not
one of the known identifers the layout manager may throw an
IllegalArgumentException.
The possible constraints objects (Strings) are:
comp
- the component to addconstraints
- an Object specifying the layout constraints
(position) for this componentindex
- an int specifying the index in the container's
list.Container.addImpl(Component, Object, int)
protected void paintChildren(Graphics g)
g
- the Graphics context within which to paintprotected String paramString()
null
.public AccessibleContext getAccessibleContext()
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |