com.threerings.opengl.gui.layout
Class BorderLayout

java.lang.Object
  com.threerings.opengl.gui.layout.LayoutManager
      com.threerings.opengl.gui.layout.BorderLayout

public class BorderLayout
extends LayoutManager

Lays out the children of a container around the borders and one in the center. For example:

 +------------------------------------+
 |               NORTH                |
 +-----+------------------------+-----+
 |     |                        |     |
 |  W  |         CENTER         |  E  |
 |     |                        |     |
 +-----+------------------------+-----+
 |               SOUTH                |
 +------------------------------------+
 

Field Summary

static Integer	CENTER A layout constraint.
static Integer	EAST A layout constraint.
static Integer	IGNORE A layout constraint.
static Integer	NORTH A layout constraint.
static Integer	SOUTH A layout constraint.
static Integer	WEST A layout constraint.

Constructor Summary

BorderLayout()
Creates a border layout with zero gap between the horizontal components and zero gap between the vertical.

BorderLayout(int hgap, int vgap)
Creates a border layout with the specified gap between the horizontal components and the specified gap between the vertical.

Method Summary

void	addLayoutComponent(Component comp, Object constraints) Components added to a container will result in a call to this method, informing the layout manager of said constraints.
Dimension	computePreferredSize(Container target, int whint, int hhint) Computes the preferred size for the supplied container, based on the preferred sizes of its children and the layout policy implemented by this manager.
Object	getConstraints(Component comp) Returns a reference to the constraints associated with the specified component, or null for none.
void	layoutContainer(Container target) Effects the layout policy of this manager on the supplied target, adjusting the size and position of its children based on the size and position of the target at the time of this call.
void	removeLayoutComponent(Component comp) Components removed to a container for which a layout manager has been configured will result in a call to this method.
void	setGaps(int hgap, int vgap) Configures our inter-component gaps.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NORTH

public static final Integer NORTH

A layout constraint.

SOUTH

public static final Integer SOUTH

A layout constraint.

EAST

public static final Integer EAST

A layout constraint.

WEST

public static final Integer WEST

A layout constraint.

CENTER

public static final Integer CENTER

A layout constraint.

IGNORE

public static final Integer IGNORE

A layout constraint.

Constructor Detail

BorderLayout

public BorderLayout()

Creates a border layout with zero gap between the horizontal components and zero gap between the vertical.

BorderLayout

public BorderLayout(int hgap,
                    int vgap)

Creates a border layout with the specified gap between the horizontal components and the specified gap between the vertical.

Method Detail

setGaps

public void setGaps(int hgap,
                    int vgap)

Configures our inter-component gaps.

addLayoutComponent

public void addLayoutComponent(Component comp,
                               Object constraints)

Description copied from class: LayoutManager

Components added to a container will result in a call to this method, informing the layout manager of said constraints. The default implementation does nothing.

Overrides:

addLayoutComponent in class LayoutManager

removeLayoutComponent

public void removeLayoutComponent(Component comp)

Description copied from class: LayoutManager

Components removed to a container for which a layout manager has been configured will result in a call to this method. The default implementation does nothing.

Overrides:

removeLayoutComponent in class LayoutManager

getConstraints

public Object getConstraints(Component comp)

Description copied from class: LayoutManager

Returns a reference to the constraints associated with the specified component, or null for none. The default implementation always returns null.

Overrides:

getConstraints in class LayoutManager

computePreferredSize

public Dimension computePreferredSize(Container target,
                                      int whint,
                                      int hhint)

Description copied from class: LayoutManager

Computes the preferred size for the supplied container, based on the preferred sizes of its children and the layout policy implemented by this manager. Note: it is not necessary to add the container's insets to the returned preferred size.

Specified by:

computePreferredSize in class LayoutManager

layoutContainer

public void layoutContainer(Container target)

Description copied from class: LayoutManager

Effects the layout policy of this manager on the supplied target, adjusting the size and position of its children based on the size and position of the target at the time of this call. Note: the target's insets must be accounted for when laying out the children.

Specified by:

layoutContainer in class LayoutManager