Package 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, Ordered, 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:

  • Constructor Details

    • ComponentModifierBase

      public ComponentModifierBase()

  • Method Details

    • 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:

    • 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<Component> child component prototypes
      See Also:

    • 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:

    • 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:

    • 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
      Specified by:
      setOrder in interface Ordered
      Parameters:
      order -
      See Also: