nextapp.echo.app.layout

Class GridLayoutData

java.lang.Object

nextapp.echo.app.layout.CellLayoutData

nextapp.echo.app.layout.GridLayoutData

All Implemented Interfaces:

java.io.Serializable, LayoutData

public class GridLayoutData
extends CellLayoutData

A LayoutData object used to describe how a Component is rendered within a Grid.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SPAN_FILL A constant value for column and row spans indicating that a cell should fill all remaining cells.

Constructor Summary

Constructors

Constructor and Description
GridLayoutData() Creates a new GridLayoutData instance with no column span/row span.
GridLayoutData(int columnSpan, int rowSpan) Creates a new GridLayoutData instance with the specified column and row spans.

Method Summary

Modifier and Type	Method and Description
int	getColumnSpan() Returns the column span of the cell.
int	getRowSpan() Returns the row span of the cell.
void	setColumnSpan(int newValue) Sets the column span of the cell.
void	setRowSpan(int newValue) Sets the row span of the cell.

Methods inherited from class nextapp.echo.app.layout.CellLayoutData

getAlignment, getBackground, getBackgroundImage, getInsets, setAlignment, setBackground, setBackgroundImage, setInsets

Methods inherited from class java.lang.Object

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

Field Detail

SPAN_FILL

public static final int SPAN_FILL

A constant value for column and row spans indicating that a cell should fill all remaining cells.

WARNING: This value may ONLY be used for spans in the direction of the layout of the Grid, i.e., it may only be used for column-spans if the orientation is horizontal, and it may only be used for row-spans if the orientation is vertical.

See Also:

Constant Field Values

Constructor Detail

GridLayoutData

public GridLayoutData()

Creates a new GridLayoutData instance with no column span/row span.

GridLayoutData

public GridLayoutData(int columnSpan,
                      int rowSpan)

Creates a new GridLayoutData instance with the specified column and row spans.

Parameters:

columnSpan - the columnSpan (a value of 1 indicates only one column is occupied)

rowSpan - the rowSpan (a value of 1 indicates only one row is occupied)

Method Detail

getColumnSpan

public int getColumnSpan()

Returns the column span of the cell. A value of 1 indicates only column row is occupied.

Returns:

the column span

getRowSpan

public int getRowSpan()

Returns the row span of the cell. A value of 1 indicates only one row is occupied.

Returns:

the row span

setColumnSpan

public void setColumnSpan(int newValue)

Sets the column span of the cell. A value of 1 indicates only column row is occupied.

Parameters:

newValue - the new column span

setRowSpan

public void setRowSpan(int newValue)

Sets the row span of the cell. A value of 1 indicates only one row is occupied.

Parameters:

newValue - the new row span