com.canoo.ulc.community.layout.application
Class GridBagConstraints

java.lang.Object
  |
  +--com.canoo.ulc.community.layout.application.GridBagConstraints

All Implemented Interfaces:

Cloneable, Serializable

public class GridBagConstraints

extends Object

implements Serializable, Cloneable

The GridBagConstraints class specifies constraints for components that are laid out using the ULCGridBagLayoutPane class.

See Also:

ULCGridBagLayoutPane, Serialized Form

Field Summary

static int	BOTH Resize the component both horizontally and vertically.
static int	CENTER Put the component in the center of its display area.
static int	EAST Put the component on the right side of its display area, centered vertically.
int	fAnchor This field is used when the component is smaller than its display area.
int	fFill This field is used when the component's display area is larger than the component's requested size.
int	fGridheight Specifies the number of cells in a column for the component's display area.
int	fGridwidth Specifies the number of cells in a row for the component's display area.
int	fGridx Specifies the cell at the left of the component's display area, where the leftmost cell has fGridx=0.
int	fGridy Specifies the cell at the top of the component's display area, where the topmost cell has fGridy=0.
Insets	fInsets This field specifies the external padding of the component, the minimum amount of space between the component and the edges of its display area.
int	fIpadx This field specifies the internal padding of the component, how much space to add to the minimum width of the component.
int	fIpady This field specifies the internal padding, that is, how much space to add to the minimum height of the component.
double	fWeightx Specifies how to distribute extra horizontal space.
double	fWeighty Specifies how to distribute extra vertical space.
static int	HORIZONTAL Resize the component horizontally but not vertically.
static int	NONE Do not resize the component.
static int	NORTH Put the component at the top of its display area, centered horizontally.
static int	NORTHEAST Put the component at the top-right corner of its display area.
static int	NORTHWEST Put the component at the top-left corner of its display area.
static int	RELATIVE Specify that this component is the next-to-last component in its column or row (fGridwidth, fGridheight), or that this component be placed next to the previously added component (fGridx, fGridy).
static int	REMAINDER Specify that this component is the last component in its column or row.
static int	SOUTH Put the component at the bottom of its display area, centered horizontally.
static int	SOUTHEAST Put the component at the bottom-right corner of its display area.
static int	SOUTHWEST Put the component at the bottom-left corner of its display area.
static int	VERTICAL Resize the component vertically but not horizontally.
static int	WEST Put the component on the left side of its display area, centered vertically.

Constructor Summary

GridBagConstraints()
Creates a new GridBagConstraint object with all of its fields set to their default values.

GridBagConstraints(GridBagConstraints constraints)
Creates a new GridBagConstraints object with all of its fields set to the values of the passed in constraints argument.

GridBagConstraints(int gridx, int gridy, int gridwidth, int gridheight, double weightx, double weighty, int anchor, int fill, Insets insets, int ipadx, int ipady)
Creates a new GridBagConstraints object with all of its fields set to the passed-in arguments.

Method Summary

Object

clone()

Methods inherited from class java.lang.Object

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

Field Detail

RELATIVE

public static final int RELATIVE

Specify that this component is the next-to-last component in its column or row (fGridwidth, fGridheight), or that this component be placed next to the previously added component (fGridx, fGridy).

REMAINDER

public static final int REMAINDER

Specify that this component is the last component in its column or row.

NONE

public static final int NONE

Do not resize the component.

BOTH

public static final int BOTH

Resize the component both horizontally and vertically.

HORIZONTAL

public static final int HORIZONTAL

Resize the component horizontally but not vertically.

VERTICAL

public static final int VERTICAL

Resize the component vertically but not horizontally.

CENTER

public static final int CENTER

Put the component in the center of its display area.

NORTH

public static final int NORTH

Put the component at the top of its display area, centered horizontally.

NORTHEAST

public static final int NORTHEAST

Put the component at the top-right corner of its display area.

EAST

public static final int EAST

Put the component on the right side of its display area, centered vertically.

SOUTHEAST

public static final int SOUTHEAST

Put the component at the bottom-right corner of its display area.

SOUTH

public static final int SOUTH

Put the component at the bottom of its display area, centered horizontally.

SOUTHWEST

public static final int SOUTHWEST

Put the component at the bottom-left corner of its display area.

WEST

public static final int WEST

Put the component on the left side of its display area, centered vertically.

NORTHWEST

public static final int NORTHWEST

Put the component at the top-left corner of its display area.

fGridx

public int fGridx

Specifies the cell at the left of the component's display area, where the leftmost cell has fGridx=0. The value RELATIVE specifies that the component be placed just to the right of the component that was added to the container just before this component was added.

The default value is RELATIVE. fGridx should be a non-negative value.

fGridy

public int fGridy

Specifies the cell at the top of the component's display area, where the topmost cell has fGridy=0. The value RELATIVE specifies that the component be placed just below the component that was added to the container just before this component was added.

The default value is RELATIVE. fGridy should be a non-negative value.

fGridwidth

public int fGridwidth

Specifies the number of cells in a row for the component's display area.

Use REMAINDER to specify that the component be the last one in its row. Use RELATIVE to specify that the component be the next-to-last one in its row.

fGridwidth should be non-negative and the default value is 1.

fGridheight

public int fGridheight

Specifies the number of cells in a column for the component's display area.

Use REMAINDER to specify that the component be the last one in its column. Use RELATIVE to specify that the component be the next-to-last one in its column.

fGridheight should be a non-negative value and the default value is 1.

fWeightx

public double fWeightx

Specifies how to distribute extra horizontal space.

The grid bag layout manager calculates the weight of a column to be the maximum fWeightx of all the components in a column. If the resulting layout is smaller horizontally than the area it needs to fill, the extra space is distributed to each column in proportion to its weight. A column that has a weight of zero receives no extra space.

If all the weights are zero, all the extra space appears between the grids of the cell and the left and right edges.

The default value of this field is 0. fWeightx should be a non-negative value.

fWeighty

public double fWeighty

Specifies how to distribute extra vertical space.

The grid bag layout manager calculates the weight of a row to be the maximum fWeighty of all the components in a row. If the resulting layout is smaller vertically than the area it needs to fill, the extra space is distributed to each row in proportion to its weight. A row that has a weight of zero receives no extra space.

If all the weights are zero, all the extra space appears between the grids of the cell and the top and bottom edges.

The default value of this field is 0. fWeighty should be a non-negative value.

fAnchor

public int fAnchor

This field is used when the component is smaller than its display area. It determines where, within the display area, to place the component. Possible values are CENTER, NORTH, NORTHEAST, EAST, SOUTHEAST, SOUTH, SOUTHWEST, WEST, and NORTHWEST. The default value is CENTER.

fFill

public int fFill

This field is used when the component's display area is larger than the component's requested size. It determines whether to resize the component, and if so, how.

The following values are valid for fFill:

• NONE: Do not resize the component.
• HORIZONTAL: Make the component wide enough to fill its display area horizontally, but do not change its height.
• VERTICAL: Make the component tall enough to fill its display area vertically, but do not change its width.
• BOTH: Make the component fill its display area entirely.

The default value is NONE.

fInsets

public Insets fInsets

This field specifies the external padding of the component, the minimum amount of space between the component and the edges of its display area.

The default value is new Insets(0, 0, 0, 0).

fIpadx

public int fIpadx

This field specifies the internal padding of the component, how much space to add to the minimum width of the component. The width of the component is at least its minimum width plus (fIpadx * 2) pixels.

The default value is 0.

fIpady

public int fIpady

This field specifies the internal padding, that is, how much space to add to the minimum height of the component. The height of the component is at least its minimum height plus (fIpady * 2) pixels.

The default value is 0.

Constructor Detail

GridBagConstraints

public GridBagConstraints()

Creates a new GridBagConstraint object with all of its fields set to their default values.

GridBagConstraints

public GridBagConstraints(int gridx,
                          int gridy,
                          int gridwidth,
                          int gridheight,
                          double weightx,
                          double weighty,
                          int anchor,
                          int fill,
                          Insets insets,
                          int ipadx,
                          int ipady)

Creates a new GridBagConstraints object with all of its fields set to the passed-in arguments.

Parameters:

gridx - The initial gridx value.

gridy - The initial gridy value.

gridwidth - The initial gridwidth value.

gridheight - The initial gridheight value.

weightx - The initial weightx value.

weighty - The initial weighty value.

anchor - The initial anchor value.

fill - The initial fill value.

insets - The initial insets value.

ipadx - The initial ipadx value.

ipady - The initial ipady value.

GridBagConstraints

public GridBagConstraints(GridBagConstraints constraints)

Creates a new GridBagConstraints object with all of its fields set to the values of the passed in constraints argument.

Parameters:

constraints - The initial constraints values.

Method Detail

clone

public Object clone()

Overrides:

clone in class Object