org.kuali.rice.krad.uif.layout
Interface CollectionLayoutManager

All Superinterfaces:

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

All Known Subinterfaces:

StackedLayoutManager, TableLayoutManager

All Known Implementing Classes:

StackedLayoutManagerBase, TableLayoutManagerBase

public interface CollectionLayoutManager
extends LayoutManager

Layout manager implementations that work with a collection (such as a table layout) should implement this interface for building the collection component instances.

Unlike other group instances, collection group instances need to generate new instances of the configured components for each line of the collection. The field instances for each line are wrapped differently depending on what layout manager is being applied. Therefore as the collection lines are being built (during the applyModel phase) this method will be invoked on the manager so that it may setup the line as needed.

Author:

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

See Also:

CollectionGroupBuilder

Method Summary

void	buildLine(LineBuilderContext lineBuilderContext) Call to the layout manager to build the components necessary for the given collection line, within an active view lifecycle.
FieldGroup	getSubCollectionFieldGroupPrototype() Field group instance that is used as a prototype for creating the sub-collection field groups.
void	processPagingRequest(Object model, CollectionGroup collectionGroup) Invoked when a paging request occurs to carry out the paging request.

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

Method Detail

buildLine

void buildLine(LineBuilderContext lineBuilderContext)

Call to the layout manager to build the components necessary for the given collection line, within an active view lifecycle.

As the collection is being iterated over by the CollectionGroupLineBuilder this method is invoked for each line. The builder will create copies of the configured fields and actions for the line and pass into the layout manager so they can be assembled

Parameters:

lineBuilderContext - context for the line to be built

getSubCollectionFieldGroupPrototype

FieldGroup getSubCollectionFieldGroupPrototype()

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

Returns:

GroupField instance to use as prototype

processPagingRequest

void processPagingRequest(Object model,
                          CollectionGroup collectionGroup)

Invoked when a paging request occurs to carry out the paging request.

Parameters:

model - object containing the view's data

collectionGroup - collection group the request was made for