org.kuali.rice.krad.uif.layout

Class CssGridLayoutManagerBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CssGridLabelColumnLayoutManager, CssGridLayoutManager

public abstract class CssGridLayoutManagerBase
extends LayoutManagerBase

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

Author:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	BOOTSTRAP_SPAN_PREFIX
protected List<String>	cellCssClassAttributes
protected List<Component>	cellItems
protected int	lgTotalSize
protected int	mdTotalSize
protected static int	NUMBER_OF_COLUMNS
protected int	smTotalSize
protected int	xsTotalSize

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

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
CssGridLayoutManagerBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addLeftClearCssClass(List<String> cellCssClasses) Adds a class (or classeees) which will clear the left float for wrapped content at each screen size, which will prevent natural float from taking available space instead of wrapping to a new "row".
protected void	calculateCssClassAndSize(Component item, List<String> cellCssClasses, CssGridSizes defaultSizes, int basicSize) Determines the css class(es) and based on what settings the item, defaultSizes and basicSize have
List<String>	getCellCssClassAttributes() List of css class HTML attribute values ordered by the order in which the cell appears
List<Component>	getCellItems() Get the items which will make up each "cell" divs of this css grid layout, these divs will have appropriate css class applied to them based on the values stored in cellCssClassAttributes
protected String	getCellStyleClassesAsString(List<String> cellCssClasses) Builds the HTML class attribute string by combining the cellStyleClasses list with a space delimiter

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, performFinalize, 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

Field Detail

NUMBER_OF_COLUMNS

protected static final int NUMBER_OF_COLUMNS

See Also:

Constant Field Values

BOOTSTRAP_SPAN_PREFIX

protected static final String BOOTSTRAP_SPAN_PREFIX

See Also:

Constant Field Values

cellItems

protected List<Component> cellItems

cellCssClassAttributes

protected List<String> cellCssClassAttributes

xsTotalSize

protected int xsTotalSize

smTotalSize

protected int smTotalSize

mdTotalSize

protected int mdTotalSize

lgTotalSize

protected int lgTotalSize

Constructor Detail

CssGridLayoutManagerBase

public CssGridLayoutManagerBase()

Method Detail

calculateCssClassAndSize

protected void calculateCssClassAndSize(Component item,
                            List<String> cellCssClasses,
                            CssGridSizes defaultSizes,
                            int basicSize)

Determines the css class(es) and based on what settings the item, defaultSizes and basicSize have

Priority of what sizes to apply are as follows: 1. cssGridSizes on the item itself 2. Sizes in the defaultSizes object 3. basicSize passed in the if the above two contain no settings, defaults to md (medium) col size

Parameters:

item - the item to process classes for

cellCssClasses - the list of classes to add the new class string to

defaultSizes - the default fallback sizes to use if items have none

basicSize - the fallback md size to use if both item and default size have none

addLeftClearCssClass

protected void addLeftClearCssClass(List<String> cellCssClasses)

Adds a class (or classeees) which will clear the left float for wrapped content at each screen size, which will prevent natural float from taking available space instead of wrapping to a new "row".

Parameters:

cellCssClasses - the set of css classes to add the left clear class to

getCellStyleClassesAsString

protected String getCellStyleClassesAsString(List<String> cellCssClasses)

Builds the HTML class attribute string by combining the cellStyleClasses list with a space delimiter

Parameters:

cellCssClasses - list of cell CSS classes

Returns:

class attribute string

getCellItems

@ViewLifecycleRestriction
public List<Component> getCellItems()

Get the items which will make up each "cell" divs of this css grid layout, these divs will have appropriate css class applied to them based on the values stored in cellCssClassAttributes

Returns:

the items of this cssGrid

getCellCssClassAttributes

public List<String> getCellCssClassAttributes()

List of css class HTML attribute values ordered by the order in which the cell appears

Returns:

the list of css class HTML attributes for cells