Overview
Package
Class
Use
Tree
Deprecated
Index
All Classes
Help
Prev Class
Next Class
Sample
Document
Class java.awt.GridBagConstraints
Inherited members: ShowHide
Deprecated: ShowHide
View: ClientSubclassPackageImplementation
java.awt

Class GridBagConstraints

  • java.lang.Object
    • java.awt.GridBagConstraints
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class GridBagConstraints extends java.lang.Object implements java.lang.Cloneable, java.io.Serializable
    The GridBagConstraints class specifies constraints for components that are laid out using the GridBagLayout class.
    Since:
    JDK1.0
    See Also:
    GridBagLayout, Serialized Form
    • Fields 
      Modifier and Type Field and Description
      Ordinary member indicator ABOVE_BASELINE Reveal DetailHide Detail
      static int ABOVE_BASELINE
      Possible value for the anchor field.
      public static final int ABOVE_BASELINE
      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.
      Since:
      1.6
      See Also:
      Constant Field Values
      Ordinary member indicator ABOVE_BASELINE_LEADING Reveal DetailHide Detail
      static int ABOVE_BASELINE_LEADING
      Possible value for the anchor field.
      public static final int ABOVE_BASELINE_LEADING
      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.
      Since:
      1.6
      See Also:
      Constant Field Values
      Ordinary member indicator ABOVE_BASELINE_TRAILING Reveal DetailHide Detail
      static int ABOVE_BASELINE_TRAILING
      Possible value for the anchor field.
      public static final int ABOVE_BASELINE_TRAILING
      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.
      Since:
      1.6
      See Also:
      Constant Field Values
      Ordinary member indicator anchor Reveal DetailHide Detail
      int anchor
      This field is used when the component is smaller than its display area.
      public int anchor
      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.

      See Also:
      clone(), ComponentOrientation
      Ordinary member indicator BASELINE Reveal DetailHide Detail
      static int BASELINE
      Possible value for the anchor field.
      public static final int BASELINE
      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.
      Since:
      1.6
      See Also:
      Constant Field Values
      Ordinary member indicator BASELINE_LEADING Reveal DetailHide Detail
      static int BASELINE_LEADING
      Possible value for the anchor field.
      public static final int BASELINE_LEADING
      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.
      Since:
      1.6
      See Also:
      Constant Field Values
      Ordinary member indicator BASELINE_TRAILING Reveal DetailHide Detail
      static int BASELINE_TRAILING
      Possible value for the anchor field.
      public static final int BASELINE_TRAILING
      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.
      Since:
      1.6
      See Also:
      Constant Field Values
      Ordinary member indicator BELOW_BASELINE Reveal DetailHide Detail
      static int BELOW_BASELINE
      Possible value for the anchor field.
      public static final int BELOW_BASELINE
      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.
      Since:
      1.6
      See Also:
      Constant Field Values
      Ordinary member indicator BELOW_BASELINE_LEADING Reveal DetailHide Detail
      static int BELOW_BASELINE_LEADING
      Possible value for the anchor field.
      public static final int BELOW_BASELINE_LEADING
      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.
      Since:
      1.6
      See Also:
      Constant Field Values
      Ordinary member indicator BELOW_BASELINE_TRAILING Reveal DetailHide Detail
      static int BELOW_BASELINE_TRAILING
      Possible value for the anchor field.
      public static final int BELOW_BASELINE_TRAILING
      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.
      Since:
      1.6
      See Also:
      Constant Field Values
      Ordinary member indicator BOTH Reveal DetailHide Detail
      static int BOTH
      Resize the component both horizontally and vertically.
      public static final int BOTH
      Resize the component both horizontally and vertically.
      See Also:
      Constant Field Values
      Ordinary member indicator CENTER Reveal DetailHide Detail
      static int CENTER
      Put the component in the center of its display area.
      public static final int CENTER
      Put the component in the center of its display area.
      See Also:
      Constant Field Values
      Ordinary member indicator EAST Reveal DetailHide Detail
      static int EAST
      Put the component on the right side of its display area, centered vertically.
      public static final int EAST
      Put the component on the right side of its display area, centered vertically.
      See Also:
      Constant Field Values
      Ordinary member indicator fill Reveal DetailHide Detail
      int fill
      This field is used when the component's display area is larger than the component's requested size.
      public int fill
      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.

      See Also:
      clone()
      Ordinary member indicator FIRST_LINE_END Reveal DetailHide Detail
      static 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 ComponentOrientation.
      public static final 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 ComponentOrientation. Equal to NORTHEAST for horizontal, left-to-right orientations and NORTHWEST for horizontal, right-to-left orientations.
      See Also:
      Constant Field Values
      Ordinary member indicator FIRST_LINE_START Reveal DetailHide Detail
      static 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 ComponentOrientation.
      public static final 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 ComponentOrientation. Equal to NORTHWEST for horizontal, left-to-right orientations and NORTHEAST for horizontal, right-to-left orientations.
      See Also:
      Constant Field Values
      Ordinary member indicator gridheight Reveal DetailHide Detail
      int gridheight
      Specifies the number of cells in a column for the component's display area.
      public int gridheight
      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.

      See Also:
      clone(), gridwidth
      Ordinary member indicator gridwidth Reveal DetailHide Detail
      int gridwidth
      Specifies the number of cells in a row for the component's display area.
      public int gridwidth
      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.

      See Also:
      clone(), gridheight
      Ordinary member indicator gridx Reveal DetailHide Detail
      int gridx
      Specifies the cell containing the leading edge of the component's display area, where the first cell in a row has gridx=0.
      public int gridx
      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.

      See Also:
      clone(), gridy, ComponentOrientation
      Ordinary member indicator gridy Reveal DetailHide Detail
      int gridy
      Specifies the cell at the top of the component's display area, where the topmost cell has gridy=0.
      public int gridy
      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.

      See Also:
      clone(), gridx
      Ordinary member indicator HORIZONTAL Reveal DetailHide Detail
      static int HORIZONTAL
      Resize the component horizontally but not vertically.
      public static final int HORIZONTAL
      Resize the component horizontally but not vertically.
      See Also:
      Constant Field Values
      Ordinary member indicator insets Reveal DetailHide Detail
      Insets 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.
      public Insets 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:
      clone()
      Ordinary member indicator ipadx Reveal DetailHide Detail
      int ipadx
      This field specifies the internal padding of the component, how much space to add to the minimum width of the component.
      public int ipadx
      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.

      See Also:
      clone(), ipady
      Ordinary member indicator ipady Reveal DetailHide Detail
      int ipady
      This field specifies the internal padding, that is, how much space to add to the minimum height of the component.
      public int ipady
      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.

      See Also:
      clone(), ipadx
      Ordinary member indicator LAST_LINE_END Reveal DetailHide Detail
      static 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 ComponentOrientation.
      public static final 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 ComponentOrientation. Equal to SOUTHEAST for horizontal, left-to-right orientations and SOUTHWEST for horizontal, right-to-left orientations.
      See Also:
      Constant Field Values
      Ordinary member indicator LAST_LINE_START Reveal DetailHide Detail
      static 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 ComponentOrientation.
      public static final 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 ComponentOrientation. Equal to SOUTHWEST for horizontal, left-to-right orientations and SOUTHEAST for horizontal, right-to-left orientations.
      See Also:
      Constant Field Values
      Ordinary member indicator LINE_END Reveal DetailHide Detail
      static int LINE_END
      Place the component centered along the edge of its display area where lines of text would normally end for the current ComponentOrientation.
      public static final int LINE_END
      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.
      See Also:
      Constant Field Values
      Ordinary member indicator LINE_START Reveal DetailHide Detail
      static int LINE_START
      Place the component centered along the edge of its display area where lines of text would normally begin for the current ComponentOrientation.
      public static final int LINE_START
      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.
      See Also:
      Constant Field Values
      Ordinary member indicator NONE Reveal DetailHide Detail
      static int NONE
      Do not resize the component.
      public static final int NONE
      Do not resize the component.
      See Also:
      Constant Field Values
      Ordinary member indicator NORTH Reveal DetailHide Detail
      static int NORTH
      Put the component at the top of its display area, centered horizontally.
      public static final int NORTH
      Put the component at the top of its display area, centered horizontally.
      See Also:
      Constant Field Values
      Ordinary member indicator NORTHEAST Reveal DetailHide Detail
      static int NORTHEAST
      Put the component at the top-right corner of its display area.
      public static final int NORTHEAST
      Put the component at the top-right corner of its display area.
      See Also:
      Constant Field Values
      Ordinary member indicator NORTHWEST Reveal DetailHide Detail
      static int NORTHWEST
      Put the component at the top-left corner of its display area.
      public static final int NORTHWEST
      Put the component at the top-left corner of its display area.
      See Also:
      Constant Field Values
      Ordinary member indicator PAGE_END Reveal DetailHide Detail
      static int PAGE_END
      Place the component centered along the edge of its display area associated with the end of a page for the current ComponentOrientation.
      public static final int PAGE_END
      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.
      See Also:
      Constant Field Values
      Ordinary member indicator PAGE_START Reveal DetailHide Detail
      static int PAGE_START
      Place the component centered along the edge of its display area associated with the start of a page for the current ComponentOrientation.
      public static final int PAGE_START
      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.
      See Also:
      Constant Field Values
      Ordinary member indicator RELATIVE Reveal DetailHide Detail
      static 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).
      public static final 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).
      See Also:
      gridwidth, gridheight, gridx, gridy, Constant Field Values
      Ordinary member indicator REMAINDER Reveal DetailHide Detail
      static int REMAINDER
      Specifies that this component is the last component in its column or row.
      public static final int REMAINDER
      Specifies that this component is the last component in its column or row.
      See Also:
      Constant Field Values
      Ordinary member indicator SOUTH Reveal DetailHide Detail
      static int SOUTH
      Put the component at the bottom of its display area, centered horizontally.
      public static final int SOUTH
      Put the component at the bottom of its display area, centered horizontally.
      See Also:
      Constant Field Values
      Ordinary member indicator SOUTHEAST Reveal DetailHide Detail
      static int SOUTHEAST
      Put the component at the bottom-right corner of its display area.
      public static final int SOUTHEAST
      Put the component at the bottom-right corner of its display area.
      See Also:
      Constant Field Values
      Ordinary member indicator SOUTHWEST Reveal DetailHide Detail
      static int SOUTHWEST
      Put the component at the bottom-left corner of its display area.
      public static final int SOUTHWEST
      Put the component at the bottom-left corner of its display area.
      See Also:
      Constant Field Values
      Ordinary member indicator VERTICAL Reveal DetailHide Detail
      static int VERTICAL
      Resize the component vertically but not horizontally.
      public static final int VERTICAL
      Resize the component vertically but not horizontally.
      See Also:
      Constant Field Values
      Ordinary member indicator weightx Reveal DetailHide Detail
      double weightx
      Specifies how to distribute extra horizontal space.
      public double weightx
      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.

      See Also:
      clone(), weighty
      Ordinary member indicator weighty Reveal DetailHide Detail
      double weighty
      Specifies how to distribute extra vertical space.
      public double weighty
      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.

      See Also:
      clone(), weightx
      Ordinary member indicator WEST Reveal DetailHide Detail
      static int WEST
      Put the component on the left side of its display area, centered vertically.
      public static final int WEST
      Put the component on the left side of its display area, centered vertically.
      See Also:
      Constant Field Values
    • Constructors 
      Constructor and Description
      Ordinary member indicator GridBagConstraints Reveal DetailHide Detail
      GridBagConstraints()
      Creates a GridBagConstraint object with all of its fields set to their default value.
      public GridBagConstraints()
      Creates a GridBagConstraint object with all of its fields set to their default value.
      Ordinary member indicator GridBagConstraints Reveal DetailHide Detail
      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 GridBagConstraints object with all of its fields set to the passed-in arguments.
      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 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.
      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:
      gridx, gridy, gridwidth, gridheight, weightx, weighty, anchor, fill, insets, ipadx, ipady
    • Methods 
      Modifier and Type Method and Description
      Overridden member indicator clone Reveal DetailHide Detail
      java.lang.Object clone()
      Creates a copy of this grid bag constraint.
      public java.lang.Object clone()
      Creates a copy of this grid bag constraint.
      Overrides:
      clone in class java.lang.Object
      Returns:
      a copy of this grid bag constraint
      See Also:
      Cloneable
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
This document was created by Dulcet from the OpenJDK sources. Copyright © 1993, 2012 Oracle and/or its affiliates. All rights reserved.

SourceForge