Package org.kuali.rice.krad.uif.lifecycle

Interface LifecycleElementState

All Known Subinterfaces:
ViewLifecyclePhase
All Known Implementing Classes:
ApplyModelComponentPhase, FinalizeComponentPhase, InitializeComponentPhase, PreProcessElementPhase, RenderComponentPhase, ViewLifecyclePhaseBase
public interface LifecycleElementState
Handles delivery of per-node parse state for path-based view lifecycle algorithms.

The interface is used for assigning the path property value during the View's pre-process phase.

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getDepth()
    Gets the depth of the element in the lifecycle tree.
    LifecycleElement
    getElement()
    Gets the element this lifecycle phase is responsible for processing.
    String
    getParentPath()
    Gets the path relative the predecessor phase's component.
    String
    getViewPath()
    Gets the path relative to the view.
    String
    getViewPhase()
    Gets the view lifecycle phase constant that corresponds to this phase processing task.

  • Method Details

    • getViewPhase

      String getViewPhase()
      Gets the view lifecycle phase constant that corresponds to this phase processing task.
      Returns:
      view lifecycle phase constant corresponding to this phase
      See Also:

    • getViewPath

      String getViewPath()
      Gets the path relative to the view.
      Returns:
      path relative the the view

    • getElement

      LifecycleElement getElement()
      Gets the element this lifecycle phase is responsible for processing.
      Returns:
      element this lifecycle phase is responsible for processing

    • getParentPath

      String getParentPath()
      Gets the path relative the predecessor phase's component.
      Returns:
      path relative the predecessor phase's component

    • getDepth

      int getDepth()
      Gets the depth of the element in the lifecycle tree.
      Returns:
      The depth of the element in the lifecycle tree.