java.awt

Class FlowLayout

java.lang.Object

java.awt.FlowLayout

All Implemented Interfaces:

LayoutManager, Serializable

public class FlowLayout
extends Object
implements LayoutManager, Serializable

This class implements a flow-based layout. Components are laid out in order from left to right. When a component cannot be placed without horizontal clipping, a new row is started. This class supports horizontal and vertical gaps. These are used for spacing between components.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENTER Constant that specifies center alignment.
static int	LEADING Constant that specifies alignment to leading edge of container's orientation.
static int	LEFT Constant that specifies left alignment.
static int	RIGHT Constant that specifies right alignment.
static int	TRAILING Constant that specifies alignment to trailing edge of container's orientation.

Constructor Summary

Constructors

Constructor and Description
FlowLayout() Initializes a new instance of FlowLayout with a center justification and a default horizontal and vertical gap of 5.
FlowLayout(int align) Initializes a new instance of FlowLayout with the specified justification and a default horizontal and vertical gap of 5.
FlowLayout(int align, int hgap, int vgap) Initializes a new instance of FlowLayout with the specified justification and gap values

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayoutComponent(String name, Component comp) Add a new component to the layout.
int	getAlignment() Returns the current justification value for this object.
int	getHgap() Returns the horizontal gap between components.
int	getVgap() Returns the vertical gap between lines of components.
void	layoutContainer(Container parent) Lay out the container's components based on current settings.
Dimension	minimumLayoutSize(Container cont) Returns the minimum layout size for the specified container using this layout.
Dimension	preferredLayoutSize(Container cont) Returns the preferred layout size for the specified container using this layout.
void	removeLayoutComponent(Component comp) Remove the indicated component from this layout manager.
void	setAlignment(int align) Sets the justification value for this object to the specified value.
void	setHgap(int hgap) Sets the horizontal gap between lines of components to the specified value.
void	setVgap(int vgap) Sets the vertical gap between lines of components to the specified value.
String	toString() Return String description of this object.

Methods inherited from class java.lang.Object

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

Field Detail

LEFT

public static final int LEFT

Constant that specifies left alignment.

See Also:

Constant Field Values

CENTER

public static final int CENTER

Constant that specifies center alignment.

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

Constant that specifies right alignment.

See Also:

Constant Field Values

LEADING

public static final int LEADING

Constant that specifies alignment to leading edge of container's orientation.

See Also:

Constant Field Values

TRAILING

public static final int TRAILING

Constant that specifies alignment to trailing edge of container's orientation.

See Also:

Constant Field Values

Constructor Detail

FlowLayout

public FlowLayout()

Initializes a new instance of FlowLayout with a center justification and a default horizontal and vertical gap of 5.

FlowLayout

public FlowLayout(int align)

Initializes a new instance of FlowLayout with the specified justification and a default horizontal and vertical gap of 5.

Parameters:

align - The justification setting, which should be one of the contants in this class.

FlowLayout

public FlowLayout(int align,
          int hgap,
          int vgap)

Initializes a new instance of FlowLayout with the specified justification and gap values

Parameters:

align - Alignment

hgap - The horizontal gap

vgap - The vertical gap

Throws:

IllegalArgumentException - If either gap is negative

Method Detail

addLayoutComponent

public void addLayoutComponent(String name,
                      Component comp)

Add a new component to the layout. This particular implementation does nothing.

Specified by:

addLayoutComponent in interface LayoutManager

Parameters:

name - the name

comp - the component

getAlignment

public int getAlignment()

Returns the current justification value for this object.

Returns:

The current justification value for this object.

getHgap

public int getHgap()

Returns the horizontal gap between components.

Returns:

The horizontal gap between components.

getVgap

public int getVgap()

Returns the vertical gap between lines of components.

Returns:

The vertical gap between lines of components.

layoutContainer

public void layoutContainer(Container parent)

Lay out the container's components based on current settings.

Specified by:

layoutContainer in interface LayoutManager

Parameters:

parent - The parent container

minimumLayoutSize

public Dimension minimumLayoutSize(Container cont)

Returns the minimum layout size for the specified container using this layout.

Specified by:

minimumLayoutSize in interface LayoutManager

Parameters:

cont - The parent container

Returns:

The minimum layout size.

See Also:

LayoutManager.preferredLayoutSize(Container)

preferredLayoutSize

public Dimension preferredLayoutSize(Container cont)

Returns the preferred layout size for the specified container using this layout.

Specified by:

preferredLayoutSize in interface LayoutManager

Parameters:

cont - The parent container

Returns:

The preferred layout size.

See Also:

LayoutManager.minimumLayoutSize(Container)

removeLayoutComponent

public void removeLayoutComponent(Component comp)

Remove the indicated component from this layout manager. This particular implementation does nothing.

Specified by:

removeLayoutComponent in interface LayoutManager

Parameters:

comp - The component to remove

setAlignment

public void setAlignment(int align)

Sets the justification value for this object to the specified value.

Parameters:

align - The new justification value for this object, which must be one of the constants in this class.

setHgap

public void setHgap(int hgap)

Sets the horizontal gap between lines of components to the specified value. No Exception is thrown if hgap < 0.

Parameters:

hgap - The new horizontal gap between components.

setVgap

public void setVgap(int vgap)

Sets the vertical gap between lines of components to the specified value. No Exception is thrown if vgap < 0.

Parameters:

vgap - The new vertical gap.

toString

public String toString()

Return String description of this object.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)