org.kuali.rice.krad.uif.modifier

Class ComponentModifierBase

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

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

org.kuali.rice.krad.uif.modifier.ComponentModifierBase

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, ComponentModifier, org.springframework.core.Ordered

Direct Known Subclasses:

CompareFieldCreateModifier, ComponentConvertModifier, LabelSeparateModifier

public abstract class ComponentModifierBase
extends UifDictionaryBeanBase
implements ComponentModifier

Base class for ComponentModifier implementations

Holds run phase property and defaults to the INITIALIZE phase, and the order property for setting the order in which the component modifier will be invoked

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

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ComponentModifierBase()

Method Summary

Methods

Modifier and Type	Method and Description
List<Component>	getComponentPrototypes() List of components that are maintained by the modifier as prototypes for creating other component instances
int	getOrder()
String	getRunCondition() Conditional expression to evaluate for determining whether the component modifier should be run.
String	getRunPhase() Indicates what phase of the component lifecycle the ComponentModifier should be invoked in (INITIALIZE, APPLY_MODEL, or FINALIZE)
void	performInitialization(Object model, Component component) Default performInitialization impl (does nothing) Should be called to initialize the ComponentModifier
void	setOrder(int order) Setter for the order value
void	setRunCondition(String runCondition) Setter for the component modifiers run condition
void	setRunPhase(String runPhase) Setter for the component initializer run phase

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

clone, 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.modifier.ComponentModifier

getSupportedComponents, performModification

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

ComponentModifierBase

public ComponentModifierBase()

Method Detail

performInitialization

public void performInitialization(Object model,
                         Component component)

Default performInitialization impl (does nothing) Should be called to initialize the ComponentModifier

This is where component modifiers 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.

Note if the component modifier holds nested components, they should be initialized in this method by calling the view helper service

Specified by:

performInitialization in interface ComponentModifier

Parameters:

model - - object instance containing the view data

component - - Component the modifier is configured on

See Also:

RunComponentModifiersTask

getComponentPrototypes

public List<Component> getComponentPrototypes()

Description copied from interface: ComponentModifier

List of components that are maintained by the modifier 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.

Specified by:

getComponentPrototypes in interface ComponentModifier

Returns:

List child component prototypes

See Also:

getComponentPrototypes()

getRunPhase

public String getRunPhase()

Description copied from interface: ComponentModifier

Indicates what phase of the component lifecycle the ComponentModifier should be invoked in (INITIALIZE, APPLY_MODEL, or FINALIZE)

Specified by:

getRunPhase in interface ComponentModifier

Returns:

String view lifecycle phase

See Also:

ComponentModifier.getRunPhase()

setRunPhase

public void setRunPhase(String runPhase)

Setter for the component initializer run phase

Parameters:

runPhase -

getRunCondition

public String getRunCondition()

Description copied from interface: ComponentModifier

Conditional expression to evaluate for determining whether the component modifier should be run. If the expression evaluates to true the modifier will be executed, otherwise it will not be executed

Specified by:

getRunCondition in interface ComponentModifier

Returns:

String el expression that should evaluate to boolean

See Also:

ComponentModifier.getRunCondition()

setRunCondition

public void setRunCondition(String runCondition)

Setter for the component modifiers run condition

Parameters:

runCondition -

getOrder

public int getOrder()

Specified by:

getOrder in interface ComponentModifier

Specified by:

getOrder in interface org.springframework.core.Ordered

See Also:

Ordered.getOrder()

setOrder

public void setOrder(int order)

Description copied from interface: Ordered

Setter for the order value

Specified by:

setOrder in interface ComponentModifier

See Also:

Ordered.setOrder(int)