org.anc.ui

Class GBC

java.lang.Object

java.awt.GridBagConstraints

org.anc.ui.GBC

All Implemented Interfaces:

Serializable, Cloneable

public class GBC
extends GridBagConstraints

Provides functionality for setting the fields of GridBagConstraints objects.

One of the biggest hurdles working with GridBag layouts is the number of times you need to type the string GridBagConstraints into the text editor. The GBC class extends the java.awt.GridBagConstraints class and adds helper methods to set fields and to allow GBC objects to be used as a "cursor" into the layout. If nothing else, a programmer can access the class variables via the GBC class rather than having to type GridBagConstraints all the time.

The GridBagLayout manager makes its own copy of the GridBagConstraints object so it is possible to use the same GBC object for all controls that you add to a container. For example:

 JPanel aPanel = new JPanel(new GridBagLayout());
 GBC gbc = new GBC();
 // Add controls in the first column
 // Right align the controls
 gbc.right();
 // Don't resize
 gbc.nofill();
 aPanel.add(control1, gbc);
 aPanel.add(control2, gbc.down());
 aPanel.add(control3, gbc.down());
 
 // Center the controls in the second column
 gbc.center();
 // Grow horizontally, and take up all new room along x-axis
 gbc.fillHorizontal();
 gbc.weight(1, 0);
 aPanel.add(control4, gbc.xy(1,0);
 aPanel.add(control5, gbc.down());
 aPanel.add(control6, gbc.down());
 
 // Add controls to the third column
 // Left aligned and won't resize
 gbc.nofill();
 gbc.weight(0,0);
 aPanel.add(control7, gbc.xy(2,0));
 aPanel.add(control8, gbc.down());
 aPanel.add(control9, gbc.down());
 ...
 

Version:

1.0

Author:

Keith Suderman

See Also:

Serialized Form

Field Summary

Fields inherited from class java.awt.GridBagConstraints

ABOVE_BASELINE, ABOVE_BASELINE_LEADING, ABOVE_BASELINE_TRAILING, anchor, BASELINE, BASELINE_LEADING, BASELINE_TRAILING, BELOW_BASELINE, BELOW_BASELINE_LEADING, BELOW_BASELINE_TRAILING, BOTH, CENTER, EAST, fill, FIRST_LINE_END, FIRST_LINE_START, gridheight, gridwidth, gridx, gridy, HORIZONTAL, insets, ipadx, ipady, LAST_LINE_END, LAST_LINE_START, LINE_END, LINE_START, NONE, NORTH, NORTHEAST, NORTHWEST, PAGE_END, PAGE_START, RELATIVE, REMAINDER, SOUTH, SOUTHEAST, SOUTHWEST, VERTICAL, weightx, weighty, WEST

Constructor Summary

Constructors

Constructor and Description
GBC()
GBC(int fill, int anchor)
GBC(int fill, int anchor, int width, int height)

Method Summary

Modifier and Type	Method and Description
GBC	anchorCenter()
GBC	anchorEast()
GBC	anchorLeft() Set anchor = WEST.
GBC	anchorNorth()
GBC	anchorNortheast()
GBC	anchorNorthwest()
GBC	anchorRight()
GBC	anchorSouth()
GBC	anchorSoutheast()
GBC	anchorSouthwest()
GBC	anchorWest()
GBC	down()
GBC	fillBoth()
GBC	fillHorizontal()
GBC	fillNone()
GBC	fillVertical()
static GBC	getDefaultGbc() A static factory method that initializes a constraint object with the most commonly used values.
GBC	insets(int top, int left, int bottom, int right)
GBC	left()
GBC	pad(int x, int y)
GBC	right()
GBC	size(int width, int height)
GBC	up()
GBC	weight(int wx, int wy)
GBC	x(int x)
GBC	xy(int x, int y)
GBC	y(int y)

Methods inherited from class java.awt.GridBagConstraints

clone

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GBC

public GBC()

GBC

public GBC(int fill,
           int anchor)

GBC

public GBC(int fill,
           int anchor,
           int width,
           int height)

Method Detail

getDefaultGbc

public static GBC getDefaultGbc()

A static factory method that initializes a constraint object with the most commonly used values.

anchorLeft

public GBC anchorLeft()

Set anchor = WEST.

anchorCenter

public GBC anchorCenter()

anchorRight

public GBC anchorRight()

anchorWest

public GBC anchorWest()

anchorEast

public GBC anchorEast()

anchorNorth

public GBC anchorNorth()

anchorSouth

public GBC anchorSouth()

anchorNortheast

public GBC anchorNortheast()

anchorNorthwest

public GBC anchorNorthwest()

anchorSoutheast

public GBC anchorSoutheast()

anchorSouthwest

public GBC anchorSouthwest()

fillNone

public GBC fillNone()

fillBoth

public GBC fillBoth()

fillVertical

public GBC fillVertical()

fillHorizontal

public GBC fillHorizontal()

x

public GBC x(int x)

y

public GBC y(int y)

xy

public GBC xy(int x,
              int y)

down

public GBC down()

up

public GBC up()

right

public GBC right()

left

public GBC left()

insets

public GBC insets(int top,
                  int left,
                  int bottom,
                  int right)

weight

public GBC weight(int wx,
                  int wy)

size

public GBC size(int width,
                int height)

pad

public GBC pad(int x,
               int y)