All Packages Class Hierarchy This Package Previous Next Index
Class com.sun.java.swing.JSplitPane
java.lang.Object
|
+----java.awt.Component
|
+----java.awt.Container
|
+----com.sun.java.swing.JComponent
|
+----com.sun.java.swing.JSplitPane
- public class JSplitPane
- extends JComponent
JSplitPane is used to divide two (and only two) Components. The two
Components are graphicaly divided based on the look and feel
implementation. By user intervention the two Components can be
interactively resized.
The two Components can be aligned left to right,
JSplitPane.HORIZONTAL_SPLIT, or top to bottom, JSplitPane.VERTICAL_SPLIT.
The preferred way to change the size of the Componets is to message
setDividerLocation where location is either the new x or y position
depending on the orientation of the JSplitPane. JSplitPane will also
try and reposition the other Component if one changes.
To resize the Components to their preferred sizes message
resetPreferredSizes.
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.
-
border
- Border.
-
BORDER_PROPERTY
- Bound property name for border.
-
BOTTOM
- Used to add a Component below the other Component.
-
CONTINUOUS_LAYOUT_PROPERTY
- Bound property name for continuousLayout.
-
continuousLayout
- Whether or not the views are continuously redisplayed while
resizing.
-
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.
-
LEFT
- Used to add a Component to go on the left side of the other
Component.
-
leftComponent
- The left or top component.
-
orientation
- How the views are split.
-
ORIENTATION_PROPERTY
- Bound property name for orientation.
-
RIGHT
- Used to add a Component to go on the right side of the other
Component.
-
rightComponent
-
-
TOP
- Used to add a Component above the other Component.
-
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.
-
JSplitPane()
- Returns a new JSplitPane configured with to vertically divide
the child components.
-
JSplitPane(int)
- Returns a new JSplitPane configured with the passed in orientation
and no continuous layout.
-
JSplitPane(int, boolean)
- Returns a new JSplitPane with the specified orientation and
continuousLayout.
-
JSplitPane(int, boolean, Component, Component)
- Returns a new JSplitPane with the specified orientation,
continuousLayout and passed in Components.
-
JSplitPane(int, Component, Component)
- Returns a new JSplitPane with the specified orientation,
continuousLayout and passed in Components.
-
addImpl(Component, Object, int)
- Will throw a TooManySplitPaneChildren exception if more than
2 children already exist.
-
getBorder()
- Returns the Border used.
-
getBottomComponent()
- Returns the component below, or to the right of the divider.
-
getDividerLocation()
- Returns the location of the divider from the look and feel
implementation.
-
getLeftComponent()
- Returns the component to the left (or above) the divider.
-
getOrientation()
- Returns the orientation.
-
getRightComponent()
- Returns the component to the right (or below) the divider.
-
getTopComponent()
- Returns the component above, or to the left of the divider.
-
getUI()
- Returns the TreeUI that is providing the current look and
feel.
-
isContinuousLayout()
- Returns true if the child comopnents are continuously redisplayed and
layed out during user intervention.
-
paint(Graphics)
- Subclassed to message the UI with finishedPaintingChildren after
super has been messaged, as well as painting the border.
-
remove(int)
- Removes the Component at the passed in index.
-
resetToPreferredSizes()
- Messaged to relayout the JSplitPane based on the preferred size
of the children components.
-
setBorder(Border)
- Sets the border to newBorder.
-
setBottomComponent(Component)
- Sets the component below, or to the right of the divider.
-
setContinuousLayout(boolean)
- Sets whether or not the child components are continuously
redisplayed and layed out during user intervention.
-
setDividerLocation(int)
- Sets the location of the divider.
-
setLeftComponent(Component)
- Sets the component to the left (or above) the divider.
-
setOrientation(int)
- Sets the orientation, or how the splitter is divided.
-
setRightComponent(Component)
- Sets the component to the right (or below) the divider.
-
setTopComponent(Component)
- Sets the component above, or to the left of the divider.
-
setUI(SplitPaneUI)
- Sets the TreeUI that will provide the current look and feel.
-
updateUI()
- Called to replace the UI with the latest version from the
default UIFactory.
VERTICAL_SPLIT
public 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.
HORIZONTAL_SPLIT
public 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.
LEFT
public static String LEFT
- Used to add a Component to go on the left side of the other
Component.
RIGHT
public static String RIGHT
- Used to add a Component to go on the right side of the other
Component.
TOP
public static String TOP
- Used to add a Component above the other Component.
BOTTOM
public static String BOTTOM
- Used to add a Component below the other Component.
ORIENTATION_PROPERTY
public static final String ORIENTATION_PROPERTY
- Bound property name for orientation.
CONTINUOUS_LAYOUT_PROPERTY
public static final String CONTINUOUS_LAYOUT_PROPERTY
- Bound property name for continuousLayout.
BORDER_PROPERTY
public static final String BORDER_PROPERTY
- Bound property name for border.
orientation
protected int orientation
- How the views are split.
continuousLayout
protected boolean continuousLayout
- Whether or not the views are continuously redisplayed while
resizing.
leftComponent
protected Component leftComponent
- The left or top component.
rightComponent
protected Component rightComponent
border
protected Border border
- Border.
JSplitPane
public JSplitPane()
- Returns a new JSplitPane configured with to vertically divide
the child components.
JSplitPane
public JSplitPane(int newOrientation)
- Returns a new JSplitPane configured with the passed in orientation
and no continuous layout.
JSplitPane
public JSplitPane(int newOrientation,
boolean newContinuousLayout)
- Returns a new JSplitPane with the specified orientation and
continuousLayout.
JSplitPane
public JSplitPane(int newOrientation,
Component newLeftComponent,
Component newRightComponent)
- Returns a new JSplitPane with the specified orientation,
continuousLayout and passed in Components.
JSplitPane
public JSplitPane(int newOrientation,
boolean newContinuousLayout,
Component newLeftComponent,
Component newRightComponent)
- Returns a new JSplitPane with the specified orientation,
continuousLayout and passed in Components.
setUI
public void setUI(SplitPaneUI ui)
- Sets the TreeUI that will provide the current look and feel.
getUI
public SplitPaneUI getUI()
- Returns the TreeUI that is providing the current look and
feel.
updateUI
public void updateUI()
- Called to replace the UI with the latest version from the
default UIFactory.
- Overrides:
- updateUI in class JComponent
setLeftComponent
public void setLeftComponent(Component comp)
- Sets the component to the left (or above) the divider.
getLeftComponent
public Component getLeftComponent()
- Returns the component to the left (or above) the divider.
setTopComponent
public void setTopComponent(Component comp)
- Sets the component above, or to the left of the divider.
getTopComponent
public Component getTopComponent()
- Returns the component above, or to the left of the divider.
setRightComponent
public void setRightComponent(Component comp)
- Sets the component to the right (or below) the divider.
getRightComponent
public Component getRightComponent()
- Returns the component to the right (or below) the divider.
setBottomComponent
public void setBottomComponent(Component comp)
- Sets the component below, or to the right of the divider.
getBottomComponent
public Component getBottomComponent()
- Returns the component below, or to the right of the divider.
setOrientation
public void setOrientation(int orientation)
- Sets the orientation, or how the splitter is divided.
getOrientation
public int getOrientation()
- Returns the orientation.
setContinuousLayout
public void setContinuousLayout(boolean newContinuousLayout)
- Sets whether or not the child components are continuously
redisplayed and layed out during user intervention.
isContinuousLayout
public boolean isContinuousLayout()
- Returns true if the child comopnents are continuously redisplayed and
layed out during user intervention.
resetToPreferredSizes
public void resetToPreferredSizes()
- Messaged to relayout the JSplitPane based on the preferred size
of the children components.
setDividerLocation
public void setDividerLocation(int location)
- Sets the location of the divider. This is passed off to the
look and feel implementation.
getDividerLocation
public int getDividerLocation()
- Returns the location of the divider from the look and feel
implementation.
setBorder
public void setBorder(Border newBorder)
- Sets the border to newBorder.
getBorder
public Border getBorder()
- Returns the Border used.
remove
public void remove(int index)
- Removes the Component at the passed in index. This updates the
leftComponent and rightComponent ivars if necessary, and then
messages super.
- Overrides:
- remove in class Container
addImpl
protected void addImpl(Component comp,
Object constraints,
int index)
- Will throw a TooManySplitPaneChildren exception if more than
2 children already exist.
- Overrides:
- addImpl in class Container
paint
public void paint(Graphics g)
- Subclassed to message the UI with finishedPaintingChildren after
super has been messaged, as well as painting the border.
- Overrides:
- paint in class JComponent
All Packages Class Hierarchy This Package Previous Next Index