org.kuali.rice.kns.uif.layout
Class GridLayoutManager

java.lang.Object
  org.kuali.rice.kns.uif.layout.LayoutManagerBase
      org.kuali.rice.kns.uif.layout.GridLayoutManager

All Implemented Interfaces:

Serializable, LayoutManager

Direct Known Subclasses:

TableLayoutManager

public class GridLayoutManager
extends LayoutManagerBase

Layout manager that organizes its components in a table based grid

Items are laid out from left to right (with each item taking up one column) until the configured number of columns is reached. If the item count is greater than the number of columns, a new row will be created to render the remaining items (and so on until all items are placed). Labels for the fields can be pulled out (default) and rendered as a separate column. The manager also supports the column span and row span options for the field items. If not specified the default is 1.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Constructor Summary

GridLayoutManager()

Method Summary

String	getConditionalNumberOfColumns() Conditional string expression for setting the number of columns field
int	getNumberOfColumns() Indicates the number of columns that should make up one row of data
Class<? extends Container>	getSupportedContainer() Default Impl
boolean	isApplyAlternatingRowStyles() Indicates whether alternating row styles should be applied
boolean	isApplyDefaultCellWidths() Indicates whether the manager should default the cell widths
boolean	isMatchColumnsToFieldCount() Indicates whether the number of columns for the table data should match the number of fields given in the container's items list (so that each field takes up one column without wrapping)
boolean	isRenderAlternatingHeaderColumns() Indicates whether header columns (th for tables) should be rendered for every other item (alternating)
void	performApplyModel(View view, Object model, Container container) Called after the initialize phase to perform conditional logic based on the model data
void	performFinalize(View view, Object model, Container container) The following finalization is performed: Build the list of fields for the grid
void	performInitialization(View view, Container container) The following initialization is performed: If match field count is true, sets the number of columns to the container's items list size
void	setApplyAlternatingRowStyles(boolean applyAlternatingRowStyles) Setter for the alternating row styles indicator
void	setApplyDefaultCellWidths(boolean applyDefaultCellWidths) Setter for the default cell width indicator
void	setConditionalNumberOfColumns(String conditionalNumberOfColumns) Setter for the conditional number of columns string
void	setMatchColumnsToFieldCount(boolean matchColumnsToFieldCount) Setter for the match column count to field count indicator
void	setNumberOfColumns(int numberOfColumns) Setter for the number of columns (each row)
void	setRenderAlternatingHeaderColumns(boolean renderAlternatingHeaderColumns) Setter for the render alternating header columns indicator

Methods inherited from class org.kuali.rice.kns.uif.layout.LayoutManagerBase

addStyleClass, getContext, getId, getNestedComponents, getPropertiesForReferenceCopy, getPropertyReplacers, getStyle, getStyleClasses, getStyleClassesAsString, getTemplate, pushObjectToContext, setContext, setId, setPropertyReplacers, setStyle, setStyleClasses, setStyleClasses, setTemplate

Methods inherited from class java.lang.Object

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

Constructor Detail

GridLayoutManager

public GridLayoutManager()

Method Detail

performInitialization

public void performInitialization(View view,
                                  Container container)

The following initialization is performed:

• If match field count is true, sets the number of columns to the container's items list size

Specified by:

performInitialization in interface LayoutManager

Overrides:

performInitialization in class LayoutManagerBase

Parameters:

view - - View instance the layout manager is a part of

container - - Container the layout manager applies to

See Also:

LayoutManagerBase.performInitialization(org.kuali.rice.kns.uif.container.View, org.kuali.rice.kns.uif.container.Container)

performFinalize

public void performFinalize(View view,
                            Object model,
                            Container container)

The following finalization is performed:

• Build the list of fields for the grid

Specified by:

performFinalize in interface LayoutManager

Overrides:

performFinalize in class LayoutManagerBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

container - - Container the layout manager applies to

See Also:

LayoutManagerBase.performFinalize(org.kuali.rice.kns.uif.container.View, java.lang.Object, org.kuali.rice.kns.uif.container.Container)

performApplyModel

public void performApplyModel(View view,
                              Object model,
                              Container container)

Description copied from interface: LayoutManager

Called after the initialize phase to perform conditional logic based on the model data

Specified by:

performApplyModel in interface LayoutManager

Overrides:

performApplyModel in class LayoutManagerBase

Parameters:

view - - view instance to which the layout manager belongs

model - - Top level object containing the data (could be the form or a top level business object, dto)

container - - Container the layout manager applies to

See Also:

LayoutManagerBase.performApplyModel(org.kuali.rice.kns.uif.container.View, java.lang.Object, org.kuali.rice.kns.uif.container.Container)

getSupportedContainer

public Class<? extends Container> getSupportedContainer()

Description copied from class: LayoutManagerBase

Default Impl

Specified by:

getSupportedContainer in interface LayoutManager

Overrides:

getSupportedContainer in class LayoutManagerBase

Returns:

Class container class supported

See Also:

org.kuali.rice.kns.uif.layout.ContainerAware#getSupportedContainer()

getNumberOfColumns

public int getNumberOfColumns()

Indicates the number of columns that should make up one row of data

If the item count is greater than the number of columns, a new row will be created to render the remaining items (and so on until all items are placed).

Note this does not include any generated columns by the layout manager, so the final column count could be greater (if label fields are separate).

Returns:

setNumberOfColumns

public void setNumberOfColumns(int numberOfColumns)

Setter for the number of columns (each row)

Parameters:

numberOfColumns -

getConditionalNumberOfColumns

public String getConditionalNumberOfColumns()

Conditional string expression for setting the number of columns field

Returns:

String expression that should evaluate to an int

setConditionalNumberOfColumns

public void setConditionalNumberOfColumns(String conditionalNumberOfColumns)

Setter for the conditional number of columns string

Parameters:

conditionalNumberOfColumns -

isMatchColumnsToFieldCount

public boolean isMatchColumnsToFieldCount()

Indicates whether the number of columns for the table data should match the number of fields given in the container's items list (so that each field takes up one column without wrapping)

If set to true during the initialize phase the number of columns will be set to the size of the container's field list, if false the configured number of columns is used

Returns:

boolean true if the column count should match the container's field count, false to use the configured number of columns

setMatchColumnsToFieldCount

public void setMatchColumnsToFieldCount(boolean matchColumnsToFieldCount)

Setter for the match column count to field count indicator

Parameters:

matchColumnsToFieldCount -

isApplyAlternatingRowStyles

public boolean isApplyAlternatingRowStyles()

Indicates whether alternating row styles should be applied

Indicator to layout manager templates to apply alternating row styles. See the configured template for the actual style classes used

Returns:

boolean true if alternating styles should be applied, false if all rows should have the same style

setApplyAlternatingRowStyles

public void setApplyAlternatingRowStyles(boolean applyAlternatingRowStyles)

Setter for the alternating row styles indicator

Parameters:

applyAlternatingRowStyles -

isApplyDefaultCellWidths

public boolean isApplyDefaultCellWidths()

Indicates whether the manager should default the cell widths

If true, the manager will set the cell width by equally dividing by the number of columns

Returns:

boolean true if default cell widths should be applied, false if no defaults should be applied

setApplyDefaultCellWidths

public void setApplyDefaultCellWidths(boolean applyDefaultCellWidths)

Setter for the default cell width indicator

Parameters:

applyDefaultCellWidths -

isRenderAlternatingHeaderColumns

public boolean isRenderAlternatingHeaderColumns()

Indicates whether header columns (th for tables) should be rendered for every other item (alternating)

If true the first cell of each row will be rendered as an header, with every other cell in the row as a header

Returns:

boolean true if alternating headers should be rendered, false if not

setRenderAlternatingHeaderColumns

public void setRenderAlternatingHeaderColumns(boolean renderAlternatingHeaderColumns)

Setter for the render alternating header columns indicator

Parameters:

renderAlternatingHeaderColumns -