org.kuali.rice.krad.uif.layout

Interface LayoutManager

All Superinterfaces:

DictionaryBean, Serializable, UifDictionaryBean

All Known Subinterfaces:

CollectionLayoutManager

All Known Implementing Classes:

BoxLayoutManager, CssGridLayoutManager, GridLayoutManager, LayoutManagerBase, ListLayoutManager, StackedLayoutManager, TableLayoutManager

public interface LayoutManager
extends UifDictionaryBean, Serializable

Manages the rendering of Component instances within a Container

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addStyleClass(String styleClass) This method adds a single style class to the list of css style classes on this component
void	appendToStyle(String styleRules) Appends to the inline style set on this layoutManager
<T> T	copy() Copy the object
List<String>	getAdditionalCssClasses()
List<Component>	getComponentPrototypes() List of components that are maintained by the layout manager as prototypes for creating other component instances
List<Component>	getComponentsForLifecycle() List of components that are contained within the layout manager that should be sent through the lifecycle
Map<String,Object>	getContext() Context map for the layout manager
List<String>	getCssClasses() CSS style class(s) to be applied to the area (div) the layout manager generates for the items
String	getId() The unique id (within a given tree) for the layout manager instance
List<String>	getLibraryCssClasses()
List<PropertyReplacer>	getPropertyReplacers() List of PropertyReplacer instances that will be evaluated during the view lifecycle to conditional set properties on the LayoutManager based on expression evaluations
String	getStyle() CSS style string to be applied to the area (div) the layout manager generates for the items
Class<? extends Container>	getSupportedContainer() Determines what Container classes are supported by the LayoutManager
String	getTemplate() The path to the JSP file that should be called to invoke the layout manager
String	getTemplateName() The name for which the template can be invoked by
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 last phase before the view is rendered.
void	performInitialization(View view, Object model, Container container) Should be called to initialize the layout manager
void	pushAllToContext(Map<String,Object> sourceContext) Places all entries from a map into the context Map for the layout manager.
void	pushObjectToContext(String objectName, Object object) Places the given object into the context Map for the layout manager with the given name
void	setAdditionalCssClasses(List<String> libraryClasses)
void	setContext(Map<String,Object> context) Setter for the context Map
void	setCssClasses(List<String> styleClasses) Setter for the layout manager div style class
void	setId(String id) Sets the unique id (within a given tree) for the layout manager
void	setLibraryCssClasses(List<String> libraryClasses)
void	setPropertyReplacers(List<PropertyReplacer> propertyReplacers) Setter for the layout managers property substitutions
void	setStyle(String style) Setter for the layout manager div style
void	setTemplate(String template) Setter for the layout managers template
void	setTemplateName(String templateName) Setter for the name of the template (a name which can be used to invoke)

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

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

getComponentCode, getNamespaceCode

Method Detail

getId

String getId()

The unique id (within a given tree) for the layout manager instance

The id is used to identify a LayoutManager instance within the tree and can be used by renderers

Returns:

String id

setId

void setId(String id)

Sets the unique id (within a given tree) for the layout manager

Parameters:

id - - string to set as the layout manager id

getTemplate

String getTemplate()

The path to the JSP file that should be called to invoke the layout manager

The path should be relative to the web root. All layout manager templates receive the list of items of be placed, the configured layout manager, and the container to which the layout manager applies

e.g. '/krad/WEB-INF/jsp/tiles/boxLayout.jsp'

Returns:

String representing the template path

setTemplate

void setTemplate(String template)

Setter for the layout managers template

Parameters:

template -

getTemplateName

String getTemplateName()

The name for which the template can be invoked by

Whether the template name is needed depends on the underlying rendering engine being used. In the example of Freemarker, the template points to the actual source file, which then loads a macro. From then on the macro is simply invoked to execute the template

e.g. 'uif_grid'

Returns:

setTemplateName

void setTemplateName(String templateName)

Setter for the name of the template (a name which can be used to invoke)

Parameters:

templateName -

performInitialization

void performInitialization(View view,
                         Object model,
                         Container container)

Should be called to initialize the layout manager

This is where layout managers can set defaults and setup other necessary state. The initialize method should only be called once per layout manager lifecycle and is invoked within the initialize phase of the view lifecylce.

Parameters:

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

model - - the object instance containing the view data

container - - Container the layout manager applies to

See Also:

ViewHelperService.performInitialization(org.kuali.rice.krad.uif.view.View, java.lang.Object)

performApplyModel

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

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

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

performFinalize

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

The last phase before the view is rendered. Here final preparations can be made based on the updated view state

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

container - - Container the layout manager applies to

getSupportedContainer

Class<? extends Container> getSupportedContainer()

Determines what Container classes are supported by the LayoutManager

Returns:

Class container class supported

getComponentsForLifecycle

List<Component> getComponentsForLifecycle()

List of components that are contained within the layout manager that should be sent through the lifecycle

Used by ViewHelperService for the various lifecycle callbacks

Returns:

List child components

getComponentPrototypes

List<Component> getComponentPrototypes()

List of components that are maintained by the layout manager as prototypes for creating other component instances

Prototypes are held for configuring how a component should be created during the lifecycle. An example of this are the fields in a collection group that are created for each collection record. They only participate in the initialize phase.

Returns:

List child component prototypes

getStyle

String getStyle()

CSS style string to be applied to the area (div) the layout manager generates for the items

Note the styleClass/style configured on the Container applies to all the container content (header, body, footer), while the styleClass/style configured on the LayoutManager only applies to the div surrounding the items placed by the manager (the container's body)

Any style override or additions can be specified with this attribute. This is used by the renderer to set the style attribute on the corresponding element.

e.g. 'color: #000000;text-decoration: underline;'

Returns:

String css style string

setStyle

void setStyle(String style)

Setter for the layout manager div style

Parameters:

style -

getLibraryCssClasses

List<String> getLibraryCssClasses()

setLibraryCssClasses

void setLibraryCssClasses(List<String> libraryClasses)

getCssClasses

List<String> getCssClasses()

CSS style class(s) to be applied to the area (div) the layout manager generates for the items

Note the styleClass/style configured on the Container applies to all the container content (header, body, footer), while the styleClass/style configured on the LayoutManager only applies to the div surrounding the items placed by the manager (the container's body)

Declares additional style classes for the div. Multiple classes are specified with a space delimiter. This is used by the renderer to set the class attribute on the corresponding element. The class(s) declared must be available in the common style sheets or the style sheets specified for the view

e.g. 'header left'

Returns:

List css style classes to apply

setCssClasses

void setCssClasses(List<String> styleClasses)

Setter for the layout manager div style class

Parameters:

styleClasses -

getAdditionalCssClasses

List<String> getAdditionalCssClasses()

setAdditionalCssClasses

void setAdditionalCssClasses(List<String> libraryClasses)

addStyleClass

void addStyleClass(String styleClass)

This method adds a single style class to the list of css style classes on this component

Parameters:

styleClass -

getContext

Map<String,Object> getContext()

Context map for the layout manager

Returns:

Map context

See Also:

Component.getContext()

appendToStyle

void appendToStyle(String styleRules)

Appends to the inline style set on this layoutManager

Parameters:

styleRules -

setContext

void setContext(Map<String,Object> context)

Setter for the context Map

Parameters:

context -

pushObjectToContext

void pushObjectToContext(String objectName,
                       Object object)

Places the given object into the context Map for the layout manager with the given name

See Also:

Component.pushObjectToContext(String, Object)

pushAllToContext

void pushAllToContext(Map<String,Object> sourceContext)

Places all entries from a map into the context Map for the layout manager.

Parameters:

sourceContext - The map to push entries from.

See Also:

org.kuali.rice.krad.uif.component.Component#pushToContext(Map, Object)

getPropertyReplacers

List<PropertyReplacer> getPropertyReplacers()

List of PropertyReplacer instances that will be evaluated during the view lifecycle to conditional set properties on the LayoutManager based on expression evaluations

Returns:

List replacers to evaluate

setPropertyReplacers

void setPropertyReplacers(List<PropertyReplacer> propertyReplacers)

Setter for the layout managers property substitutions

Parameters:

propertyReplacers -

copy

<T> T copy()

Copy the object

Returns:

the copied object