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

implements Accessible

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. 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. Refer to JComponent.setMinimumSize for a way to alter the minimum size of a JComponent.

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.

DIVIDER

Used to add a Component that will represent the divider.

DIVIDER_SIZE_PROPERTY

Bound property name for border.

dividerSize

Size of the divider.

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.

LAST_DIVIDER_LOCATION_PROPERTY

Bound property for lastLocation.

lastDividerLocation

Previous location of the split pane.

LEFT

Used to add a Component to go on the left side of the other Component.

leftComponent

The left or top component.

ONE_TOUCH_EXPANDABLE_PROPERTY

Bound property for oneTouchExpandable.

oneTouchExpandable

Is a little widget provided to quickly expand/collapse the split pane.

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 to vertically divide the child components and with two buttons.

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.

getAccessibleRole()

Get the role of this object.

getAccessibleValue()

Get the accessible value of this object.

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.

getDividerSize()

Returns the size of the divider.

getLastDividerLocation()

Returns the last location the divider was at.

getLeftComponent()

Returns the component to the left (or above) the divider.

getMaximumDividerLocation()

Returns the maximum location of the divider from the look and feel implementation.

getMinimumDividerLocation()

Returns the minimum location of the divider from the look and feel implementation.

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.

getUIClassID()

isContinuousLayout()

Returns true if the child comopnents are continuously redisplayed and layed out during user intervention.

isOneTouchExpandable()

Returns true if the receiver provides a UI widget to collapse/expand the divider.

paintChildren(Graphics)

Subclassed to message the UI with finishedPaintingChildren after super has been messaged, as well as painting the border.

remove(Component)

Removes the child component, component from the receiver.

remove(int)

Removes the Component at the passed in index.

removeAll()

Removes all the child components from the receiver.

resetToPreferredSizes()

Messaged to relayout the JSplitPane based on the preferred size of the children components.

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.

setDividerSize(int)

Sets the size of the divider to newSize.

setLastDividerLocation(int)

Sets the last location the divier was at to newLastLocation.

setLeftComponent(Component)

Sets the component to the left (or above) the divider.

setOneTouchExpandable(boolean)

If newValue is true, the reciever will provide UI widgets on the divider to quickly expand/collapse 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.

 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.

 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.

 public static String LEFT

Used to add a Component to go on the left side of the other Component.

 public static String RIGHT

Used to add a Component to go on the right side of the other Component.

 public static String TOP

Used to add a Component above the other Component.

 public static String BOTTOM

Used to add a Component below the other Component.

 public static String DIVIDER

Used to add a Component that will represent the divider.

 public static final String ORIENTATION_PROPERTY

Bound property name for orientation.

 public static final String CONTINUOUS_LAYOUT_PROPERTY

Bound property name for continuousLayout.

 public static final String DIVIDER_SIZE_PROPERTY

Bound property name for border.

 public static final String ONE_TOUCH_EXPANDABLE_PROPERTY

Bound property for oneTouchExpandable.

 public static final String LAST_DIVIDER_LOCATION_PROPERTY

Bound property for lastLocation.

 protected int orientation

How the views are split.

 protected boolean continuousLayout

Whether or not the views are continuously redisplayed while resizing.

 protected Component leftComponent

The left or top component.

 protected Component rightComponent

 protected int dividerSize

Size of the divider.

 protected boolean oneTouchExpandable

Is a little widget provided to quickly expand/collapse the split pane.

 protected int lastDividerLocation

Previous location of the split pane.

 public JSplitPane()

Returns a new JSplitPane configured to vertically divide the child components and with two buttons.

 public JSplitPane(int newOrientation)

Returns a new JSplitPane configured with the passed in orientation and no continuous layout.

 public JSplitPane(int newOrientation,
                   boolean newContinuousLayout)

Returns a new JSplitPane with the specified orientation and continuousLayout.

 public JSplitPane(int newOrientation,
                   Component newLeftComponent,
                   Component newRightComponent)

Returns a new JSplitPane with the specified orientation, continuousLayout and passed in Components.

 public JSplitPane(int newOrientation,
                   boolean newContinuousLayout,
                   Component newLeftComponent,
                   Component newRightComponent)

Returns a new JSplitPane with the specified orientation, continuousLayout and passed in Components.

 public void setUI(SplitPaneUI ui)

Sets the TreeUI that will provide the current look and feel.

 public SplitPaneUI getUI()

Returns the TreeUI that is providing the current look and feel.

 public void updateUI()

Called to replace the UI with the latest version from the default UIFactory.

Overrides:

updateUI in class JComponent

 public String getUIClassID()

Returns:

"SplitPaneUI"

Overrides:

getUIClassID in class JComponent

See Also:

getUIClassID, getUI

 public void setDividerSize(int newSize)

Sets the size of the divider to newSize.

 public int getDividerSize()

Returns the size of the divider.

 public void setLeftComponent(Component comp)

Sets the component to the left (or above) the divider.

 public Component getLeftComponent()

Returns the component to the left (or above) the divider.

 public void setTopComponent(Component comp)

Sets the component above, or to the left of the divider.

 public Component getTopComponent()

Returns the component above, or to the left of the divider.

 public void setRightComponent(Component comp)

Sets the component to the right (or below) the divider.

 public Component getRightComponent()

Returns the component to the right (or below) the divider.

 public void setBottomComponent(Component comp)

Sets the component below, or to the right of the divider.

 public Component getBottomComponent()

Returns the component below, or to the right of the divider.

 public void setOneTouchExpandable(boolean newValue)

If newValue is true, the reciever will provide UI widgets on the divider to quickly expand/collapse the divider.

 public boolean isOneTouchExpandable()

Returns true if the receiver provides a UI widget to collapse/expand the divider.

 public void setLastDividerLocation(int newLastLocation)

Sets the last location the divier was at to newLastLocation.

 public int getLastDividerLocation()

Returns the last location the divider was at.

 public void setOrientation(int orientation)

Sets the orientation, or how the splitter is divided.

 public int getOrientation()

Returns the orientation.

 public void setContinuousLayout(boolean newContinuousLayout)

Sets whether or not the child components are continuously redisplayed and layed out during user intervention.

 public boolean isContinuousLayout()

Returns true if the child comopnents are continuously redisplayed and layed out during user intervention.

 public void resetToPreferredSizes()

Messaged to relayout the JSplitPane based on the preferred size of the children components.

 public void setDividerLocation(int location)

Sets the location of the divider. This is passed off to the look and feel implementation.

 public int getDividerLocation()

Returns the location of the divider from the look and feel implementation.

 public int getMinimumDividerLocation()

Returns the minimum location of the divider from the look and feel implementation.

 public int getMaximumDividerLocation()

Returns the maximum location of the divider from the look and feel implementation.

 public void remove(Component component)

Removes the child component, component from the receiver. Reset the leftComponent or rightComponent instance variable if necessary.

Overrides:

remove in class Container

 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

 public void removeAll()

Removes all the child components from the receiver. Resets the leftComonent and rightComponent instance variables.

Overrides:

removeAll in class Container

 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

 protected void paintChildren(Graphics g)

Subclassed to message the UI with finishedPaintingChildren after super has been messaged, as well as painting the border.

Overrides:

paintChildren in class JComponent

 public String getAccessibleValue()

Get the accessible value of this object.

Returns:

a localized String describing the value of this object

Overrides:

getAccessibleValue in class JComponent

 public AccessibleRole getAccessibleRole()

Get the role of this object.

Returns:

an instance of AccessibleRole describing the role of the object

Overrides:

getAccessibleRole in class JComponent

See Also:

AccessibleRole

All Packages  Class Hierarchy  This Package  Previous  Next  Index