org.kuali.rice.krad.uif.layout.collections

Class CollectionLayoutManagerBase

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.collections.CollectionLayoutManagerBase

All Implemented Interfaces:

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

Direct Known Subclasses:

StackedLayoutManagerBase, TableLayoutManagerBase

public abstract class CollectionLayoutManagerBase
extends LayoutManagerBase
implements CollectionLayoutManager

Base class for collection layout managers.

Author:

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

See Also:

Serialized Form

Field Summary

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

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
CollectionLayoutManagerBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addEnterKeyDataAttributeToGroup(Group group, Map<String,Object> lineContext, ExpressionEvaluator expressionEvaluator, String enterKeyAction) Method to add and enter key add to the given Group.
Group	getAddLineGroup() Group for rendering the add line when separate (always the case for stacked layout, and a configuration for table layout).
Pager	getPagerWidget() Widget used to page the collection.
Field	getSelectFieldPrototype() Field instance that serves as a prototype for creating the select field on each line when CollectionGroup.isIncludeLineSelectionField() is true.
FieldGroup	getSubCollectionFieldGroupPrototype() Field group instance that is used as a prototype for creating the sub-collection field groups.
void	setAddLineGroup(Group addLineGroup)
void	setPagerWidget(Pager pagerWidget)
void	setSelectFieldPrototype(Field selectFieldPrototype)
void	setSubCollectionFieldGroupPrototype(FieldGroup subCollectionFieldGroupPrototype)

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.uif.layout.CollectionLayoutManager

buildLine, processPagingRequest

Methods inherited from interface org.kuali.rice.krad.uif.layout.LayoutManager

addStyleClass, appendToStyle, getAdditionalCssClasses, getCssClasses, getLibraryCssClasses, getPropertyReplacers, getStyle, getSupportedContainer, getTemplate, getTemplateName, setAdditionalCssClasses, setCssClasses, setLibraryCssClasses, setPropertyReplacers, setStyle, setTemplate, setTemplateName

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

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getContainerIdSuffix, getContext, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, performApplyModel, performFinalize, performInitialization, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setContext, setId, setPhasePathMapping, setRender, setViewPath, setViewStatus, skipLifecycle

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

clone

Constructor Detail

CollectionLayoutManagerBase

public CollectionLayoutManagerBase()

Method Detail

getAddLineGroup

public Group getAddLineGroup()

Group for rendering the add line when separate (always the case for stacked layout, and a configuration for table layout).

This group can be used to configure how the add line will be rendered. For example the layout manager configured on the group will be used to rendered the add line fields. If the header (title) is not set on the group, it will be set from CollectionGroup.getAddLabel(). In addition, CollectionGroup.getAddLineActions() will be added to the group footer items.

Specified by:

getAddLineGroup in interface CollectionLayoutManager

Returns:

Group instance for the collection add line

setAddLineGroup

public void setAddLineGroup(Group addLineGroup)

Specified by:

setAddLineGroup in interface CollectionLayoutManager

See Also:

CollectionLayoutManager.getAddLineGroup()

addEnterKeyDataAttributeToGroup

protected void addEnterKeyDataAttributeToGroup(Group group,
                                   Map<String,Object> lineContext,
                                   ExpressionEvaluator expressionEvaluator,
                                   String enterKeyAction)

Method to add and enter key add to the given Group. Will use given lineContext and expressionEvaluator if action string starts with '@{'.

Parameters:

group -

lineContext -

expressionEvaluator -

enterKeyAction -

getSelectFieldPrototype

@ViewLifecycleRestriction(value="INITIALIZE")
public Field getSelectFieldPrototype()

Field instance that serves as a prototype for creating the select field on each line when CollectionGroup.isIncludeLineSelectionField() is true.

This prototype can be used to set the control used for the select field (generally will be a checkbox control) in addition to styling and other setting. The binding path will be formed with using the CollectionGroup.getLineSelectPropertyName() or if not set the framework will use UifFormBase.getSelectedCollectionLines()

Specified by:

getSelectFieldPrototype in interface CollectionLayoutManager

Returns:

select field prototype instance

setSelectFieldPrototype

public void setSelectFieldPrototype(Field selectFieldPrototype)

Specified by:

setSelectFieldPrototype in interface CollectionLayoutManager

See Also:

CollectionLayoutManager.getSelectFieldPrototype()

getSubCollectionFieldGroupPrototype

@ViewLifecycleRestriction(value="INITIALIZE")
public FieldGroup getSubCollectionFieldGroupPrototype()

Field group instance that is used as a prototype for creating the sub-collection field groups.

Specified by:

getSubCollectionFieldGroupPrototype in interface CollectionLayoutManager

Returns:

GroupField instance to use as prototype

setSubCollectionFieldGroupPrototype

public void setSubCollectionFieldGroupPrototype(FieldGroup subCollectionFieldGroupPrototype)

Specified by:

setSubCollectionFieldGroupPrototype in interface CollectionLayoutManager

See Also:

CollectionLayoutManager.getSubCollectionFieldGroupPrototype()

getPagerWidget

public Pager getPagerWidget()

Widget used to page the collection.

The settings in this widget are only used by TableLayoutManagers which DO NOT take advantage of the RichTable option (this has its own paging implementation). To turn off RichTable and use a basic table with server paging set richTable.render="false" and useServerPaging="true" on the CollectionGroup which uses this layout manager.

Specified by:

getPagerWidget in interface CollectionLayoutManager

Returns:

the Pager widget

setPagerWidget

public void setPagerWidget(Pager pagerWidget)

Specified by:

setPagerWidget in interface CollectionLayoutManager

See Also:

CollectionLayoutManager.getPagerWidget()