org.tigris.swidgets

Class BorderSplitPane


public class BorderSplitPane
extends JComponent

A component designed to display its child components in a similar fashion to a component implementing the standard java class BorderLayout but with each child component seperated by a positional splitterbar.

The compass points have been expanded from those available in BorderLayout to the diaganal compass points, NORTHWEST, NORTHEAST, SOUTHEAST, SOUTHWEST.

Author:
Bob Tarling

Field Summary

static String
CENTER
The center layout constraint (middle of container).
static String
EAST
The east layout constraint (right of container).
static String
NORTH
The north layout constraint (top of container).
static String
NORTHEAST
The northeast layout constraint (top right of container).
static String
NORTHWEST
The northwest layout constraint (top left of container).
static String
SOUTH
The south layout constraint (bottom of container).
static String
SOUTHEAST
The southeast layout constraint (bottom right of container).
static String
SOUTHWEST
The southwest layout constraint (bottom left of container).
static String
WEST
The west layout constraint (left of container).

Constructor Summary

BorderSplitPane()
Construct a new BorderSplitPane

Method Summary

Component
add(Component comp)
Add a new component to the center of the BorderSplitPane
void
add(Component comp, Object constraints)
Add a component at the specified compass point or center.
void
add(Component comp, Object constraints, int index)
This method is only implemented to satisfy the superclass declaration.
Component
add(Component comp, int index)
This method is only implemented to satisfy the superclass declaration.
void
remove(Component comp)

Field Details

CENTER

public static final String CENTER
The center layout constraint (middle of container).

EAST

public static final String EAST
The east layout constraint (right of container).

NORTH

public static final String NORTH
The north layout constraint (top of container).

NORTHEAST

public static final String NORTHEAST
The northeast layout constraint (top right of container).

NORTHWEST

public static final String NORTHWEST
The northwest layout constraint (top left of container).

SOUTH

public static final String SOUTH
The south layout constraint (bottom of container).

SOUTHEAST

public static final String SOUTHEAST
The southeast layout constraint (bottom right of container).

SOUTHWEST

public static final String SOUTHWEST
The southwest layout constraint (bottom left of container).

WEST

public static final String WEST
The west layout constraint (left of container).

Constructor Details

BorderSplitPane

public BorderSplitPane()
Construct a new BorderSplitPane

Method Details

add

public Component add(Component comp)
Add a new component to the center of the BorderSplitPane
Parameters:
comp - The component to be added
Returns:
the component argument

add

public void add(Component comp,
                Object constraints)
Add a component at the specified compass point or center. The constraint can be one of the constants defined in BorderSPlitPane being, NORTH, SOUTH, NORTHWEST, NORTHEAST, SOUTHWEST, SOTHEAST or CENTER
Parameters:
comp - The component to be added
constraints - The position to place the component

add

public void add(Component comp,
                Object constraints,
                int index)
This method is only implemented to satisfy the superclass declaration. add(Component comp, Object constraints) should be used in preference
Parameters:
comp - The component to be added
constraints - The position to place the component
index - The index value is ignored

add

public Component add(Component comp,
                     int index)
This method is only implemented to satisfy the superclass declaration. add(Component comp) should be used in preference
Parameters:
comp - The component to be added
index - The index value is ignored
Returns:
the component argument

remove

public void remove(Component comp)