javax.swing

Class BoxLayout

java.lang.Object

javax.swing.BoxLayout

All Implemented Interfaces:

java.awt.LayoutManager, java.awt.LayoutManager2, java.io.Serializable

public class BoxLayout
extends java.lang.Object
implements java.awt.LayoutManager2, java.io.Serializable

A layout that stacks the children of a container in a Box, either horizontally or vertically.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	LINE_AXIS Specifies that components are laid out in the direction of a line of text.
static int	PAGE_AXIS Sepcifies that components are laid out in the direction of the line flow.
static int	X_AXIS Specifies that components are laid out left to right.
static int	Y_AXIS Specifies that components are laid out top to bottom.

Constructor Summary

Constructors

Constructor and Description
BoxLayout(java.awt.Container container, int way) Constructs a BoxLayout object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayoutComponent(java.awt.Component child, java.lang.Object constraints) Adds a component to the layout.
void	addLayoutComponent(java.lang.String name, java.awt.Component component) Adds a component to the layout.
float	getLayoutAlignmentX(java.awt.Container parent) Returns the alignment along the X axis for the container.
float	getLayoutAlignmentY(java.awt.Container parent) Returns the alignment along the Y axis for the container.
void	invalidateLayout(java.awt.Container parent) Invalidates the layout.
void	layoutContainer(java.awt.Container parent) Lays out the specified container using this layout.
java.awt.Dimension	maximumLayoutSize(java.awt.Container parent) Returns the maximum size of the layout gived the components in the given container.
java.awt.Dimension	minimumLayoutSize(java.awt.Container parent) Returns the minimum size of the layout.
java.awt.Dimension	preferredLayoutSize(java.awt.Container parent) Returns the preferred size of the layout.
void	removeLayoutComponent(java.awt.Component component) Removes a component from the layout.

Methods inherited from class java.lang.Object

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

Field Detail

X_AXIS

public static final int X_AXIS

Specifies that components are laid out left to right.

See Also:

Constant Field Values

Y_AXIS

public static final int Y_AXIS

Specifies that components are laid out top to bottom.

See Also:

Constant Field Values

LINE_AXIS

public static final int LINE_AXIS

Specifies that components are laid out in the direction of a line of text.

See Also:

Constant Field Values

PAGE_AXIS

public static final int PAGE_AXIS

Sepcifies that components are laid out in the direction of the line flow.

See Also:

Constant Field Values

Constructor Detail

BoxLayout

public BoxLayout(java.awt.Container container,
         int way)

Constructs a BoxLayout object.

Parameters:

container - The container that needs to be laid out.

way - The orientation of the components.

Throws:

java.awt.AWTError - If way has an invalid value.

Method Detail

addLayoutComponent

public void addLayoutComponent(java.lang.String name,
                      java.awt.Component component)

Adds a component to the layout. Not used in BoxLayout.

Specified by:

addLayoutComponent in interface java.awt.LayoutManager

Parameters:

name - The name of the component to add.

component - the component to add to the layout.

removeLayoutComponent

public void removeLayoutComponent(java.awt.Component component)

Removes a component from the layout. Not used in BoxLayout.

Specified by:

removeLayoutComponent in interface java.awt.LayoutManager

Parameters:

component - The component to remove from the layout.

preferredLayoutSize

public java.awt.Dimension preferredLayoutSize(java.awt.Container parent)

Returns the preferred size of the layout.

Specified by:

preferredLayoutSize in interface java.awt.LayoutManager

Parameters:

parent - The container that needs to be laid out.

Returns:

The dimension of the layout.

See Also:

LayoutManager.minimumLayoutSize(Container)

minimumLayoutSize

public java.awt.Dimension minimumLayoutSize(java.awt.Container parent)

Returns the minimum size of the layout.

Specified by:

minimumLayoutSize in interface java.awt.LayoutManager

Parameters:

parent - The container that needs to be laid out.

Returns:

The dimension of the layout.

See Also:

LayoutManager.preferredLayoutSize(Container)

layoutContainer

public void layoutContainer(java.awt.Container parent)

Lays out the specified container using this layout.

Specified by:

layoutContainer in interface java.awt.LayoutManager

Parameters:

parent - The container that needs to be laid out.

addLayoutComponent

public void addLayoutComponent(java.awt.Component child,
                      java.lang.Object constraints)

Adds a component to the layout. Not used in BoxLayout

Specified by:

addLayoutComponent in interface java.awt.LayoutManager2

Parameters:

child - The component to add to the layout.

constraints - The constraints for the component in the layout.

getLayoutAlignmentX

public float getLayoutAlignmentX(java.awt.Container parent)

Returns the alignment along the X axis for the container.

Specified by:

getLayoutAlignmentX in interface java.awt.LayoutManager2

Parameters:

parent - The container that needs to be laid out.

Returns:

The alignment.

getLayoutAlignmentY

public float getLayoutAlignmentY(java.awt.Container parent)

Returns the alignment along the Y axis for the container.

Specified by:

getLayoutAlignmentY in interface java.awt.LayoutManager2

Parameters:

parent - The container that needs to be laid out.

Returns:

The alignment.

invalidateLayout

public void invalidateLayout(java.awt.Container parent)

Invalidates the layout.

Specified by:

invalidateLayout in interface java.awt.LayoutManager2

Parameters:

parent - The container that needs to be laid out.

maximumLayoutSize

public java.awt.Dimension maximumLayoutSize(java.awt.Container parent)

Returns the maximum size of the layout gived the components in the given container.

Specified by:

maximumLayoutSize in interface java.awt.LayoutManager2

Parameters:

parent - The container that needs to be laid out.

Returns:

The dimension of the layout.

See Also:

Component.getMaximumSize()