java.lang.Object | |
↳ | java.awt.GridBagConstraints |
The GridBagConstraints
class specifies constraints
for components that are laid out using the
GridBagLayout
class.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | ABOVE_BASELINE | Possible value for the anchor field. |
|||||||||
int | ABOVE_BASELINE_LEADING | Possible value for the anchor field. |
|||||||||
int | ABOVE_BASELINE_TRAILING | Possible value for the anchor field. |
|||||||||
int | BASELINE | Possible value for the anchor field. |
|||||||||
int | BASELINE_LEADING | Possible value for the anchor field. |
|||||||||
int | BASELINE_TRAILING | Possible value for the anchor field. |
|||||||||
int | BELOW_BASELINE | Possible value for the anchor field. |
|||||||||
int | BELOW_BASELINE_LEADING | Possible value for the anchor field. |
|||||||||
int | BELOW_BASELINE_TRAILING | Possible value for the anchor field. |
|||||||||
int | BOTH | Resize the component both horizontally and vertically. | |||||||||
int | CENTER | Put the component in the center of its display area. | |||||||||
int | EAST | Put the component on the right side of its display area, centered vertically. | |||||||||
int | FIRST_LINE_END | Place the component in the corner of its display area where
the first line of text on a page would normally end for the current
ComponentOrienation . |
|||||||||
int | FIRST_LINE_START | Place the component in the corner of its display area where
the first line of text on a page would normally begin for the current
ComponentOrienation . |
|||||||||
int | HORIZONTAL | Resize the component horizontally but not vertically. | |||||||||
int | LAST_LINE_END | Place the component in the corner of its display area where
the last line of text on a page would normally end for the current
ComponentOrienation . |
|||||||||
int | LAST_LINE_START | Place the component in the corner of its display area where
the last line of text on a page would normally start for the current
ComponentOrienation . |
|||||||||
int | LINE_END | Place the component centered along the edge of its display area where
lines of text would normally end for the current
ComponentOrienation . |
|||||||||
int | LINE_START | Place the component centered along the edge of its display area where
lines of text would normally begin for the current
ComponentOrienation . |
|||||||||
int | NONE | Do not resize the component. | |||||||||
int | NORTH | Put the component at the top of its display area, centered horizontally. | |||||||||
int | NORTHEAST | Put the component at the top-right corner of its display area. | |||||||||
int | NORTHWEST | Put the component at the top-left corner of its display area. | |||||||||
int | PAGE_END | Place the component centered along the edge of its display area
associated with the end of a page for the current
ComponentOrienation . |
|||||||||
int | PAGE_START | Place the component centered along the edge of its display area
associated with the start of a page for the current
ComponentOrienation . |
|||||||||
int | RELATIVE | Specifies that this component is the next-to-last component in its
column or row (gridwidth , gridheight ),
or that this component be placed next to the previously added
component (gridx , gridy ). |
|||||||||
int | REMAINDER | Specifies that this component is the last component in its column or row. | |||||||||
int | SOUTH | Put the component at the bottom of its display area, centered horizontally. | |||||||||
int | SOUTHEAST | Put the component at the bottom-right corner of its display area. | |||||||||
int | SOUTHWEST | Put the component at the bottom-left corner of its display area. | |||||||||
int | VERTICAL | Resize the component vertically but not horizontally. | |||||||||
int | WEST | Put the component on the left side of its display area, centered vertically. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
anchor | This field is used when the component is smaller than its display area. | ||||||||||
fill | This field is used when the component's display area is larger than the component's requested size. | ||||||||||
gridheight | Specifies the number of cells in a column for the component's display area. | ||||||||||
gridwidth | Specifies the number of cells in a row for the component's display area. | ||||||||||
gridx | Specifies the cell containing the leading edge of the component's
display area, where the first cell in a row has gridx=0 . |
||||||||||
gridy | Specifies the cell at the top of the component's display area,
where the topmost cell has gridy=0 . |
||||||||||
insets | This field specifies the external padding of the component, the minimum amount of space between the component and the edges of its display area. | ||||||||||
ipadx | This field specifies the internal padding of the component, how much space to add to the minimum width of the component. | ||||||||||
ipady | This field specifies the internal padding, that is, how much space to add to the minimum height of the component. | ||||||||||
weightx | Specifies how to distribute extra horizontal space. | ||||||||||
weighty | Specifies how to distribute extra vertical space. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a
GridBagConstraint object with
all of its fields set to their default value. | |||||||||||
Creates a
GridBagConstraints object with
all of its fields set to the passed-in arguments. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a copy of this grid bag constraint.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Possible value for the anchor
field. Specifies
that the component should be horizontally centered. Vertically
the component is positioned so that its bottom edge touches
the baseline of the starting row. If the starting row does not
have a baseline it will be vertically centered.
Possible value for the anchor
field. Specifies
that the component should be horizontally placed along the
leading edge. For components with a left-to-right orientation,
the leading edge is the left edge. Vertically the component is
positioned so that its bottom edge touches the baseline of the
starting row. If the starting row does not have a baseline it
will be vertically centered.
Possible value for the anchor
field. Specifies
that the component should be horizontally placed along the
trailing edge. For components with a left-to-right
orientation, the trailing edge is the right edge. Vertically
the component is positioned so that its bottom edge touches
the baseline of the starting row. If the starting row does not
have a baseline it will be vertically centered.
Possible value for the anchor
field. Specifies
that the component should be horizontally centered and
vertically aligned along the baseline of the prevailing row.
If the component does not have a baseline it will be vertically
centered.
Possible value for the anchor
field. Specifies
that the component should be horizontally placed along the
leading edge. For components with a left-to-right orientation,
the leading edge is the left edge. Vertically the component is
aligned along the baseline of the prevailing row. If the
component does not have a baseline it will be vertically
centered.
Possible value for the anchor
field. Specifies
that the component should be horizontally placed along the
trailing edge. For components with a left-to-right
orientation, the trailing edge is the right edge. Vertically
the component is aligned along the baseline of the prevailing
row. If the component does not have a baseline it will be
vertically centered.
Possible value for the anchor
field. Specifies
that the component should be horizontally centered. Vertically
the component is positioned so that its top edge touches the
baseline of the starting row. If the starting row does not
have a baseline it will be vertically centered.
Possible value for the anchor
field. Specifies
that the component should be horizontally placed along the
leading edge. For components with a left-to-right orientation,
the leading edge is the left edge. Vertically the component is
positioned so that its top edge touches the baseline of the
starting row. If the starting row does not have a baseline it
will be vertically centered.
Possible value for the anchor
field. Specifies
that the component should be horizontally placed along the
trailing edge. For components with a left-to-right
orientation, the trailing edge is the right edge. Vertically
the component is positioned so that its top edge touches the
baseline of the starting row. If the starting row does not
have a baseline it will be vertically centered.
Resize the component both horizontally and vertically.
Put the component in the center of its display area.
Put the component on the right side of its display area, centered vertically.
Place the component in the corner of its display area where
the first line of text on a page would normally end for the current
ComponentOrienation
. Equal to NORTHEAST for horizontal,
left-to-right orientations and NORTHWEST for horizontal, right-to-left
orientations.
Place the component in the corner of its display area where
the first line of text on a page would normally begin for the current
ComponentOrienation
. Equal to NORTHWEST for horizontal,
left-to-right orientations and NORTHEAST for horizontal, right-to-left
orientations.
Resize the component horizontally but not vertically.
Place the component in the corner of its display area where
the last line of text on a page would normally end for the current
ComponentOrienation
. Equal to SOUTHEAST for horizontal,
left-to-right orientations and SOUTHWEST for horizontal, right-to-left
orientations.
Place the component in the corner of its display area where
the last line of text on a page would normally start for the current
ComponentOrienation
. Equal to SOUTHWEST for horizontal,
left-to-right orientations and SOUTHEAST for horizontal, right-to-left
orientations.
Place the component centered along the edge of its display area where
lines of text would normally end for the current
ComponentOrienation
. Equal to EAST for horizontal,
left-to-right orientations and WEST for horizontal, right-to-left
orientations.
Place the component centered along the edge of its display area where
lines of text would normally begin for the current
ComponentOrienation
. Equal to WEST for horizontal,
left-to-right orientations and EAST for horizontal, right-to-left
orientations.
Do not resize the component.
Put the component at the top of its display area, centered horizontally.
Put the component at the top-right corner of its display area.
Put the component at the top-left corner of its display area.
Place the component centered along the edge of its display area
associated with the end of a page for the current
ComponentOrienation
. Equal to SOUTH for horizontal
orientations.
Place the component centered along the edge of its display area
associated with the start of a page for the current
ComponentOrienation
. Equal to NORTH for horizontal
orientations.
Specifies that this component is the next-to-last component in its
column or row (gridwidth
, gridheight
),
or that this component be placed next to the previously added
component (gridx
, gridy
).
Specifies that this component is the last component in its column or row.
Put the component at the bottom of its display area, centered horizontally.
Put the component at the bottom-right corner of its display area.
Put the component at the bottom-left corner of its display area.
Resize the component vertically but not horizontally.
Put the component on the left side of its display area, centered vertically.
This field is used when the component is smaller than its display area. It determines where, within the display area, to place the component.
There are three kinds of possible values: orientation
relative, baseline relative and absolute. Orientation relative
values are interpreted relative to the container's component
orientation property, baseline relative values are interpreted
relative to the baseline and absolute values are not. The
absolute values are:
CENTER
, NORTH
, NORTHEAST
,
EAST
, SOUTHEAST
, SOUTH
,
SOUTHWEST
, WEST
, and NORTHWEST
.
The orientation relative values are: PAGE_START
,
PAGE_END
,
LINE_START
, LINE_END
,
FIRST_LINE_START
, FIRST_LINE_END
,
LAST_LINE_START
and LAST_LINE_END
. The
baseline relvative values are:
BASELINE
, BASELINE_LEADING
,
BASELINE_TRAILING
,
ABOVE_BASELINE
, ABOVE_BASELINE_LEADING
,
ABOVE_BASELINE_TRAILING
,
BELOW_BASELINE
, BELOW_BASELINE_LEADING
,
and BELOW_BASELINE_TRAILING
.
The default value is CENTER
.@serial
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 fill
:
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
.@serial
Specifies the number of cells in a column for the component's display area.
Use REMAINDER
to specify that the component's
display area will be from gridy
to the last
cell in the column.
Use RELATIVE
to specify that the component's
display area will be from gridy
to the next
to the last one in its column.
gridheight
should be a non-negative value and the
default value is 1.@serial
Specifies the number of cells in a row for the component's display area.
Use REMAINDER
to specify that the component's
display area will be from gridx
to the last
cell in the row.
Use RELATIVE
to specify that the component's
display area will be from gridx
to the next
to the last one in its row.
gridwidth
should be non-negative and the default
value is 1.@serial
Specifies the cell containing the leading edge of the component's
display area, where the first cell in a row has gridx=0
.
The leading edge of a component's display area is its left edge for
a horizontal, left-to-right container and its right edge for a
horizontal, right-to-left container.
The value
RELATIVE
specifies that the component be placed
immediately following the component that was added to the container
just before this component was added.
The default value is RELATIVE
.
gridx
should be a non-negative value.@serial
Specifies the cell at the top of the component's display area,
where the topmost cell has gridy=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
.
gridy
should be a non-negative value.@serial
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)
.@serial
Specifies how to distribute extra horizontal space.
The grid bag layout manager calculates the weight of a column to
be the maximum weightx
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
.
weightx
should be a non-negative value.@serial
Specifies how to distribute extra vertical space.
The grid bag layout manager calculates the weight of a row to be
the maximum weighty
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
.
weighty
should be a non-negative value.@serial
Creates a GridBagConstraint
object with
all of its fields set to their default value.
Creates a GridBagConstraints
object with
all of its fields set to the passed-in arguments.
Note: Because the use of this constructor hinders readability
of source code, this constructor should only be used by
automatic source code generation tools.
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. |
Creates a copy of this grid bag constraint.