Java Doc for GridLayout.java in  » 6.0-JDK-Core » AWT » java » awt » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » AWT » java.awt 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.awt.GridLayout

GridLayout
public class GridLayout implements LayoutManager,java.io.Serializable(Code)
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.

Shows 6 buttons in rows of 2. Row 1 shows buttons 1 then 2.  Row 2 shows buttons 3 then 4. Row 3 shows buttons 5 then 6. Shows 6 buttons in rows of 2. Row 1 shows buttons 2 then 1.  Row 2 shows buttons 4 then 3. Row 3 shows buttons 6 then 5.
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.
version:
   1.49, 05/05/07
author:
   Arthur van Hoff
since:
   JDK1.0



Field Summary
 intcols
     This is the number of columns specified for the grid.
 inthgap
     This is the horizontal gap (in pixels) which specifies the space between columns.
 introws
     This is the number of rows specified for the grid.
 intvgap
     This is the vertical gap (in pixels) which specifies the space between rows.

Constructor Summary
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.

Method Summary
public  voidaddLayoutComponent(String name, Component comp)
     Adds the specified component with the specified name to the layout.
public  intgetColumns()
     Gets the number of columns in this layout.
public  intgetHgap()
     Gets the horizontal gap between components.
public  intgetRows()
     Gets the number of rows in this layout.
public  intgetVgap()
     Gets the vertical gap between components.
public  voidlayoutContainer(Container parent)
     Lays out the specified container using this layout.
public  DimensionminimumLayoutSize(Container parent)
     Determines the minimum size of the container argument using this grid layout.
public  DimensionpreferredLayoutSize(Container parent)
     Determines the preferred size of the container argument using this grid layout.
public  voidremoveLayoutComponent(Component comp)
     Removes the specified component from the layout.
public  voidsetColumns(int cols)
     Sets the number of columns in this layout to the specified value.
public  voidsetHgap(int hgap)
     Sets the horizontal gap between components to the specified value.
public  voidsetRows(int rows)
     Sets the number of rows in this layout to the specified value.
public  voidsetVgap(int vgap)
     Sets the vertical gap between components to the specified value.
public  StringtoString()
     Returns the string representation of this grid layout's values.

Field Detail
cols
int cols(Code)
This is the number of columns specified for the grid. The number of columns can be changed at any time. This should be a non negative integer, where '0' means 'any number' meaning that the number of Columns in that dimension depends on the other dimension.
See Also:   GridLayout.getColumns()
See Also:   GridLayout.setColumns(int)



hgap
int hgap(Code)
This is the horizontal gap (in pixels) which specifies the space between columns. They can be changed at any time. This should be a non-negative integer.
See Also:   GridLayout.getHgap()
See Also:   GridLayout.setHgap(int)



rows
int rows(Code)
This is the number of rows specified for the grid. The number of rows can be changed at any time. This should be a non negative integer, where '0' means 'any number' meaning that the number of Rows in that dimension depends on the other dimension.
See Also:   GridLayout.getRows()
See Also:   GridLayout.setRows(int)



vgap
int vgap(Code)
This is the vertical gap (in pixels) which specifies the space between rows. They can be changed at any time. This should be a non negative integer.
See Also:   GridLayout.getVgap()
See Also:   GridLayout.setVgap(int)




Constructor Detail
GridLayout
public GridLayout()(Code)
Creates a grid layout with a default of one column per component, in a single row.
since:
   JDK1.1



GridLayout
public GridLayout(int rows, int cols)(Code)
Creates a grid layout with the specified number of rows and columns. All components in the layout are given equal size.

One, but not both, of rows and cols can be zero, which means that any number of objects can be placed in a row or in a column.
Parameters:
  rows - the rows, with the value zero meaning any number of rows.
Parameters:
  cols - the columns, with the value zero meaning any number of columns.




GridLayout
public GridLayout(int rows, int cols, int hgap, int vgap)(Code)
Creates a grid layout with the specified number of rows and columns. All components in the layout are given equal size.

In addition, the horizontal and vertical gaps are set to the specified values. Horizontal gaps are placed between each of the columns. Vertical gaps are placed between each of the rows.

One, but not both, of rows and cols can be zero, which means that any number of objects can be placed in a row or in a column.

All GridLayout constructors defer to this one.
Parameters:
  rows - the rows, with the value zero meaning any number of rows
Parameters:
  cols - the columns, with the value zero meaning any number of columns
Parameters:
  hgap - the horizontal gap
Parameters:
  vgap - the vertical gap
exception:
  IllegalArgumentException - if the value of bothrows and cols is set to zero





Method Detail
addLayoutComponent
public void addLayoutComponent(String name, Component comp)(Code)
Adds the specified component with the specified name to the layout.
Parameters:
  name - the name of the component
Parameters:
  comp - the component to be added



getColumns
public int getColumns()(Code)
Gets the number of columns in this layout. the number of columns in this layout
since:
   JDK1.1



getHgap
public int getHgap()(Code)
Gets the horizontal gap between components. the horizontal gap between components
since:
   JDK1.1



getRows
public int getRows()(Code)
Gets the number of rows in this layout. the number of rows in this layout
since:
   JDK1.1



getVgap
public int getVgap()(Code)
Gets the vertical gap between components. the vertical gap between components
since:
   JDK1.1



layoutContainer
public void layoutContainer(Container parent)(Code)
Lays out the specified container using this layout.

This method reshapes the components in the specified target container in order to satisfy the constraints of the GridLayout object.

The grid layout manager determines the size of individual components by dividing the free space in the container into equal-sized portions according to the number of rows and columns in the layout. The container's free space equals the container's size minus any insets and any specified horizontal or vertical gap. All components in a grid layout are given the same size.
Parameters:
  parent - the container in which to do the layout
See Also:   java.awt.Container
See Also:   java.awt.Container.doLayout




minimumLayoutSize
public Dimension minimumLayoutSize(Container parent)(Code)
Determines the minimum size of the container argument using this grid layout.

The minimum width of a grid layout is the largest minimum width of all of the components in the container times the number of columns, plus the horizontal padding times the number of columns minus one, plus the left and right insets of the target container.

The minimum height of a grid layout is the largest minimum height of all of the components in the container times the number of rows, plus the vertical padding times the number of rows minus one, plus the top and bottom insets of the target container.
Parameters:
  parent - the container in which to do the layout the minimum dimensions needed to lay out the subcomponents of the specified container
See Also:   java.awt.GridLayout.preferredLayoutSize
See Also:   java.awt.Container.doLayout




preferredLayoutSize
public Dimension preferredLayoutSize(Container parent)(Code)
Determines the preferred size of the container argument using this grid layout.

The preferred width of a grid layout is the largest preferred width of all of the components in the container times the number of columns, plus the horizontal padding times the number of columns minus one, plus the left and right insets of the target container.

The preferred height of a grid layout is the largest preferred height of all of the components in the container times the number of rows, plus the vertical padding times the number of rows minus one, plus the top and bottom insets of the target container.
Parameters:
  parent - the container in which to do the layout the preferred dimensions to lay out the subcomponents of the specified container
See Also:   java.awt.GridLayout.minimumLayoutSize
See Also:   
See Also:   java.awt.Container.getPreferredSize




removeLayoutComponent
public void removeLayoutComponent(Component comp)(Code)
Removes the specified component from the layout.
Parameters:
  comp - the component to be removed



setColumns
public void setColumns(int cols)(Code)
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
exception:
  IllegalArgumentException - if the value of both rows and cols is set to zero
since:
   JDK1.1



setHgap
public void setHgap(int hgap)(Code)
Sets the horizontal gap between components to the specified value.
Parameters:
  hgap - the horizontal gap between components
since:
   JDK1.1



setRows
public void setRows(int rows)(Code)
Sets the number of rows in this layout to the specified value.
Parameters:
  rows - the number of rows in this layout
exception:
  IllegalArgumentException - if the value of both rows and cols is set to zero
since:
   JDK1.1



setVgap
public void setVgap(int vgap)(Code)
Sets the vertical gap between components to the specified value.
Parameters:
  vgap - the vertical gap between components
since:
   JDK1.1



toString
public String toString()(Code)
Returns the string representation of this grid layout's values. a string representation of this grid layout



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.