GridLayout JDK 1.6)

Description

public class GridLayout

The GridLayout class is a layout manager that lays out a container's components in a rectangular grid.

The GridLayout class is a layout manager that lays out a container's components in a rectangular grid. The container is divided into equal-sized rectangles, and one component is placed in each rectangle. For example, the following is an applet that lays out six buttons into three rows and two columns:

 import java.awt.*;
 import java.applet.Applet;
 public class ButtonGrid extends Applet {
     public void init() {
         setLayout(new GridLayout(3,2));
         add(new Button("1"));
         add(new Button("2"));
         add(new Button("3"));
         add(new Button("4"));
         add(new Button("5"));
         add(new Button("6"));
     }
 }

If the container's ComponentOrientation property is horizontal and left-to-right, the above example produces the output shown in Figure 1. If the container's ComponentOrientation property is horizontal and right-to-left, the example produces the output shown in Figure 2.


Figure 1: Horizontal, Left-to-Right	Figure 2: Horizontal, Right-to-Left

When both the number of rows and the number of columns have been set to non-zero values, either by a constructor or by the setRows and setColumns methods, the number of columns specified is ignored. Instead, the number of columns is determined from the specified number of rows and the total number of components in the layout. So, for example, if three rows and two columns have been specified and nine components are added to the layout, they will be displayed as three rows of three columns. Specifying the number of columns affects the layout only when the number of rows is set to zero.

See also:

Constructors

public GridLayout ()

Creates a grid layout with a default of one column per component, in a single row.

public GridLayout (int rows, int cols)

Creates a grid layout with the specified number of rows and columns.

public GridLayout (int rows, int cols, int hgap, int vgap)

Creates a grid layout with the specified number of rows and columns.

Methods

Hide/Show inherited methods

public void addLayoutComponent (String name, Component comp) [Specified in LayoutManager]

Adds the specified component with the specified name to the layout.

public int getColumns ()

Gets the number of columns in this layout.

public int getHgap ()

Gets the horizontal gap between components.

public int getRows ()

Gets the number of rows in this layout.

public int getVgap ()

Gets the vertical gap between components.

public void layoutContainer (Container parent) [Specified in LayoutManager]

Lays out the specified container using this layout.

public Dimension minimumLayoutSize (Container parent) [Specified in LayoutManager]

Determines the minimum size of the container argument using this grid layout.

public Dimension preferredLayoutSize (Container parent) [Specified in LayoutManager]

Determines the preferred size of the container argument using this grid layout.

public void removeLayoutComponent (Component comp) [Specified in LayoutManager]

Removes the specified component from the layout.

public void setColumns (int cols)

Sets the number of columns in this layout to the specified value.

Sets the number of columns in this layout to the specified value.
Setting the number of columns has no affect on the layout
if the number of rows specified by a constructor or by
the setRows method is non-zero. In that case, the number
of columns displayed in the layout is determined by the total
number of components and the number of rows specified.
Parameters:
- cols - the number of columns in this layout
Throws:
- IllegalArgumentException - if the value of both rows and cols is set to zero
Since: JDK1.1

public void setHgap (int hgap)

Sets the horizontal gap between components to the specified value.

public void setRows (int rows)

Sets the number of rows in this layout to the specified value.

Sets the number of rows in this layout to the specified value.
Parameters:
- rows - the number of rows in this layout
Throws:
- IllegalArgumentException - if the value of both rows and cols is set to zero
Since: JDK1.1

public void setVgap (int vgap)

Sets the vertical gap between components to the specified value.

public String toString ()

Returns the string representation of this grid layout's values.

Fields

Hide/Show inherited fields

pack-private int cols

This is the number of columns specified for the grid.

pack-private int hgap

This is the horizontal gap (in pixels) which specifies the space between columns.

pack-private int rows

This is the number of rows specified for the grid.

pack-private int vgap

This is the vertical gap (in pixels) which specifies the space between rows.