Package swingtree.api

Class Layout.ForGridLayout

java.lang.Object

swingtree.api.Layout.ForGridLayout

All Implemented Interfaces:

Layout

Enclosing interface:

Layout

@Immutable
public static final class Layout.ForGridLayout
extends Object
implements Layout

A Layout which installs a UniformGridLayout onto a component, created through one of the Layout.grid(int, int) factory methods. It consists of the mode of the grid, which of its empty rows and columns are left out, how it grows when it holds more children than cells, the numbers of rows and columns, and the horizontal and vertical gaps.

When the component already has a UniformGridLayout, for example one installed through UIForAnySwing.withGridLayout(int, int) or by an earlier Layout.ForGridLayout, that layout manager is updated in place instead of being replaced.

Nested Class Summary

Nested classes/interfaces inherited from interface swingtree.api.Layout

Layout.BorderLayoutInstaller, Layout.ForBoxLayout, Layout.ForFlowLayout, Layout.ForGridLayout, Layout.ForMigLayout, Layout.None, Layout.Unspecific

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()
void	installFor(JComponent component)	Installs a UniformGridLayout with the settings, the numbers of rows and columns and the gaps of this configuration onto the supplied component.
String	toString()
Layout.ForGridLayout	withCollapseEmpty(UniformGridLayout.CollapseEmpty collapseEmpty)	Returns a new Layout.ForGridLayout which leaves out the given empty rows and columns, with all other properties copied unchanged.
Layout.ForGridLayout	withMode(UniformGridLayout.Mode mode)	Returns a new Layout.ForGridLayout with the given mode and all other properties copied unchanged.
Layout.ForGridLayout	withOverflowGrowth(UniformGridLayout.OverflowGrowth overflowGrowth)	Returns a new Layout.ForGridLayout which grows an overflowing grid in the given way, with all other properties copied unchanged.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

withMode

public Layout.ForGridLayout withMode(UniformGridLayout.Mode mode)

Returns a new Layout.ForGridLayout with the given mode and all other properties copied unchanged. The mode decides how the grid is built from the numbers of rows and columns: UniformGridLayout.Mode.WRAP_AFTER_COLUMNS starts a new row after every declared number of columns, and UniformGridLayout.Mode.SPREAD_OVER_ROWS spreads the children over the declared rows, like a GridLayout.

Parameters:

mode - How the grid is built from the numbers of rows and columns.

Returns:

A new Layout.ForGridLayout with the given mode.

withCollapseEmpty

public Layout.ForGridLayout withCollapseEmpty(UniformGridLayout.CollapseEmpty collapseEmpty)

Returns a new Layout.ForGridLayout which leaves out the given empty rows and columns, with all other properties copied unchanged. For example, with UniformGridLayout.CollapseEmpty.NONE, 3 children of a grid of 2 rows and 5 columns take the first 3 cells of all 10, and with UniformGridLayout.CollapseEmpty.ROWS_AND_COLUMNS they share the whole component in a single row of 3 columns.

Parameters:

collapseEmpty - Which of the rows and columns that no child occupies are left out.

Returns:

A new Layout.ForGridLayout with the given setting.

withOverflowGrowth

public Layout.ForGridLayout withOverflowGrowth(UniformGridLayout.OverflowGrowth overflowGrowth)

Returns a new Layout.ForGridLayout which grows an overflowing grid in the given way, with all other properties copied unchanged. A grid overflows when it holds more children than its number of rows times its number of columns: with UniformGridLayout.OverflowGrowth.ADD_ROWS, 13 children of a grid of 2 rows and 5 columns are laid out in 3 rows of 5 columns, with UniformGridLayout.OverflowGrowth.ADD_COLUMNS in 2 rows of 7 columns, and with UniformGridLayout.OverflowGrowth.ADD_ROWS_AND_COLUMNS in 3 rows of 6 columns.

Parameters:

overflowGrowth - How the grid grows when it holds more children than cells.

Returns:

A new Layout.ForGridLayout with the given setting.

hashCode

public int hashCode()

Specified by:

hashCode in interface Layout

Overrides:

hashCode in class Object

Returns:

A hash code value for this layout.

equals

public boolean equals(Object o)

Specified by:

equals in interface Layout

Overrides:

equals in class Object

Parameters:

o - The object to compare this layout to.

Returns:

true if the supplied object is a layout that is equal to this layout, false otherwise.

installFor

public void installFor(JComponent component)

Installs a UniformGridLayout with the settings, the numbers of rows and columns and the gaps of this configuration onto the supplied component. If the component already has a UniformGridLayout, only the properties that differ are updated, and JComponent.revalidate() is called to lay out the component again.

Specified by:

installFor in interface Layout

Parameters:

component - The component to install the UniformGridLayout for.

toString

public String toString()

Overrides:

toString in class Object