java.awt
Class GridBagLayout

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.awt.GridBagLayout
All Implemented Interfaces:
LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager , LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2 , Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public class GridBagLayout
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2 , Serializable sample code for java.io.Serializable definition code for java.io.Serializable

The GridBagLayout class is a flexible layout manager that aligns components vertically and horizontally, without requiring that the components be of the same size. Each GridBagLayout object maintains a dynamic, rectangular grid of cells, with each component occupying one or more cells, called its display area.

Each component managed by a GridBagLayout is associated with an instance of GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints . The constraints object specifies where a component's display area should be located on the grid and how the component should be positioned within its display area. In addition to its constraints object, the GridBagLayout also considers each component's minimum and preferred sizes in order to determine a component's size.

The overall orientation of the grid depends on the container's ComponentOrientation sample code for java.awt.ComponentOrientation definition code for java.awt.ComponentOrientation property. For horizontal left-to-right orientations, grid coordinate (0,0) is in the upper left corner of the container with x increasing to the right and y increasing downward. For horizontal right-to-left orientations, grid coordinate (0,0) is in the upper right corner of the container with x increasing to the left and y increasing downward.

To use a grid bag layout effectively, you must customize one or more of the GridBagConstraints objects that are associated with its components. You customize a GridBagConstraints object by setting one or more of its instance variables:

GridBagConstraints.gridx sample code for java.awt.GridBagConstraints.gridx definition code for java.awt.GridBagConstraints.gridx , GridBagConstraints.gridy sample code for java.awt.GridBagConstraints.gridy definition code for java.awt.GridBagConstraints.gridy
Specifies the cell containing the leading corner of the component's display area, where the cell at the origin of the grid has address gridx = 0, gridy = 0. For horizontal left-to-right layout, a component's leading corner is its upper left. For horizontal right-to-left layout, a component's leading corner is its upper right. Use GridBagConstraints.RELATIVE (the default value) to specify that the component be placed immediately following (along the x axis for gridx or the y axis for gridy) the component that was added to the container just before this component was added.
GridBagConstraints.gridwidth sample code for java.awt.GridBagConstraints.gridwidth definition code for java.awt.GridBagConstraints.gridwidth , GridBagConstraints.gridheight sample code for java.awt.GridBagConstraints.gridheight definition code for java.awt.GridBagConstraints.gridheight
Specifies the number of cells in a row (for gridwidth) or column (for gridheight) in the component's display area. The default value is 1. Use GridBagConstraints.REMAINDER to specify that the component's display area will be from gridx to the last cell in the row (for gridwidth) or from gridy to the last cell in the column (for gridheight). Use GridBagConstraints.RELATIVE to specify that the component's display area will be from gridx to the next to the last cell in its row (for gridwidth or from gridy to the next to the last cell in its column (for gridheight).
GridBagConstraints.fill sample code for java.awt.GridBagConstraints.fill definition code for java.awt.GridBagConstraints.fill
Used when the component's display area is larger than the component's requested size to determine whether (and how) to resize the component. Possible values are GridBagConstraints.NONE (the default), GridBagConstraints.HORIZONTAL (make the component wide enough to fill its display area horizontally, but don't change its height), GridBagConstraints.VERTICAL (make the component tall enough to fill its display area vertically, but don't change its width), and GridBagConstraints.BOTH (make the component fill its display area entirely).
GridBagConstraints.ipadx sample code for java.awt.GridBagConstraints.ipadx definition code for java.awt.GridBagConstraints.ipadx , GridBagConstraints.ipady sample code for java.awt.GridBagConstraints.ipady definition code for java.awt.GridBagConstraints.ipady
Specifies the component's internal padding within the layout, how much to add to the minimum size of the component. The width of the component will be at least its minimum width plus ipadx pixels. Similarly, the height of the component will be at least the minimum height plus ipady pixels.
GridBagConstraints.insets sample code for java.awt.GridBagConstraints.insets definition code for java.awt.GridBagConstraints.insets
Specifies the component's external padding, the minimum amount of space between the component and the edges of its display area.
GridBagConstraints.anchor sample code for java.awt.GridBagConstraints.anchor definition code for java.awt.GridBagConstraints.anchor
Used when the component is smaller than its display area to determine where (within the display area) to place the component. There are two kinds of possible values: relative and absolute. Relative values are interpreted relative to the container's ComponentOrientation property while absolute values are not. Valid values are:

Absolute Values

Relative Values

  • GridBagConstraints.NORTH
  • GridBagConstraints.SOUTH
  • GridBagConstraints.WEST
  • GridBagConstraints.EAST
  • GridBagConstraints.NORTHWEST
  • GridBagConstraints.NORTHEAST
  • GridBagConstraints.SOUTHWEST
  • GridBagConstraints.SOUTHEAST
  • GridBagConstraints.CENTER (the default)
  • GridBagConstraints.PAGE_START
  • GridBagConstraints.PAGE_END
  • GridBagConstraints.LINE_START
  • GridBagConstraints.LINE_END
  • GridBagConstraints.FIRST_LINE_START
  • GridBagConstraints.FIRST_LINE_END
  • GridBagConstraints.LAST_LINE_START
  • GridBagConstraints.LAST_LINE_END
  • GridBagConstraints.weightx sample code for java.awt.GridBagConstraints.weightx definition code for java.awt.GridBagConstraints.weightx , GridBagConstraints.weighty sample code for java.awt.GridBagConstraints.weighty definition code for java.awt.GridBagConstraints.weighty
    Used to determine how to distribute space, which is important for specifying resizing behavior. Unless you specify a weight for at least one component in a row (weightx) and column (weighty), all the components clump together in the center of their container. This is because when the weight is zero (the default), the GridBagLayout object puts any extra space between its grid of cells and the edges of the container.

    The following figures show ten components (all buttons) managed by a grid bag layout. Figure 1 shows the layout for a horizontal, left-to-right container and Figure 2 shows the layout for a horizontal, right-to-left container.

    The preceeding text describes this graphic (Figure 1). The preceeding text describes this graphic (Figure 2).
    Figure 1: Horizontal, Left-to-Right Figure 2: Horizontal, Right-to-Left

    Each of the ten components has the fill field of its associated GridBagConstraints object set to GridBagConstraints.BOTH. In addition, the components have the following non-default constraints:

    Here is the code that implements the example shown above:


     import java.awt.*;
     import java.util.*;
     import java.applet.Applet;
    
     public class GridBagEx1 extends Applet {
    
         protected void makebutton(String name,
                                   GridBagLayout gridbag,
                                   GridBagConstraints c) {
             Button button = new Button(name);
             gridbag.setConstraints(button, c);
             add(button);
         }
    
         public void init() {
             GridBagLayout gridbag = new GridBagLayout();
             GridBagConstraints c = new GridBagConstraints();
    
             setFont(new Font("SansSerif", Font.PLAIN, 14));
             setLayout(gridbag);
    
             c.fill = GridBagConstraints.BOTH;
             c.weightx = 1.0;
             makebutton("Button1", gridbag, c);
             makebutton("Button2", gridbag, c);
             makebutton("Button3", gridbag, c);
    
               c.gridwidth = GridBagConstraints.REMAINDER; //end row
             makebutton("Button4", gridbag, c);
    
             c.weightx = 0.0;                  //reset to the default
             makebutton("Button5", gridbag, c); //another row
    
               c.gridwidth = GridBagConstraints.RELATIVE; //next-to-last in row
             makebutton("Button6", gridbag, c);
    
               c.gridwidth = GridBagConstraints.REMAINDER; //end row
             makebutton("Button7", gridbag, c);
    
               c.gridwidth = 1;                //reset to the default
               c.gridheight = 2;
             c.weighty = 1.0;
             makebutton("Button8", gridbag, c);
    
             c.weighty = 0.0;                  //reset to the default
               c.gridwidth = GridBagConstraints.REMAINDER; //end row
               c.gridheight = 1;               //reset to the default
             makebutton("Button9", gridbag, c);
             makebutton("Button10", gridbag, c);
    
             setSize(300, 100);
         }
    
         public static void main(String args[]) {
               Frame f = new Frame("GridBag Layout Example");
               GridBagEx1 ex1 = new GridBagEx1();
    
               ex1.init();
    
               f.add("Center", ex1);
               f.pack();
               f.setSize(f.getPreferredSize());
               f.show();
         }
     }
     

    Since:
    JDK1.0
    See Also:
    GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints , ComponentOrientation sample code for java.awt.ComponentOrientation definition code for java.awt.ComponentOrientation , Serialized Form

    Field Summary
     double[] columnWeights sample code for java.awt.GridBagLayout.columnWeights definition code for java.awt.GridBagLayout.columnWeights
              This field holds the overrides to the column weights.
     int[] columnWidths sample code for java.awt.GridBagLayout.columnWidths definition code for java.awt.GridBagLayout.columnWidths
              This field holds the overrides to the column minimum width.
    protected  Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable <Component sample code for java.awt.Component definition code for java.awt.Component ,GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints > comptable sample code for java.awt.GridBagLayout.comptable definition code for java.awt.GridBagLayout.comptable
              This hashtable maintains the association between a component and its gridbag constraints.
    protected  GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints defaultConstraints sample code for java.awt.GridBagLayout.defaultConstraints definition code for java.awt.GridBagLayout.defaultConstraints
              This field holds a gridbag constraints instance containing the default values, so if a component does not have gridbag constraints associated with it, then the component will be assigned a copy of the defaultConstraints.
    protected  java.awt.GridBagLayoutInfo layoutInfo sample code for java.awt.GridBagLayout.layoutInfo definition code for java.awt.GridBagLayout.layoutInfo
              This field holds the layout information for the gridbag.
    protected static int MAXGRIDSIZE sample code for java.awt.GridBagLayout.MAXGRIDSIZE definition code for java.awt.GridBagLayout.MAXGRIDSIZE
               
    protected static int MINSIZE sample code for java.awt.GridBagLayout.MINSIZE definition code for java.awt.GridBagLayout.MINSIZE
              The smallest grid that can be laid out by the grid bag layout.
    protected static int PREFERREDSIZE sample code for java.awt.GridBagLayout.PREFERREDSIZE definition code for java.awt.GridBagLayout.PREFERREDSIZE
              The preferred grid size that can be laid out by the grid bag layout.
     int[] rowHeights sample code for java.awt.GridBagLayout.rowHeights definition code for java.awt.GridBagLayout.rowHeights
              This field holds the overrides to the row minimum heights.
     double[] rowWeights sample code for java.awt.GridBagLayout.rowWeights definition code for java.awt.GridBagLayout.rowWeights
              This field holds the overrides to the row weights.
     
    Constructor Summary
    GridBagLayout sample code for java.awt.GridBagLayout.GridBagLayout() definition code for java.awt.GridBagLayout.GridBagLayout() ()
              Creates a grid bag layout manager.
     
    Method Summary
     void addLayoutComponent sample code for java.awt.GridBagLayout.addLayoutComponent(java.awt.Component, java.lang.Object) definition code for java.awt.GridBagLayout.addLayoutComponent(java.awt.Component, java.lang.Object) (Component sample code for java.awt.Component definition code for java.awt.Component  comp, Object sample code for java.lang.Object definition code for java.lang.Object  constraints)
              Adds the specified component to the layout, using the specified constraints object.
     void addLayoutComponent sample code for java.awt.GridBagLayout.addLayoutComponent(java.lang.String, java.awt.Component) definition code for java.awt.GridBagLayout.addLayoutComponent(java.lang.String, java.awt.Component) (String sample code for java.lang.String definition code for java.lang.String  name, Component sample code for java.awt.Component definition code for java.awt.Component  comp)
              Has no effect, since this layout manager does not use a per-component string.
    protected  void adjustForGravity sample code for java.awt.GridBagLayout.adjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) definition code for java.awt.GridBagLayout.adjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) (GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints  constraints, Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  r)
              Adjusts the x, y, width, and height fields to the correct values depending on the constraint geometry and pads.
    protected  void AdjustForGravity sample code for java.awt.GridBagLayout.AdjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) definition code for java.awt.GridBagLayout.AdjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) (GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints  constraints, Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  r)
              This method is obsolete and supplied for backwards compatability only; new code should call adjustForGravity sample code for java.awt.GridBagLayout.adjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) definition code for java.awt.GridBagLayout.adjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) instead.
    protected  void arrangeGrid sample code for java.awt.GridBagLayout.arrangeGrid(java.awt.Container) definition code for java.awt.GridBagLayout.arrangeGrid(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  parent)
              Lays out the grid.
    protected  void ArrangeGrid sample code for java.awt.GridBagLayout.ArrangeGrid(java.awt.Container) definition code for java.awt.GridBagLayout.ArrangeGrid(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  parent)
              This method is obsolete and supplied for backwards compatability only; new code should call arrangeGrid sample code for java.awt.GridBagLayout.arrangeGrid(java.awt.Container) definition code for java.awt.GridBagLayout.arrangeGrid(java.awt.Container) instead.
     GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints getConstraints sample code for java.awt.GridBagLayout.getConstraints(java.awt.Component) definition code for java.awt.GridBagLayout.getConstraints(java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  comp)
              Gets the constraints for the specified component.
     float getLayoutAlignmentX sample code for java.awt.GridBagLayout.getLayoutAlignmentX(java.awt.Container) definition code for java.awt.GridBagLayout.getLayoutAlignmentX(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  parent)
              Returns the alignment along the x axis.
     float getLayoutAlignmentY sample code for java.awt.GridBagLayout.getLayoutAlignmentY(java.awt.Container) definition code for java.awt.GridBagLayout.getLayoutAlignmentY(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  parent)
              Returns the alignment along the y axis.
     int[][] getLayoutDimensions sample code for java.awt.GridBagLayout.getLayoutDimensions() definition code for java.awt.GridBagLayout.getLayoutDimensions() ()
              Determines column widths and row heights for the layout grid.
    protected  java.awt.GridBagLayoutInfo getLayoutInfo sample code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int) definition code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int) (Container sample code for java.awt.Container definition code for java.awt.Container  parent, int sizeflag)
              Fills in an instance of GridBagLayoutInfo for the current set of managed children.
    protected  java.awt.GridBagLayoutInfo GetLayoutInfo sample code for java.awt.GridBagLayout.GetLayoutInfo(java.awt.Container, int) definition code for java.awt.GridBagLayout.GetLayoutInfo(java.awt.Container, int) (Container sample code for java.awt.Container definition code for java.awt.Container  parent, int sizeflag)
              This method is obsolete and supplied for backwards compatability only; new code should call getLayoutInfo sample code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int) definition code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int) instead.
     Point sample code for java.awt.Point definition code for java.awt.Point getLayoutOrigin sample code for java.awt.GridBagLayout.getLayoutOrigin() definition code for java.awt.GridBagLayout.getLayoutOrigin() ()
              Determines the origin of the layout area, in the graphics coordinate space of the target container.
     double[][] getLayoutWeights sample code for java.awt.GridBagLayout.getLayoutWeights() definition code for java.awt.GridBagLayout.getLayoutWeights() ()
              Determines the weights of the layout grid's columns and rows.
    protected  Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension getMinSize sample code for java.awt.GridBagLayout.getMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) definition code for java.awt.GridBagLayout.getMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) (Container sample code for java.awt.Container definition code for java.awt.Container  parent, java.awt.GridBagLayoutInfo info)
              Figures out the minimum size of the master based on the information from getLayoutInfo.
    protected  Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension GetMinSize sample code for java.awt.GridBagLayout.GetMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) definition code for java.awt.GridBagLayout.GetMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) (Container sample code for java.awt.Container definition code for java.awt.Container  parent, java.awt.GridBagLayoutInfo info)
              This method is obsolete and supplied for backwards compatability only; new code should call getMinSize sample code for java.awt.GridBagLayout.getMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) definition code for java.awt.GridBagLayout.getMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) instead.
     void invalidateLayout sample code for java.awt.GridBagLayout.invalidateLayout(java.awt.Container) definition code for java.awt.GridBagLayout.invalidateLayout(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  target)
              Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.
     void layoutContainer sample code for java.awt.GridBagLayout.layoutContainer(java.awt.Container) definition code for java.awt.GridBagLayout.layoutContainer(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  parent)
              Lays out the specified container using this grid bag layout.
     Point sample code for java.awt.Point definition code for java.awt.Point location sample code for java.awt.GridBagLayout.location(int, int) definition code for java.awt.GridBagLayout.location(int, int) (int x, int y)
              Determines which cell in the layout grid contains the point specified by (x, y).
    protected  GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints lookupConstraints sample code for java.awt.GridBagLayout.lookupConstraints(java.awt.Component) definition code for java.awt.GridBagLayout.lookupConstraints(java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  comp)
              Retrieves the constraints for the specified component.
     Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension maximumLayoutSize sample code for java.awt.GridBagLayout.maximumLayoutSize(java.awt.Container) definition code for java.awt.GridBagLayout.maximumLayoutSize(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  target)
              Returns the maximum dimensions for this layout given the components in the specified target container.
     Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension minimumLayoutSize sample code for java.awt.GridBagLayout.minimumLayoutSize(java.awt.Container) definition code for java.awt.GridBagLayout.minimumLayoutSize(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  parent)
              Determines the minimum size of the parent container using this grid bag layout.
     Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension preferredLayoutSize sample code for java.awt.GridBagLayout.preferredLayoutSize(java.awt.Container) definition code for java.awt.GridBagLayout.preferredLayoutSize(java.awt.Container) (Container sample code for java.awt.Container definition code for java.awt.Container  parent)
              Determines the preferred size of the parent container using this grid bag layout.
     void removeLayoutComponent sample code for java.awt.GridBagLayout.removeLayoutComponent(java.awt.Component) definition code for java.awt.GridBagLayout.removeLayoutComponent(java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  comp)
              Removes the specified component from this layout.
     void setConstraints sample code for java.awt.GridBagLayout.setConstraints(java.awt.Component, java.awt.GridBagConstraints) definition code for java.awt.GridBagLayout.setConstraints(java.awt.Component, java.awt.GridBagConstraints) (Component sample code for java.awt.Component definition code for java.awt.Component  comp, GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints  constraints)
              Sets the constraints for the specified component in this layout.
     String sample code for java.lang.String definition code for java.lang.String toString sample code for java.awt.GridBagLayout.toString() definition code for java.awt.GridBagLayout.toString() ()
              Returns a string representation of this grid bag layout's values.
     
    Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
    clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
     

    Field Detail

    MAXGRIDSIZE sample code for java.awt.GridBagLayout.MAXGRIDSIZE

    protected static final int MAXGRIDSIZE
    See Also:
    Constant Field Values

    MINSIZE sample code for java.awt.GridBagLayout.MINSIZE

    protected static final int MINSIZE
    The smallest grid that can be laid out by the grid bag layout.

    See Also:
    Constant Field Values

    PREFERREDSIZE sample code for java.awt.GridBagLayout.PREFERREDSIZE

    protected static final int PREFERREDSIZE
    The preferred grid size that can be laid out by the grid bag layout.

    See Also:
    Constant Field Values

    comptable sample code for java.awt.GridBagLayout.comptable

    protected Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable <Component sample code for java.awt.Component definition code for java.awt.Component ,GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints > comptable
    This hashtable maintains the association between a component and its gridbag constraints. The Keys in comptable are the components and the values are the instances of GridBagConstraints.

    See Also:
    GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints

    defaultConstraints sample code for java.awt.GridBagLayout.defaultConstraints

    protected GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints  defaultConstraints
    This field holds a gridbag constraints instance containing the default values, so if a component does not have gridbag constraints associated with it, then the component will be assigned a copy of the defaultConstraints.

    See Also:
    getConstraints(Component) sample code for java.awt.GridBagLayout.getConstraints(java.awt.Component) definition code for java.awt.GridBagLayout.getConstraints(java.awt.Component) , setConstraints(Component, GridBagConstraints) sample code for java.awt.GridBagLayout.setConstraints(java.awt.Component, java.awt.GridBagConstraints) definition code for java.awt.GridBagLayout.setConstraints(java.awt.Component, java.awt.GridBagConstraints) , lookupConstraints(Component) sample code for java.awt.GridBagLayout.lookupConstraints(java.awt.Component) definition code for java.awt.GridBagLayout.lookupConstraints(java.awt.Component)

    layoutInfo sample code for java.awt.GridBagLayout.layoutInfo

    protected java.awt.GridBagLayoutInfo layoutInfo
    This field holds the layout information for the gridbag. The information in this field is based on the most recent validation of the gridbag. If layoutInfo is null this indicates that there are no components in the gridbag or if there are components, they have not yet been validated.

    See Also:
    getLayoutInfo(Container, int) sample code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int) definition code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int)

    columnWidths sample code for java.awt.GridBagLayout.columnWidths

    public int[] columnWidths
    This field holds the overrides to the column minimum width. If this field is non-null the values are applied to the gridbag after all of the minimum columns widths have been calculated. If columnWidths has more elements than the number of columns, columns are added to the gridbag to match the number of elements in columnWidth.

    See Also:
    getLayoutDimensions() sample code for java.awt.GridBagLayout.getLayoutDimensions() definition code for java.awt.GridBagLayout.getLayoutDimensions()

    rowHeights sample code for java.awt.GridBagLayout.rowHeights

    public int[] rowHeights
    This field holds the overrides to the row minimum heights. If this field is non-null the values are applied to the gridbag after all of the minimum row heights have been calculated. If rowHeights has more elements than the number of rows, rowa are added to the gridbag to match the number of elements in rowHeights.

    See Also:
    getLayoutDimensions() sample code for java.awt.GridBagLayout.getLayoutDimensions() definition code for java.awt.GridBagLayout.getLayoutDimensions()

    columnWeights sample code for java.awt.GridBagLayout.columnWeights

    public double[] columnWeights
    This field holds the overrides to the column weights. If this field is non-null the values are applied to the gridbag after all of the columns weights have been calculated. If columnWeights[i] > weight for column i, then column i is assigned the weight in columnWeights[i]. If columnWeights has more elements than the number of columns, the excess elements are ignored - they do not cause more columns to be created.


    rowWeights sample code for java.awt.GridBagLayout.rowWeights

    public double[] rowWeights
    This field holds the overrides to the row weights. If this field is non-null the values are applied to the gridbag after all of the rows weights have been calculated. If rowWeights[i] > weight for row i, then row i is assigned the weight in rowWeights[i]. If rowWeights has more elements than the number of rows, the excess elements are ignored - they do not cause more rows to be created.

    Constructor Detail

    GridBagLayout sample code for java.awt.GridBagLayout() definition code for java.awt.GridBagLayout()

    public GridBagLayout()
    Creates a grid bag layout manager.

    Method Detail

    setConstraints sample code for java.awt.GridBagLayout.setConstraints(java.awt.Component, java.awt.GridBagConstraints) definition code for java.awt.GridBagLayout.setConstraints(java.awt.Component, java.awt.GridBagConstraints)

    public void setConstraints(Component sample code for java.awt.Component definition code for java.awt.Component  comp,
                               GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints  constraints)
    Sets the constraints for the specified component in this layout.

    Parameters:
    comp - the component to be modified
    constraints - the constraints to be applied

    getConstraints sample code for java.awt.GridBagLayout.getConstraints(java.awt.Component) definition code for java.awt.GridBagLayout.getConstraints(java.awt.Component)

    public GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints  getConstraints(Component sample code for java.awt.Component definition code for java.awt.Component  comp)
    Gets the constraints for the specified component. A copy of the actual GridBagConstraints object is returned.

    Parameters:
    comp - the component to be queried
    Returns:
    the constraint for the specified component in this grid bag layout; a copy of the actual constraint object is returned

    lookupConstraints sample code for java.awt.GridBagLayout.lookupConstraints(java.awt.Component) definition code for java.awt.GridBagLayout.lookupConstraints(java.awt.Component)

    protected GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints  lookupConstraints(Component sample code for java.awt.Component definition code for java.awt.Component  comp)
    Retrieves the constraints for the specified component. The return value is not a copy, but is the actual GridBagConstraints object used by the layout mechanism.

    If comp is not in the GridBagLayout, a set of default GridBagConstraints are returned. A comp value of null is invalid and returns null.

    Parameters:
    comp - the component to be queried
    Returns:
    the contraints for the specified component

    getLayoutOrigin sample code for java.awt.GridBagLayout.getLayoutOrigin() definition code for java.awt.GridBagLayout.getLayoutOrigin()

    public Point sample code for java.awt.Point definition code for java.awt.Point  getLayoutOrigin()
    Determines the origin of the layout area, in the graphics coordinate space of the target container. This value represents the pixel coordinates of the top-left corner of the layout area regardless of the ComponentOrientation value of the container. This is distinct from the grid origin given by the cell coordinates (0,0). Most applications do not call this method directly.

    Returns:
    the graphics origin of the cell in the top-left corner of the layout grid
    Since:
    JDK1.1
    See Also:
    ComponentOrientation sample code for java.awt.ComponentOrientation definition code for java.awt.ComponentOrientation

    getLayoutDimensions sample code for java.awt.GridBagLayout.getLayoutDimensions() definition code for java.awt.GridBagLayout.getLayoutDimensions()

    public int[][] getLayoutDimensions()
    Determines column widths and row heights for the layout grid.

    Most applications do not call this method directly.

    Returns:
    an array of two arrays, containing the widths of the layout columns and the heights of the layout rows
    Since:
    JDK1.1

    getLayoutWeights sample code for java.awt.GridBagLayout.getLayoutWeights() definition code for java.awt.GridBagLayout.getLayoutWeights()

    public double[][] getLayoutWeights()
    Determines the weights of the layout grid's columns and rows. Weights are used to calculate how much a given column or row stretches beyond its preferred size, if the layout has extra room to fill.

    Most applications do not call this method directly.

    Returns:
    an array of two arrays, representing the horizontal weights of the layout columns and the vertical weights of the layout rows
    Since:
    JDK1.1

    location sample code for java.awt.GridBagLayout.location(int, int) definition code for java.awt.GridBagLayout.location(int, int)

    public Point sample code for java.awt.Point definition code for java.awt.Point  location(int x,
                          int y)
    Determines which cell in the layout grid contains the point specified by (x, y). Each cell is identified by its column index (ranging from 0 to the number of columns minus 1) and its row index (ranging from 0 to the number of rows minus 1).

    If the (x, y) point lies outside the grid, the following rules are used. The column index is returned as zero if x lies to the left of the layout for a left-to-right container or to the right of the layout for a right-to-left container. The column index is returned as the number of columns if x lies to the right of the layout in a left-to-right container or to the left in a right-to-left container. The row index is returned as zero if y lies above the layout, and as the number of rows if y lies below the layout. The orientation of a container is determined by its ComponentOrientation property.

    Parameters:
    x - the x coordinate of a point
    y - the y coordinate of a point
    Returns:
    an ordered pair of indexes that indicate which cell in the layout grid contains the point (xy).
    Since:
    JDK1.1
    See Also:
    ComponentOrientation sample code for java.awt.ComponentOrientation definition code for java.awt.ComponentOrientation

    addLayoutComponent sample code for java.awt.GridBagLayout.addLayoutComponent(java.lang.String, java.awt.Component) definition code for java.awt.GridBagLayout.addLayoutComponent(java.lang.String, java.awt.Component)

    public void addLayoutComponent(String sample code for java.lang.String definition code for java.lang.String  name,
                                   Component sample code for java.awt.Component definition code for java.awt.Component  comp)
    Has no effect, since this layout manager does not use a per-component string.

    Specified by:
    addLayoutComponent sample code for java.awt.LayoutManager.addLayoutComponent(java.lang.String, java.awt.Component) definition code for java.awt.LayoutManager.addLayoutComponent(java.lang.String, java.awt.Component) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager
    Parameters:
    name - the string to be associated with the component
    comp - the component to be added

    addLayoutComponent sample code for java.awt.GridBagLayout.addLayoutComponent(java.awt.Component, java.lang.Object) definition code for java.awt.GridBagLayout.addLayoutComponent(java.awt.Component, java.lang.Object)

    public void addLayoutComponent(Component sample code for java.awt.Component definition code for java.awt.Component  comp,
                                   Object sample code for java.lang.Object definition code for java.lang.Object  constraints)
    Adds the specified component to the layout, using the specified constraints object. Note that constraints are mutable and are, therefore, cloned when cached.

    Specified by:
    addLayoutComponent sample code for java.awt.LayoutManager2.addLayoutComponent(java.awt.Component, java.lang.Object) definition code for java.awt.LayoutManager2.addLayoutComponent(java.awt.Component, java.lang.Object) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2
    Parameters:
    comp - the component to be added
    constraints - an object that determines how the component is added to the layout
    Throws:
    IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if constraints is not a GridBagConstraint

    removeLayoutComponent sample code for java.awt.GridBagLayout.removeLayoutComponent(java.awt.Component) definition code for java.awt.GridBagLayout.removeLayoutComponent(java.awt.Component)

    public void removeLayoutComponent(Component sample code for java.awt.Component definition code for java.awt.Component  comp)
    Removes the specified component from this layout.

    Most applications do not call this method directly.

    Specified by:
    removeLayoutComponent sample code for java.awt.LayoutManager.removeLayoutComponent(java.awt.Component) definition code for java.awt.LayoutManager.removeLayoutComponent(java.awt.Component) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager
    Parameters:
    comp - the component to be removed.
    See Also:
    Container.remove(java.awt.Component) sample code for java.awt.Container.remove(java.awt.Component) definition code for java.awt.Container.remove(java.awt.Component) , Container.removeAll() sample code for java.awt.Container.removeAll() definition code for java.awt.Container.removeAll()

    preferredLayoutSize sample code for java.awt.GridBagLayout.preferredLayoutSize(java.awt.Container) definition code for java.awt.GridBagLayout.preferredLayoutSize(java.awt.Container)

    public Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension  preferredLayoutSize(Container sample code for java.awt.Container definition code for java.awt.Container  parent)
    Determines the preferred size of the parent container using this grid bag layout.

    Most applications do not call this method directly.

    Specified by:
    preferredLayoutSize sample code for java.awt.LayoutManager.preferredLayoutSize(java.awt.Container) definition code for java.awt.LayoutManager.preferredLayoutSize(java.awt.Container) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager
    Parameters:
    parent - the container in which to do the layout
    Returns:
    the preferred size of the parent container
    See Also:
    Container.getPreferredSize() sample code for java.awt.Container.getPreferredSize() definition code for java.awt.Container.getPreferredSize()

    minimumLayoutSize sample code for java.awt.GridBagLayout.minimumLayoutSize(java.awt.Container) definition code for java.awt.GridBagLayout.minimumLayoutSize(java.awt.Container)

    public Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension  minimumLayoutSize(Container sample code for java.awt.Container definition code for java.awt.Container  parent)
    Determines the minimum size of the parent container using this grid bag layout.

    Most applications do not call this method directly.

    Specified by:
    minimumLayoutSize sample code for java.awt.LayoutManager.minimumLayoutSize(java.awt.Container) definition code for java.awt.LayoutManager.minimumLayoutSize(java.awt.Container) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager
    Parameters:
    parent - the container in which to do the layout
    Returns:
    the minimum size of the parent container
    See Also:
    Container.doLayout() sample code for java.awt.Container.doLayout() definition code for java.awt.Container.doLayout()

    maximumLayoutSize sample code for java.awt.GridBagLayout.maximumLayoutSize(java.awt.Container) definition code for java.awt.GridBagLayout.maximumLayoutSize(java.awt.Container)

    public Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension  maximumLayoutSize(Container sample code for java.awt.Container definition code for java.awt.Container  target)
    Returns the maximum dimensions for this layout given the components in the specified target container.

    Specified by:
    maximumLayoutSize sample code for java.awt.LayoutManager2.maximumLayoutSize(java.awt.Container) definition code for java.awt.LayoutManager2.maximumLayoutSize(java.awt.Container) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2
    Parameters:
    target - the container which needs to be laid out
    Returns:
    the maximum dimensions for this layout
    See Also:
    Container sample code for java.awt.Container definition code for java.awt.Container , minimumLayoutSize(Container) sample code for java.awt.GridBagLayout.minimumLayoutSize(java.awt.Container) definition code for java.awt.GridBagLayout.minimumLayoutSize(java.awt.Container) , preferredLayoutSize(Container) sample code for java.awt.GridBagLayout.preferredLayoutSize(java.awt.Container) definition code for java.awt.GridBagLayout.preferredLayoutSize(java.awt.Container)

    getLayoutAlignmentX sample code for java.awt.GridBagLayout.getLayoutAlignmentX(java.awt.Container) definition code for java.awt.GridBagLayout.getLayoutAlignmentX(java.awt.Container)

    public float getLayoutAlignmentX(Container sample code for java.awt.Container definition code for java.awt.Container  parent)
    Returns the alignment along the x axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

    Specified by:
    getLayoutAlignmentX sample code for java.awt.LayoutManager2.getLayoutAlignmentX(java.awt.Container) definition code for java.awt.LayoutManager2.getLayoutAlignmentX(java.awt.Container) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2
    Returns:
    the value 0.5f to indicate centered

    getLayoutAlignmentY sample code for java.awt.GridBagLayout.getLayoutAlignmentY(java.awt.Container) definition code for java.awt.GridBagLayout.getLayoutAlignmentY(java.awt.Container)

    public float getLayoutAlignmentY(Container sample code for java.awt.Container definition code for java.awt.Container  parent)
    Returns the alignment along the y axis. This specifies how the component would like to be aligned relative to other components. The value should be a number between 0 and 1 where 0 represents alignment along the origin, 1 is aligned the furthest away from the origin, 0.5 is centered, etc.

    Specified by:
    getLayoutAlignmentY sample code for java.awt.LayoutManager2.getLayoutAlignmentY(java.awt.Container) definition code for java.awt.LayoutManager2.getLayoutAlignmentY(java.awt.Container) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2
    Returns:
    the value 0.5f to indicate centered

    invalidateLayout sample code for java.awt.GridBagLayout.invalidateLayout(java.awt.Container) definition code for java.awt.GridBagLayout.invalidateLayout(java.awt.Container)

    public void invalidateLayout(Container sample code for java.awt.Container definition code for java.awt.Container  target)
    Invalidates the layout, indicating that if the layout manager has cached information it should be discarded.

    Specified by:
    invalidateLayout sample code for java.awt.LayoutManager2.invalidateLayout(java.awt.Container) definition code for java.awt.LayoutManager2.invalidateLayout(java.awt.Container) in interface LayoutManager2 sample code for java.awt.LayoutManager2 definition code for java.awt.LayoutManager2

    layoutContainer sample code for java.awt.GridBagLayout.layoutContainer(java.awt.Container) definition code for java.awt.GridBagLayout.layoutContainer(java.awt.Container)

    public void layoutContainer(Container sample code for java.awt.Container definition code for java.awt.Container  parent)
    Lays out the specified container using this grid bag layout. This method reshapes components in the specified container in order to satisfy the contraints of this GridBagLayout object.

    Most applications do not call this method directly.

    Specified by:
    layoutContainer sample code for java.awt.LayoutManager.layoutContainer(java.awt.Container) definition code for java.awt.LayoutManager.layoutContainer(java.awt.Container) in interface LayoutManager sample code for java.awt.LayoutManager definition code for java.awt.LayoutManager
    Parameters:
    parent - the container in which to do the layout
    See Also:
    Container sample code for java.awt.Container definition code for java.awt.Container , Container.doLayout() sample code for java.awt.Container.doLayout() definition code for java.awt.Container.doLayout()

    toString sample code for java.awt.GridBagLayout.toString() definition code for java.awt.GridBagLayout.toString()

    public String sample code for java.lang.String definition code for java.lang.String  toString()
    Returns a string representation of this grid bag layout's values.

    Overrides:
    toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
    Returns:
    a string representation of this grid bag layout.

    getLayoutInfo sample code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int) definition code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int)

    protected java.awt.GridBagLayoutInfo getLayoutInfo(Container sample code for java.awt.Container definition code for java.awt.Container  parent,
                                                       int sizeflag)
    Fills in an instance of GridBagLayoutInfo for the current set of managed children. This requires three passes through the set of children:
    1. Figure out the dimensions of the layout grid.
    2. Determine which cells the components occupy.
    3. Distribute the weights and min sizes amoung the rows/columns.
    This also caches the minsizes for all the children when they are first encountered (so subsequent loops don't need to ask again).

    This method should only be used internally by GridBagLayout.

    Parameters:
    parent - the layout container
    sizeflag - either PREFERREDSIZE or MINSIZE
    Returns:
    the GridBagLayoutInfo for the set of children
    Since:
    1.4

    GetLayoutInfo sample code for java.awt.GridBagLayout.GetLayoutInfo(java.awt.Container, int) definition code for java.awt.GridBagLayout.GetLayoutInfo(java.awt.Container, int)

    protected java.awt.GridBagLayoutInfo GetLayoutInfo(Container sample code for java.awt.Container definition code for java.awt.Container  parent,
                                                       int sizeflag)
    This method is obsolete and supplied for backwards compatability only; new code should call getLayoutInfo sample code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int) definition code for java.awt.GridBagLayout.getLayoutInfo(java.awt.Container, int) instead. This method is the same as getLayoutInfo; refer to getLayoutInfo for details on parameters and return value.


    adjustForGravity sample code for java.awt.GridBagLayout.adjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) definition code for java.awt.GridBagLayout.adjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle)

    protected void adjustForGravity(GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints  constraints,
                                    Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  r)
    Adjusts the x, y, width, and height fields to the correct values depending on the constraint geometry and pads. This method should only be used internally by GridBagLayout.

    Parameters:
    constraints - the constraints to be applied
    r - the Rectangle to be adjusted
    Since:
    1.4

    AdjustForGravity sample code for java.awt.GridBagLayout.AdjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) definition code for java.awt.GridBagLayout.AdjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle)

    protected void AdjustForGravity(GridBagConstraints sample code for java.awt.GridBagConstraints definition code for java.awt.GridBagConstraints  constraints,
                                    Rectangle sample code for java.awt.Rectangle definition code for java.awt.Rectangle  r)
    This method is obsolete and supplied for backwards compatability only; new code should call adjustForGravity sample code for java.awt.GridBagLayout.adjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) definition code for java.awt.GridBagLayout.adjustForGravity(java.awt.GridBagConstraints, java.awt.Rectangle) instead. This method is the same as adjustForGravity; refer to adjustForGravity for details on parameters.


    getMinSize sample code for java.awt.GridBagLayout.getMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) definition code for java.awt.GridBagLayout.getMinSize(java.awt.Container, java.awt.GridBagLayoutInfo)

    protected Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension  getMinSize(Container sample code for java.awt.Container definition code for java.awt.Container  parent,
                                   java.awt.GridBagLayoutInfo info)
    Figures out the minimum size of the master based on the information from getLayoutInfo. This method should only be used internally by GridBagLayout.

    Parameters:
    parent - the layout container
    info - the layout info for this parent
    Returns:
    a Dimension object containing the minimum size
    Since:
    1.4

    GetMinSize sample code for java.awt.GridBagLayout.GetMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) definition code for java.awt.GridBagLayout.GetMinSize(java.awt.Container, java.awt.GridBagLayoutInfo)

    protected Dimension sample code for java.awt.Dimension definition code for java.awt.Dimension  GetMinSize(Container sample code for java.awt.Container definition code for java.awt.Container  parent,
                                   java.awt.GridBagLayoutInfo info)
    This method is obsolete and supplied for backwards compatability only; new code should call getMinSize sample code for java.awt.GridBagLayout.getMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) definition code for java.awt.GridBagLayout.getMinSize(java.awt.Container, java.awt.GridBagLayoutInfo) instead. This method is the same as getMinSize; refer to getMinSize for details on parameters and return value.


    arrangeGrid sample code for java.awt.GridBagLayout.arrangeGrid(java.awt.Container) definition code for java.awt.GridBagLayout.arrangeGrid(java.awt.Container)

    protected void arrangeGrid(Container sample code for java.awt.Container definition code for java.awt.Container  parent)
    Lays out the grid. This method should only be used internally by GridBagLayout.

    Parameters:
    parent - the layout container
    Since:
    1.4

    ArrangeGrid sample code for java.awt.GridBagLayout.ArrangeGrid(java.awt.Container) definition code for java.awt.GridBagLayout.ArrangeGrid(java.awt.Container)

    protected void ArrangeGrid(Container sample code for java.awt.Container definition code for java.awt.Container  parent)
    This method is obsolete and supplied for backwards compatability only; new code should call arrangeGrid sample code for java.awt.GridBagLayout.arrangeGrid(java.awt.Container) definition code for java.awt.GridBagLayout.arrangeGrid(java.awt.Container) instead. This method is the same as arrangeGrid; refer to arrangeGrid for details on the parameter.