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

java.lang.Object
  org.kuali.rice.krad.uif.modifier.ComponentModifierBase

All Implemented Interfaces:

Serializable, ComponentModifier, org.springframework.core.Ordered

Direct Known Subclasses:

CompareFieldCreateModifier, ComponentConvertModifier, LabelFieldSeparateModifier

public abstract class ComponentModifierBase
extends Object
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 interface org.kuali.rice.krad.uif.core.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

ComponentModifierBase()

Method Summary

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	performModification(View view, Component component) Invoked within the configured phase of the component lifecycle.
void	performModification(View view, Object model, Component component) Default implementation of the overloaded performModification method that calls the version that does not take the model (more commonly implemented)
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.uif.modifier.ComponentModifier

getSupportedComponents

Constructor Detail

ComponentModifierBase

public ComponentModifierBase()

Method Detail

performModification

public void performModification(View view,
                                Object model,
                                Component component)

Default implementation of the overloaded performModification method that calls the version that does not take the model (more commonly implemented)

Specified by:

performModification in interface ComponentModifier

Parameters:

view - - the view instance to which the component belongs

model - - top level object containing the view data

component - - the component instance to modify

See Also:

ComponentModifier.performModification(org.kuali.rice.krad.uif.container.View, java.lang.Object, org.kuali.rice.krad.uif.core.Component)

performModification

public void performModification(View view,
                                Component component)

Description copied from interface: ComponentModifier

Invoked within the configured phase of the component lifecycle. This is where the ComponentModifier should perform its work against the given Component instance

Specified by:

performModification in interface ComponentModifier

Parameters:

view - - the view instance to which the component belongs

component - - the component instance to modify

See Also:

ComponentModifier.performModification(org.kuali.rice.krad.uif.container.View, org.kuali.rice.krad.uif.core.Component)

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)