com.alee.laf.grouping

Class GroupPaneLayout

java.lang.Object

com.alee.extended.layout.AbstractLayoutManager

com.alee.laf.grouping.AbstractGroupingLayout

com.alee.laf.grouping.GroupPaneLayout

All Implemented Interfaces:

GroupingLayout, java.awt.LayoutManager, java.awt.LayoutManager2, javax.swing.SwingConstants

public class GroupPaneLayout
extends AbstractGroupingLayout
implements javax.swing.SwingConstants

Layout designed specifically for usage within GroupPane container. It constructs a grid of components to be visually grouped and knows how to retrieve components at specific cells.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	columns Amount of columns used to place components.
protected java.util.Map<java.awt.Component,GroupPaneConstraints>	constraints Component constraints.
protected int	orientation Components placement order orientation.
protected int	rows Amount of rows used to place components.

Fields inherited from class com.alee.laf.grouping.AbstractGroupingLayout

buttonGroup, children, group, groupButtons, sides

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor and Description
GroupPaneLayout() Constructs default layout.
GroupPaneLayout(int orientation) Constructs layout with the specified amount of rows and columns.
GroupPaneLayout(int columns, int rows) Constructs layout with the specified amount of rows and columns.
GroupPaneLayout(int orientation, int columns, int rows) Constructs layout with the specified amount of rows and columns.

Method Summary

Modifier and Type	Method and Description
void	addComponent(java.awt.Component component, java.lang.Object c) Called when component added into container with this layout.
protected void	appendDelta(int count, int[] sizes, int size) Appends delta space equally to last elements to properly fill in all available space.
protected com.alee.utils.general.Pair<int[],int[]>	calculateSizes(java.awt.Container parent, GridSize gridSize, com.alee.utils.swing.SizeType type) Returns column and row sizes.
protected com.alee.utils.general.Pair<java.lang.Double,java.lang.Integer>	calculateSizes(int count, int size, int[] sizes, double[] percents) Calculates proper component sizes along with percents summ and free size.
GridSize	getActualGridSize(java.awt.Container parent) Returns actual grid size according to container components amount.
int	getColumns() Returns amount of columns used to place components.
java.awt.Component	getComponentAt(java.awt.Container parent, int column, int row) Returns component at the specified cell.
protected com.alee.utils.general.Pair<java.lang.String,java.lang.String>	getDescriptors(java.awt.Container parent, java.awt.Component component, int index) Returns descriptors for painted component sides and lines.
java.awt.Component	getNeighbour(java.awt.Container parent, GridSize gridSize, int col, int row, int direction) Returns neighbour component.
int	getOrientation() Returns components placement order orientation.
int	getRows() Returns amount of rows used to place components.
int	indexToColumn(java.awt.Container parent, int index, GridSize gridSize) Returns grid column in which component under the specified index is placed.
int	indexToRow(int index) Returns grid row in which component under the specified index is placed.
boolean	isNeighbourDecoratable(java.awt.Container parent, GridSize gridSize, int col, int row, int direction) Returns whether or not neighbour component painter is decoratable.
void	layoutContainer(java.awt.Container parent)
int	pointToIndex(java.awt.Container parent, int column, int row, GridSize gridSize) Returns index of the component placed in the specified grid cell or null if cell is empty.
java.awt.Dimension	preferredLayoutSize(java.awt.Container parent)
void	removeComponent(java.awt.Component component) Called when component removed from container with this layout.
void	setColumns(int columns) Sets amount of columns used to place components.
void	setOrientation(int orientation) Sets components placement order orientation.
void	setRows(int rows) Sets amount of rows used to place components.

Methods inherited from class com.alee.laf.grouping.AbstractGroupingLayout

clearGrouping, createButtonGroup, getButtonGroup, getLines, getSides, isGroupable, isGroupButtons, isGrouping, isPaintBottom, isPaintLeft, isPaintRight, isPaintTop, resetDescriptors, setGroup, setGroupButtons, setPaintBottom, setPaintLeft, setPaintRight, setPaintSides, setPaintTop, sides, updateButtonGrouping

Methods inherited from class com.alee.extended.layout.AbstractLayoutManager

addLayoutComponent, addLayoutComponent, getLayoutAlignmentX, getLayoutAlignmentY, invalidateLayout, maximumLayoutSize, minimumLayoutSize, removeLayoutComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.LayoutManager2

addLayoutComponent, getLayoutAlignmentX, getLayoutAlignmentY, invalidateLayout, maximumLayoutSize

Methods inherited from interface java.awt.LayoutManager

addLayoutComponent, minimumLayoutSize, removeLayoutComponent

Field Detail

orientation

@XStreamAsAttribute
protected int orientation

Components placement order orientation.

columns

@XStreamAsAttribute
protected int columns

Amount of columns used to place components.

rows

@XStreamAsAttribute
protected int rows

Amount of rows used to place components.

constraints

protected final transient java.util.Map<java.awt.Component,GroupPaneConstraints> constraints

Component constraints.

Constructor Detail

GroupPaneLayout

public GroupPaneLayout()

Constructs default layout.

GroupPaneLayout

public GroupPaneLayout(int orientation)

Constructs layout with the specified amount of rows and columns.

Parameters:

orientation - components placement order orientation

GroupPaneLayout

public GroupPaneLayout(int columns,
                       int rows)

Constructs layout with the specified amount of rows and columns.

Parameters:

columns - amount of columns used to place components

rows - amount of rows used to place components

GroupPaneLayout

public GroupPaneLayout(int orientation,
                       int columns,
                       int rows)

Constructs layout with the specified amount of rows and columns.

Parameters:

orientation - components placement order orientation

columns - amount of columns used to place components

rows - amount of rows used to place components

Method Detail

getOrientation

public int getOrientation()

Returns components placement order orientation.

Returns:

components placement order orientation

setOrientation

public void setOrientation(int orientation)

Sets components placement order orientation.

Parameters:

orientation - components placement order orientation

getColumns

public int getColumns()

Returns amount of columns used to place components.

Returns:

amount of columns used to place components

setColumns

public void setColumns(int columns)

Sets amount of columns used to place components.

Parameters:

columns - amount of columns to place components

getRows

public int getRows()

Returns amount of rows used to place components.

Returns:

amount of rows used to place components

setRows

public void setRows(int rows)

Sets amount of rows used to place components.

Parameters:

rows - amount of rows to place components

addComponent

public void addComponent(java.awt.Component component,
                         java.lang.Object c)

Description copied from class: AbstractLayoutManager

Called when component added into container with this layout.

Overrides:

addComponent in class AbstractGroupingLayout

Parameters:

component - added component

c - component constraints

removeComponent

public void removeComponent(java.awt.Component component)

Description copied from class: AbstractLayoutManager

Called when component removed from container with this layout.

Overrides:

removeComponent in class AbstractGroupingLayout

Parameters:

component - removed component

layoutContainer

public void layoutContainer(java.awt.Container parent)

Specified by:

layoutContainer in interface java.awt.LayoutManager

preferredLayoutSize

public java.awt.Dimension preferredLayoutSize(java.awt.Container parent)

Specified by:

preferredLayoutSize in interface java.awt.LayoutManager

getActualGridSize

public GridSize getActualGridSize(java.awt.Container parent)

Returns actual grid size according to container components amount. Actual grid size is very important for all calculations as it defines the final size of the grid. For example: Layout settings are set to have 5 columns and 5 rows which in total requires 25 components to fill-in the grid. Though there might not be enough components provided to fill the grid, in that case the actual grid size might be less.

Parameters:

parent - group pane

Returns:

actual grid size according to container components amount

getComponentAt

public java.awt.Component getComponentAt(java.awt.Container parent,
                                         int column,
                                         int row)

Returns component at the specified cell.

Parameters:

parent - group pane

column - component column

row - component row

Returns:

component at the specified cell

indexToColumn

public int indexToColumn(java.awt.Container parent,
                         int index,
                         GridSize gridSize)

Returns grid column in which component under the specified index is placed.

Parameters:

parent - group pane

index - component index

gridSize - actual grid size

Returns:

grid column in which component under the specified index is placed

indexToRow

public int indexToRow(int index)

Returns grid row in which component under the specified index is placed.

Parameters:

index - component index

Returns:

grid row in which component under the specified index is placed

pointToIndex

public int pointToIndex(java.awt.Container parent,
                        int column,
                        int row,
                        GridSize gridSize)

Returns index of the component placed in the specified grid cell or null if cell is empty.

Parameters:

parent - group pane

column - grid column index

row - grid row index

gridSize - actual grid size

Returns:

index of the component placed in the specified grid cell or null if cell is empty

calculateSizes

protected com.alee.utils.general.Pair<int[],int[]> calculateSizes(java.awt.Container parent,
                                                                  GridSize gridSize,
                                                                  com.alee.utils.swing.SizeType type)

Returns column and row sizes.

Parameters:

parent - group pane

gridSize - actual grid size

type - requested sizes type

Returns:

column and row sizes

calculateSizes

protected com.alee.utils.general.Pair<java.lang.Double,java.lang.Integer> calculateSizes(int count,
                                                                                         int size,
                                                                                         int[] sizes,
                                                                                         double[] percents)

Calculates proper component sizes along with percents summ and free size.

Parameters:

count - parts count

size - total available size

sizes - part sizes

percents - part percentages

Returns:

percents summ and free size pair

appendDelta

protected void appendDelta(int count,
                           int[] sizes,
                           int size)

Appends delta space equally to last elements to properly fill in all available space.

Parameters:

count - parts count

sizes - part sizes

size - total available size

getDescriptors

protected com.alee.utils.general.Pair<java.lang.String,java.lang.String> getDescriptors(java.awt.Container parent,
                                                                                        java.awt.Component component,
                                                                                        int index)

Description copied from class: AbstractGroupingLayout

Returns descriptors for painted component sides and lines. It is requested only if grouping is actually enabled.

Specified by:

getDescriptors in class AbstractGroupingLayout

Parameters:

parent - component container

component - painted component

index - component z-index in container

Returns:

descriptors for painted component sides and lines

isNeighbourDecoratable

public boolean isNeighbourDecoratable(java.awt.Container parent,
                                      GridSize gridSize,
                                      int col,
                                      int row,
                                      int direction)

Returns whether or not neighbour component painter is decoratable.

Parameters:

parent - container

gridSize - actual grid size

col - current component column

row - current component row

direction - neighbour direction

Returns:

true if neighbour component painter is decoratable, false otherwise

getNeighbour

public java.awt.Component getNeighbour(java.awt.Container parent,
                                       GridSize gridSize,
                                       int col,
                                       int row,
                                       int direction)

Returns neighbour component.

Parameters:

parent - container

gridSize - actual grid size

col - current component column

row - current component row

direction - neighbour direction

Returns:

neighbour component