org.kuali.rice.krad.uif.layout

Class CssGridLayoutManager

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

org.kuali.rice.krad.uif.layout.LayoutManagerBase

org.kuali.rice.krad.uif.layout.CssGridLayoutManagerBase

org.kuali.rice.krad.uif.layout.CssGridLayoutManager

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, LayoutManager, LifecycleElement

public class CssGridLayoutManager
extends CssGridLayoutManagerBase

Css Grid Layout manager is a layout manager which creates div "rows" and "cells" to replicate a table look by using div elements for its items.

Items are added into rows based on their colSpan setting, while each row has a max size of 12 columns. By default, if colSpan is not set on an item, that item will take a full row.

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.uif.layout.CssGridLayoutManagerBase

BOOTSTRAP_SPAN_PREFIX, cellCssClassAttributes, cellItems, lgTotalSize, mdTotalSize, NUMBER_OF_COLUMNS, smTotalSize, xsTotalSize

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
CssGridLayoutManager()

Method Summary

Modifier and Type	Method and Description
int	getDefaultItemSize() The default "cell" size to use for this layout - this converts to medium size (max setting, and the default, is 12)
CssGridSizes	getDefaultItemSizes() Default sizes for each item in this css grid layout, these settings will override the setting in defaultItemSize, but will not override item specific cssGridSizes.
void	performFinalize(Object model, LifecycleElement component) CssGridLayoutManager's performFinalize method calculates and separates the items into rows based on their colSpan settings and the defaultItemSize setting The last phase before the view is rendered
void	setDefaultItemSize(int defaultItemSize) Set the default colSpan for this layout's items
void	setDefaultItemSizes(CssGridSizes defaultItemSizes)

Methods inherited from class org.kuali.rice.krad.uif.layout.CssGridLayoutManagerBase

addLeftClearCssClass, calculateCssClassAndSize, getCellCssClassAttributes, getCellItems, getCellStyleClassesAsString

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

addStyleClass, appendToStyle, checkMutable, clone, getAdditionalCssClasses, getContainerIdSuffix, getContext, getCssClasses, getId, getLibraryCssClasses, getPhasePathMapping, getPropertyReplacers, getStyle, getStyleClassesAsString, getSupportedContainer, getTemplate, getTemplateName, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, setAdditionalCssClasses, setContainerIdSuffix, setContext, setCssClasses, setId, setLibraryCssClasses, setPhasePathMapping, setPropertyReplacers, setRender, setStyle, setStyleClasses, setTemplate, setTemplateName, setViewPath, setViewStatus, skipLifecycle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Constructor Detail

CssGridLayoutManager

public CssGridLayoutManager()

Method Detail

performFinalize

public void performFinalize(Object model,
                            LifecycleElement component)

CssGridLayoutManager's performFinalize method calculates and separates the items into rows based on their colSpan settings and the defaultItemSize setting The last phase before the view is rendered

Here final preparations can be made based on the updated view state.

Specified by:

performFinalize in interface LifecycleElement

Overrides:

performFinalize in class LayoutManagerBase

Parameters:

model - - top level object containing the data

component - - parent component

getDefaultItemSize

public int getDefaultItemSize()

The default "cell" size to use for this layout - this converts to medium size (max setting, and the default, is 12)

This is a quick and easy setter for default mdSize for this layout, as a common use case is to have a different layout for medium devices and up, while small and extra small will consume the full screen. For customizations at every screen size, use defaultItemSizes.

Returns:

int representing the default colSpan for cells in this layout

setDefaultItemSize

public void setDefaultItemSize(int defaultItemSize)

Set the default colSpan for this layout's items

Parameters:

defaultItemSize -

getDefaultItemSizes

public CssGridSizes getDefaultItemSizes()

Default sizes for each item in this css grid layout, these settings will override the setting in defaultItemSize, but will not override item specific cssGridSizes.

Returns:

cssGridSizes containing the sizes of items in this group to use as default

setDefaultItemSizes

public void setDefaultItemSizes(CssGridSizes defaultItemSizes)

See Also:

getDefaultItemSizes()