- All Implemented Interfaces:
Serializable
,Cloneable
GridBagConstraints
class specifies constraints
for components that are laid out using the
GridBagLayout
class.- Since:
- 1.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Possible value for theanchor
field.static final int
Possible value for theanchor
field.static final int
Possible value for theanchor
field.int
This field is used when the component is smaller than its display area.static final int
Possible value for theanchor
field.static final int
Possible value for theanchor
field.static final int
Possible value for theanchor
field.static final int
Possible value for theanchor
field.static final int
Possible value for theanchor
field.static final int
Possible value for theanchor
field.static final int
Resize the component both horizontally and vertically.static final int
Put the component in the center of its display area.static final int
Put the component on the right side of its display area, centered vertically.int
This field is used when the component's display area is larger than the component's requested size.static final int
Place the component in the corner of its display area where the first line of text on a page would normally end for the currentComponentOrientation
.static final int
Place the component in the corner of its display area where the first line of text on a page would normally begin for the currentComponentOrientation
.int
Specifies the number of cells in a column for the component's display area.int
Specifies the number of cells in a row for the component's display area.int
Specifies the cell containing the leading edge of the component's display area, where the first cell in a row hasgridx=0
.int
Specifies the cell at the top of the component's display area, where the topmost cell hasgridy=0
.static final int
Resize the component horizontally but not vertically.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
This field specifies the internal padding of the component, how much space to add to the minimum width of the component.int
This field specifies the internal padding, that is, how much space to add to the minimum height of the component.static final int
Place the component in the corner of its display area where the last line of text on a page would normally end for the currentComponentOrientation
.static final int
Place the component in the corner of its display area where the last line of text on a page would normally start for the currentComponentOrientation
.static final int
Place the component centered along the edge of its display area where lines of text would normally end for the currentComponentOrientation
.static final int
Place the component centered along the edge of its display area where lines of text would normally begin for the currentComponentOrientation
.static final int
Do not resize the component.static final int
Put the component at the top of its display area, centered horizontally.static final int
Put the component at the top-right corner of its display area.static final int
Put the component at the top-left corner of its display area.static final int
Place the component centered along the edge of its display area associated with the end of a page for the currentComponentOrientation
.static final int
Place the component centered along the edge of its display area associated with the start of a page for the currentComponentOrientation
.static final int
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
).static final int
Specifies that this component is the last component in its column or row.static final int
Put the component at the bottom of its display area, centered horizontally.static final int
Put the component at the bottom-right corner of its display area.static final int
Put the component at the bottom-left corner of its display area.static final int
Resize the component vertically but not horizontally.double
Specifies how to distribute extra horizontal space.double
Specifies how to distribute extra vertical space.static final int
Put the component on the left side of its display area, centered vertically. -
Constructor Summary
ConstructorDescriptionCreates aGridBagConstraint
object with all of its fields set to their default value.GridBagConstraints
(int gridx, int gridy, int gridwidth, int gridheight, double weightx, double weighty, int anchor, int fill, Insets insets, int ipadx, int ipady) Creates aGridBagConstraints
object with all of its fields set to the passed-in arguments. -
Method Summary
-
Field Details
-
RELATIVE
public static final int RELATIVESpecifies 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
).- See Also:
-
REMAINDER
public static final int REMAINDERSpecifies that this component is the last component in its column or row.- See Also:
-
NONE
public static final int NONEDo not resize the component.- See Also:
-
BOTH
public static final int BOTHResize the component both horizontally and vertically.- See Also:
-
HORIZONTAL
public static final int HORIZONTALResize the component horizontally but not vertically.- See Also:
-
VERTICAL
public static final int VERTICALResize the component vertically but not horizontally.- See Also:
-
CENTER
public static final int CENTERPut the component in the center of its display area.- See Also:
-
NORTH
public static final int NORTHPut the component at the top of its display area, centered horizontally.- See Also:
-
NORTHEAST
public static final int NORTHEASTPut the component at the top-right corner of its display area.- See Also:
-
EAST
public static final int EASTPut the component on the right side of its display area, centered vertically.- See Also:
-
SOUTHEAST
public static final int SOUTHEASTPut the component at the bottom-right corner of its display area.- See Also:
-
SOUTH
public static final int SOUTHPut the component at the bottom of its display area, centered horizontally.- See Also:
-
SOUTHWEST
public static final int SOUTHWESTPut the component at the bottom-left corner of its display area.- See Also:
-
WEST
public static final int WESTPut the component on the left side of its display area, centered vertically.- See Also:
-
NORTHWEST
public static final int NORTHWESTPut the component at the top-left corner of its display area.- See Also:
-
PAGE_START
public static final int PAGE_STARTPlace the component centered along the edge of its display area associated with the start of a page for the currentComponentOrientation
. Equal to NORTH for horizontal orientations.- See Also:
-
PAGE_END
public static final int PAGE_ENDPlace the component centered along the edge of its display area associated with the end of a page for the currentComponentOrientation
. Equal to SOUTH for horizontal orientations.- See Also:
-
LINE_START
public static final int LINE_STARTPlace the component centered along the edge of its display area where lines of text would normally begin for the currentComponentOrientation
. Equal to WEST for horizontal, left-to-right orientations and EAST for horizontal, right-to-left orientations.- See Also:
-
LINE_END
public static final int LINE_ENDPlace the component centered along the edge of its display area where lines of text would normally end for the currentComponentOrientation
. Equal to EAST for horizontal, left-to-right orientations and WEST for horizontal, right-to-left orientations.- See Also:
-
FIRST_LINE_START
public static final int FIRST_LINE_STARTPlace the component in the corner of its display area where the first line of text on a page would normally begin for the currentComponentOrientation
. Equal to NORTHWEST for horizontal, left-to-right orientations and NORTHEAST for horizontal, right-to-left orientations.- See Also:
-
FIRST_LINE_END
public static final int FIRST_LINE_ENDPlace the component in the corner of its display area where the first line of text on a page would normally end for the currentComponentOrientation
. Equal to NORTHEAST for horizontal, left-to-right orientations and NORTHWEST for horizontal, right-to-left orientations.- See Also:
-
LAST_LINE_START
public static final int LAST_LINE_STARTPlace the component in the corner of its display area where the last line of text on a page would normally start for the currentComponentOrientation
. Equal to SOUTHWEST for horizontal, left-to-right orientations and SOUTHEAST for horizontal, right-to-left orientations.- See Also:
-
LAST_LINE_END
public static final int LAST_LINE_ENDPlace the component in the corner of its display area where the last line of text on a page would normally end for the currentComponentOrientation
. Equal to SOUTHEAST for horizontal, left-to-right orientations and SOUTHWEST for horizontal, right-to-left orientations.- See Also:
-
BASELINE
public static final int BASELINEPossible value for theanchor
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.- Since:
- 1.6
- See Also:
-
BASELINE_LEADING
public static final int BASELINE_LEADINGPossible value for theanchor
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.- Since:
- 1.6
- See Also:
-
BASELINE_TRAILING
public static final int BASELINE_TRAILINGPossible value for theanchor
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.- Since:
- 1.6
- See Also:
-
ABOVE_BASELINE
public static final int ABOVE_BASELINEPossible value for theanchor
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.- Since:
- 1.6
- See Also:
-
ABOVE_BASELINE_LEADING
public static final int ABOVE_BASELINE_LEADINGPossible value for theanchor
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.- Since:
- 1.6
- See Also:
-
ABOVE_BASELINE_TRAILING
public static final int ABOVE_BASELINE_TRAILINGPossible value for theanchor
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.- Since:
- 1.6
- See Also:
-
BELOW_BASELINE
public static final int BELOW_BASELINEPossible value for theanchor
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.- Since:
- 1.6
- See Also:
-
BELOW_BASELINE_LEADING
public static final int BELOW_BASELINE_LEADINGPossible value for theanchor
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.- Since:
- 1.6
- See Also:
-
BELOW_BASELINE_TRAILING
public static final int BELOW_BASELINE_TRAILINGPossible value for theanchor
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.- Since:
- 1.6
- See Also:
-
gridx
public int gridxSpecifies the cell containing the leading edge of the component's display area, where the first cell in a row hasgridx=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 valueRELATIVE
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.- See Also:
-
gridy
public int gridySpecifies the cell at the top of the component's display area, where the topmost cell hasgridy=0
. The valueRELATIVE
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.- See Also:
-
gridwidth
public int gridwidthSpecifies 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 fromgridx
to the last cell in the row. UseRELATIVE
to specify that the component's display area will be fromgridx
to the next to the last one in its row.gridwidth
should be non-negative and the default value is 1.- See Also:
-
gridheight
public int gridheightSpecifies 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 fromgridy
to the last cell in the column. UseRELATIVE
to specify that the component's display area will be fromgridy
to the next to the last one in its column.gridheight
should be a non-negative value and the default value is 1.- See Also:
-
weightx
public double weightxSpecifies 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.- See Also:
-
weighty
public double weightySpecifies 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.- See Also:
-
anchor
public int anchorThis 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
, andNORTHWEST
. The orientation relative values are:PAGE_START
,PAGE_END
,LINE_START
,LINE_END
,FIRST_LINE_START
,FIRST_LINE_END
,LAST_LINE_START
andLAST_LINE_END
. The baseline relative values are:BASELINE
,BASELINE_LEADING
,BASELINE_TRAILING
,ABOVE_BASELINE
,ABOVE_BASELINE_LEADING
,ABOVE_BASELINE_TRAILING
,BELOW_BASELINE
,BELOW_BASELINE_LEADING
, andBELOW_BASELINE_TRAILING
. The default value isCENTER
.- See Also:
-
fill
public int fillThis 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
.- See Also:
-
-
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.The default value is
new Insets(0, 0, 0, 0)
.- See Also:
-
ipadx
public int ipadxThis 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 plusipadx
pixels.The default value is
0
.- See Also:
-
ipady
public int ipadyThis 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 plusipady
pixels.The default value is 0.
- See Also:
-
-
Constructor Details
-
GridBagConstraints
public GridBagConstraints()Creates aGridBagConstraint
object with all of its fields set to their default value. -
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 aGridBagConstraints
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.- 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.- Since:
- 1.2
- See Also:
-
-
Method Details
-
clone
-