GridLayout (Codename One API)

java.lang.Object
- com.codename1.ui.layouts.Layout
- - com.codename1.ui.layouts.GridLayout

```
public class GridLayout
extends Layout
```
The components are arranged in a grid based on available space, all cells in the grid are given exactly the same size which matches the largest preferred size or available space. The main use case for this layout is a grid of icons e.g. like one would see in the iPhone home screen.
If the number of rows * columns is smaller than the number of components added a new row is implicitly added to the grid. However, if the number of components is smaller than available cells (won't fill the last row) blank spaces will be left in place.

In this example we can see that a 2x2 grid is used to add 5 elements, this results in an additional row that's implicitly added turning the grid to a 3x2 grid implicitly and leaving one blank cell.

When we use a 2x4 size ratio we would see elements getting cropped as we do here. The grid layout uses the grid size first and doesn't pay too much attention to the preferred size of the components it holds.

Grid also has an autoFit attribute that can be used to automatically calculate the column count based on available space and preferred width. This is really useful for working with UI's where the device orientation might change.
There is also a terse syntax for working with a grid that has two versions, one that uses the "auto fit" option and another that accepts the column names. Heres a sample of the terse syntax coupled with the auto fit screenshots of the same code in two orientations:

Constructor Summary

Constructors
Constructor and Description
`GridLayout(int columns)` Creates a new instance of GridLayout with the given columns, rows is set to 1 but will implicitly grow if more components are added
`GridLayout(int rows, int columns)` Creates a new instance of GridLayout with the given rows and columns
`GridLayout(int rows, int columns, int landscapeRows, int landscapeColumns)` Creates a new instance of GridLayout with the given rows and columns

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GridLayout`	`autoFit()` Returns a grid layout that implicitly auto-fits to width in term of number of columns
`static Container`	`encloseIn(Component... cmp)` Creates a new container with an auto fit grid layout and the components added to it
`static Container`	`encloseIn(int columns, Component... cmp)` Creates a new container with the grid layout and the components added to it
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`int`	`getColumns()`
`Dimension`	`getPreferredSize(Container parent)` Returns the container preferred size
`int`	`getRows()`
`boolean`	`isAutoFit()` Auto fits columns/rows to available screen space
`boolean`	`isFillLastRow()` When set to true makes the grid layout fill the last row of the layout entirely if the number of elements in that row is bigger.
`boolean`	`isHideZeroSized()` When set to true components that have 0 size will be hidden and won't occupy a cell within the grid.
`void`	`layoutContainer(Container parent)` Layout the given parent container children
`boolean`	`obscuresPotential(Container parent)` Some layout managers can obscure their child components in some cases this returns true if the basic underpinnings are in place for that.
`void`	`setAutoFit(boolean autoFit)` Auto fits columns/rows to available screen space
`void`	`setFillLastRow(boolean fillLastRow)` When set to true makes the grid layout fill the last row of the layout entirely if the number of elements in that row is bigger.
`void`	`setHideZeroSized(boolean hideZeroSized)` When set to true components that have 0 size will be hidden and won't occupy a cell within the grid.
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class com.codename1.ui.layouts.Layout
addLayoutComponent, cloneConstraint, getChildrenInTraversalOrder, getComponentConstraint, hashCode, isConstraintTracking, isOverlapSupported, overridesTabIndices, removeLayoutComponent, updateTabIndices

Methods inherited from class java.lang.Object
clone, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GridLayout
```
public GridLayout(int rows,
                  int columns)
```
    Creates a new instance of GridLayout with the given rows and columns
    
    Parameters:
    
    rows - - number of rows.
    
    columns - - number of columns.
    
    Throws:
    
    IllegalArgumentException - if rows < 1 or columns < 1
  - GridLayout
```
public GridLayout(int rows,
                  int columns,
                  int landscapeRows,
                  int landscapeColumns)
```
    Creates a new instance of GridLayout with the given rows and columns
    
    Parameters:
    
    rows - - number of rows.
    
    columns - - number of columns.
    
    landscapeRows - - number of rows when in landscape mode
    
    landscapeColumns - - number of columns when in landscape mode
    
    Throws:
    
    IllegalArgumentException - if rows < 1 or columns < 1
  - GridLayout
```
public GridLayout(int columns)
```
    Creates a new instance of GridLayout with the given columns, rows is set to 1 but will implicitly grow if more components are added
    
    Parameters:
    
    columns - - number of columns.
    
    Throws:
    
    IllegalArgumentException - if rows < 1 or columns < 1
- Method Detail
  - autoFit
```
public static GridLayout autoFit()
```
    Returns a grid layout that implicitly auto-fits to width in term of number of columns
    
    Returns:
    
    a grid layout that automatically adapts its size
  - encloseIn
```
public static Container encloseIn(Component... cmp)
```
    Creates a new container with an auto fit grid layout and the components added to it
    
    Parameters:
    
    cmp - the components
    
    Returns:
    
    a new container
  - encloseIn
```
public static Container encloseIn(int columns,
                                  Component... cmp)
```
    Creates a new container with the grid layout and the components added to it
    
    Parameters:
    
    columns - the number of columns for the grid
    
    cmp - the components
    
    Returns:
    
    a new container
  - layoutContainer
```
public void layoutContainer(Container parent)
```
    Layout the given parent container children
    
    Specified by:
    
    layoutContainer in class Layout
    
    Parameters:
    
    parent - the given parent container
  - getPreferredSize
```
public Dimension getPreferredSize(Container parent)
```
    Returns the container preferred size
    
    Specified by:
    
    getPreferredSize in class Layout
    
    Parameters:
    
    parent - the parent container
    
    Returns:
    
    the container preferred size
  - toString
```
public String toString()
```
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + '@' + Integer.toHexString(hashCode())
    
    Overrides:
    
    toString in class Object
  - getRows
```
public int getRows()
```
    Returns:
    
    the rows
  - getColumns
```
public int getColumns()
```
    Returns:
    
    the columns
  - equals
```
public boolean equals(Object o)
```
    Indicates whether some other object is "equal to" this one. The equals method implements an equivalence relation: It is reflexive: for any reference value x, x.equals(x) should return true. It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true. It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true. It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the object is modified. For any non-null reference value x, x.equals(null) should return false. The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).
    
    Overrides:
    
    equals in class Layout
  - isFillLastRow
```
public boolean isFillLastRow()
```
    When set to true makes the grid layout fill the last row of the layout entirely if the number of elements in that row is bigger.
    
    Returns:
    
    the fillLastRow
  - setFillLastRow
```
public void setFillLastRow(boolean fillLastRow)
```
    When set to true makes the grid layout fill the last row of the layout entirely if the number of elements in that row is bigger.
    
    Parameters:
    
    fillLastRow - the fillLastRow to set
  - isAutoFit
```
public boolean isAutoFit()
```
    Auto fits columns/rows to available screen space
    
    Returns:
    
    the autoFit
  - setAutoFit
```
public void setAutoFit(boolean autoFit)
```
    Auto fits columns/rows to available screen space
    
    Parameters:
    
    autoFit - the autoFit to set
  - obscuresPotential
```
public boolean obscuresPotential(Container parent)
```
    Some layout managers can obscure their child components in some cases this returns true if the basic underpinnings are in place for that. This method doesn't take padding/margin etc. into account since that is checked by the caller
    
    Overrides:
    
    obscuresPotential in class Layout
    
    Parameters:
    
    parent - parent container
    
    Returns:
    
    true if there is a chance that this layout manager can fully obscure the background, when in doubt return false...
  - isHideZeroSized
```
public boolean isHideZeroSized()
```
    When set to true components that have 0 size will be hidden and won't occupy a cell within the grid. This makes animating a grid layout component MUCH easier.
    
    Returns:
    
    the hideZeroSized
  - setHideZeroSized
```
public void setHideZeroSized(boolean hideZeroSized)
```
    When set to true components that have 0 size will be hidden and won't occupy a cell within the grid. This makes animating a grid layout component MUCH easier.
    
    Parameters:
    
    hideZeroSized - the hideZeroSized to set

Class GridLayout

Constructor Summary

Method Summary

Methods inherited from class com.codename1.ui.layouts.Layout

Methods inherited from class java.lang.Object

Constructor Detail

GridLayout

GridLayout

GridLayout

Method Detail

autoFit

encloseIn

encloseIn

layoutContainer

getPreferredSize

toString

getRows

getColumns

equals

isFillLastRow

setFillLastRow

isAutoFit

setAutoFit

obscuresPotential

isHideZeroSized

setHideZeroSized