Liking cljdoc? Tell your friends :D

jdk.awt.GridBagConstraints

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

The GridBagConstraints class specifies constraints
for components that are laid out using the
GridBagLayout class.
raw docstring

*-above-baselineclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-above-baseline-leadingclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-above-baseline-trailingclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-baselineclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-baseline-leadingclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-baseline-trailingclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-below-baselineclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-below-baseline-leadingclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-below-baseline-trailingclj

Static Constant.

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.

type: int

Static Constant.

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.

type: int
raw docstring

*-bothclj

Static Constant.

Resize the component both horizontally and vertically.

type: int

Static Constant.

Resize the component both horizontally and vertically.

type: int
raw docstring

*-centerclj

Static Constant.

Put the component in the center of its display area.

type: int

Static Constant.

Put the component in the center of its display area.

type: int
raw docstring

*-eastclj

Static Constant.

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

type: int

Static Constant.

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

type: int
raw docstring

*-first-line-endclj

Static Constant.

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 ComponentOrientation. Equal to NORTHEAST for horizontal, left-to-right orientations and NORTHWEST for horizontal, right-to-left orientations.

type: int

Static Constant.

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
 ComponentOrientation.  Equal to NORTHEAST for horizontal,
 left-to-right orientations and NORTHWEST for horizontal, right-to-left
 orientations.

type: int
raw docstring

*-first-line-startclj

Static Constant.

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 ComponentOrientation. Equal to NORTHWEST for horizontal, left-to-right orientations and NORTHEAST for horizontal, right-to-left orientations.

type: int

Static Constant.

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
 ComponentOrientation.  Equal to NORTHWEST for horizontal,
 left-to-right orientations and NORTHEAST for horizontal, right-to-left
 orientations.

type: int
raw docstring

*-horizontalclj

Static Constant.

Resize the component horizontally but not vertically.

type: int

Static Constant.

Resize the component horizontally but not vertically.

type: int
raw docstring

*-last-line-endclj

Static Constant.

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 ComponentOrientation. Equal to SOUTHEAST for horizontal, left-to-right orientations and SOUTHWEST for horizontal, right-to-left orientations.

type: int

Static Constant.

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
 ComponentOrientation.  Equal to SOUTHEAST for horizontal,
 left-to-right orientations and SOUTHWEST for horizontal, right-to-left
 orientations.

type: int
raw docstring

*-last-line-startclj

Static Constant.

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 ComponentOrientation. Equal to SOUTHWEST for horizontal, left-to-right orientations and SOUTHEAST for horizontal, right-to-left orientations.

type: int

Static Constant.

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
 ComponentOrientation.  Equal to SOUTHWEST for horizontal,
 left-to-right orientations and SOUTHEAST for horizontal, right-to-left
 orientations.

type: int
raw docstring

*-line-endclj

Static Constant.

Place the component centered along the edge of its display area where lines of text would normally end for the current ComponentOrientation. Equal to EAST for horizontal, left-to-right orientations and WEST for horizontal, right-to-left orientations.

type: int

Static Constant.

Place the component centered along the edge of its display area where
 lines of text would normally end for the current
 ComponentOrientation.  Equal to EAST for horizontal,
 left-to-right orientations and WEST for horizontal, right-to-left
 orientations.

type: int
raw docstring

*-line-startclj

Static Constant.

Place the component centered along the edge of its display area where lines of text would normally begin for the current ComponentOrientation. Equal to WEST for horizontal, left-to-right orientations and EAST for horizontal, right-to-left orientations.

type: int

Static Constant.

Place the component centered along the edge of its display area where
 lines of text would normally begin for the current
 ComponentOrientation.  Equal to WEST for horizontal,
 left-to-right orientations and EAST for horizontal, right-to-left
 orientations.

type: int
raw docstring

*-noneclj

Static Constant.

Do not resize the component.

type: int

Static Constant.

Do not resize the component.

type: int
raw docstring

*-northclj

Static Constant.

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

type: int

Static Constant.

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

type: int
raw docstring

*-northeastclj

Static Constant.

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

type: int

Static Constant.

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

type: int
raw docstring

*-northwestclj

Static Constant.

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

type: int

Static Constant.

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

type: int
raw docstring

*-page-endclj

Static Constant.

Place the component centered along the edge of its display area associated with the end of a page for the current ComponentOrientation. Equal to SOUTH for horizontal orientations.

type: int

Static Constant.

Place the component centered along the edge of its display area
 associated with the end of a page for the current
 ComponentOrientation.  Equal to SOUTH for horizontal
 orientations.

type: int
raw docstring

*-page-startclj

Static Constant.

Place the component centered along the edge of its display area associated with the start of a page for the current ComponentOrientation. Equal to NORTH for horizontal orientations.

type: int

Static Constant.

Place the component centered along the edge of its display area
 associated with the start of a page for the current
 ComponentOrientation.  Equal to NORTH for horizontal
 orientations.

type: int
raw docstring

*-relativeclj

Static Constant.

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).

type: int

Static Constant.

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).

type: int
raw docstring

*-remainderclj

Static Constant.

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

type: int

Static Constant.

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

type: int
raw docstring

*-southclj

Static Constant.

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

type: int

Static Constant.

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

type: int
raw docstring

*-southeastclj

Static Constant.

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

type: int

Static Constant.

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

type: int
raw docstring

*-southwestclj

Static Constant.

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

type: int

Static Constant.

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

type: int
raw docstring

*-verticalclj

Static Constant.

Resize the component vertically but not horizontally.

type: int

Static Constant.

Resize the component vertically but not horizontally.

type: int
raw docstring

*-westclj

Static Constant.

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

type: int

Static Constant.

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

type: int
raw docstring

->grid-bag-constraintsclj

(->grid-bag-constraints)
(->grid-bag-constraints gridx
                        gridy
                        gridwidth
                        gridheight
                        weightx
                        weighty
                        anchor
                        fill
                        insets
                        ipadx
                        ipady)

Constructor.

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. - int gridy - The initial gridy value. - int gridwidth - The initial gridwidth value. - int gridheight - The initial gridheight value. - int weightx - The initial weightx value. - double weighty - The initial weighty value. - double anchor - The initial anchor value. - int fill - The initial fill value. - int insets - The initial insets value. - java.awt.Insets ipadx - The initial ipadx value. - int ipady - The initial ipady value. - int

Constructor.

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. - `int`
gridy - The initial gridy value. - `int`
gridwidth - The initial gridwidth value. - `int`
gridheight - The initial gridheight value. - `int`
weightx - The initial weightx value. - `double`
weighty - The initial weighty value. - `double`
anchor - The initial anchor value. - `int`
fill - The initial fill value. - `int`
insets - The initial insets value. - `java.awt.Insets`
ipadx - The initial ipadx value. - `int`
ipady - The initial ipady value. - `int`
raw docstring

anchorclj

(anchor this)

Instance Field.

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 relative 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.

type: int

Instance Field.

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 relative 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.

type: int
raw docstring

cloneclj

(clone this)

Creates a copy of this grid bag constraint.

returns: a copy of this grid bag constraint - java.lang.Object

Creates a copy of this grid bag constraint.

returns: a copy of this grid bag constraint - `java.lang.Object`
raw docstring

fillclj

(fill this)

Instance Field.

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.

type: int

Instance Field.

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.

type: int
raw docstring

gridheightclj

(gridheight this)

Instance Field.

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.

type: int

Instance Field.

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.

type: int
raw docstring

gridwidthclj

(gridwidth this)

Instance Field.

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.

type: int

Instance Field.

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.

type: int
raw docstring

gridxclj

(gridx this)

Instance Field.

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.

type: int

Instance Field.

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.

type: int
raw docstring

gridyclj

(gridy this)

Instance Field.

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.

type: int

Instance Field.

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.

type: int
raw docstring

insetsclj

(insets this)

Instance Field.

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).

type: java.awt.Insets

Instance Field.

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).

type: java.awt.Insets
raw docstring

ipadxclj

(ipadx this)

Instance Field.

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 ipadx pixels.

The default value is 0.

type: int

Instance Field.

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
 ipadx pixels.

 The default value is 0.

type: int
raw docstring

ipadyclj

(ipady this)

Instance Field.

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 ipady pixels.

The default value is 0.

type: int

Instance Field.

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
 ipady pixels.

 The default value is 0.

type: int
raw docstring

weightxclj

(weightx this)

Instance Field.

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.

type: double

Instance Field.

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.

type: double
raw docstring

weightyclj

(weighty this)

Instance Field.

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.

type: double

Instance Field.

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.

type: double
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close