org.kuali.rice.krad.uif.lifecycle

Class RenderComponentPhase

java.lang.Object

org.kuali.rice.krad.uif.lifecycle.ViewLifecyclePhaseBase

org.kuali.rice.krad.uif.lifecycle.RenderComponentPhase

All Implemented Interfaces:

Runnable, LifecycleElementState, ViewLifecyclePhase

public class RenderComponentPhase
extends ViewLifecyclePhaseBase

Lifecycle phase processing task for rendering a component.

Author:

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

See Also:

ViewLifecycle.isRenderInLifecycle()

Constructor Summary

Constructors

Constructor and Description
RenderComponentPhase()

Method Summary

Methods

Modifier and Type	Method and Description
String	getEndViewStatus() Gets the expected view status after phase execution.
ViewLifecycle.LifecycleEvent	getEventToNotify() Gets the event to notify on completion.
String	getStartViewStatus() Gets the expected view status prior to phase execution.
String	getViewPhase() Gets the view lifecycle phase constant that corresponds to this phase processing task.
protected ViewLifecyclePhase	initializeSuccessor(LifecycleElement nestedElement, String nestedPath, Component parent) Initializes a successor of this phase for a given nested element.
protected void	initializeSuccessors(Queue<ViewLifecyclePhase> successors) Initializes queue of successor phases.
void	recycle() Resets this phase for recycling.
protected void	verifyCompleted() Verify that the all pending children have completed.

Methods inherited from class org.kuali.rice.krad.uif.lifecycle.ViewLifecyclePhaseBase

getCurrentTask, getDepth, getElement, getNestedPropertiesForRefreshPath, getParent, getParentPath, getPredecessor, getRefreshPaths, getViewPath, hasPendingSuccessors, initializeAllLifecycleSuccessors, initializeRefreshPathSuccessors, isComplete, isProcessed, notifyCompleted, prepare, processSuccessors, removePendingSuccessor, run, setNextPhase, setPredecessor, setRefreshPaths, setSkipLifecycleTasks, setTasks, setViewPath, shouldSkipLifecycle, toString, trace, validateBeforeProcessing

Methods inherited from class java.lang.Object

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

Constructor Detail

RenderComponentPhase

public RenderComponentPhase()

Method Detail

recycle

public void recycle()

Resets this phase for recycling.

Specified by:

recycle in interface ViewLifecyclePhase

Overrides:

recycle in class ViewLifecyclePhaseBase

getViewPhase

public String getViewPhase()

Gets the view lifecycle phase constant that corresponds to this phase processing task.

Returns:

UifConstants.ViewPhases.RENDER

See Also:

UifConstants.ViewPhases

getStartViewStatus

public String getStartViewStatus()

Gets the expected view status prior to phase execution.

Returns:

UifConstants.ViewStatus.FINAL

getEndViewStatus

public String getEndViewStatus()

Gets the expected view status after phase execution.

Returns:

UifConstants.ViewStatus.RENDERED

getEventToNotify

public ViewLifecycle.LifecycleEvent getEventToNotify()

Gets the event to notify on completion.

Returns:

lifecycle event to notify on completion

See Also:

ViewLifecycle.LifecycleEvent

verifyCompleted

protected void verifyCompleted()

Verify that the all pending children have completed.

Overrides:

verifyCompleted in class ViewLifecyclePhaseBase

initializeSuccessors

protected void initializeSuccessors(Queue<ViewLifecyclePhase> successors)

Initializes queue of successor phases.

This method will be called while processing this phase after all tasks have been performed, to determine phases to queue for successor processing. This phase will not be considered complete until all successors queued by this method, and all subsequent successor phases, have completed processing.

Overrides:

initializeSuccessors in class ViewLifecyclePhaseBase

Parameters:

successors - The queue of successor phases

initializeSuccessor

protected ViewLifecyclePhase initializeSuccessor(LifecycleElement nestedElement,
                                     String nestedPath,
                                     Component parent)

Initializes a successor of this phase for a given nested element.

Overrides:

initializeSuccessor in class ViewLifecyclePhaseBase

Parameters:

nestedElement - The lifecycle element

nestedPath - The path, relative to the parent element

parent - The parent component of the nested element refresh)

Returns:

successor phase