org.kuali.rice.krad.uif.lifecycle

Class InitializeComponentPhase

java.lang.Object

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

org.kuali.rice.krad.uif.lifecycle.InitializeComponentPhase

All Implemented Interfaces:

Runnable, LifecycleElementState, ViewLifecyclePhase

public class InitializeComponentPhase
extends ViewLifecyclePhaseBase

Lifecycle phase processing task for initializing a component.

During the initialize phase each component of the tree is invoked to setup state based on the configuration and request options.

The initialize phase is only called once per View lifecycle

Note the View instance also contains the context Map that was created based on the parameters sent to the view service

Author:

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

Constructor Summary

Constructors

Constructor and Description
InitializeComponentPhase()

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 void	initializePendingTasks(Queue<ViewLifecycleTask<?>> tasks) Queues initialization phase tasks.
protected void	initializeSkipLifecyclePendingTasks(Queue<ViewLifecycleTask<?>> tasks) Initializes queue of pending tasks phases that need to be executed when skipping the full lifecycle.
protected ViewLifecyclePhase	initializeSuccessor(LifecycleElement nestedElement, String nestedPath, Component parent) Initializes a successor of this phase for a given nested element.

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

getCurrentTask, getDepth, getElement, getModel, getNestedPropertiesForRefreshPath, getParent, getParentPath, getPredecessor, getRefreshPaths, getViewPath, initializeAllLifecycleSuccessors, initializeRefreshPathSuccessors, initializeSuccessors, isComplete, isProcessed, notifyCompleted, prepare, processSuccessors, recycle, run, setViewPath, shouldSkipLifecycle, toString, trace, validateBeforeProcessing, verifyCompleted

Methods inherited from class java.lang.Object

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

Constructor Detail

InitializeComponentPhase

public InitializeComponentPhase()

Method Detail

getViewPhase

public String getViewPhase()

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

Returns:

UifConstants.ViewPhases.INITIALIZE

See Also:

UifConstants.ViewPhases

getStartViewStatus

public String getStartViewStatus()

Gets the expected view status prior to phase execution. return UifConstants.ViewStatus.CREATED

Returns:

expected view status prior to phase execution

getEndViewStatus

public String getEndViewStatus()

Gets the expected view status after phase execution.

Returns:

UifConstants.ViewStatus.INITIALIZED

getEventToNotify

public ViewLifecycle.LifecycleEvent getEventToNotify()

Gets the event to notify on completion.

Returns:

lifecycle event to notify on completion

See Also:

ViewLifecycle.LifecycleEvent

initializeSkipLifecyclePendingTasks

protected void initializeSkipLifecyclePendingTasks(Queue<ViewLifecycleTask<?>> tasks)

Initializes queue of pending tasks phases that need to be executed when skipping the full lifecycle.

Overrides:

initializeSkipLifecyclePendingTasks in class ViewLifecyclePhaseBase

Parameters:

tasks - The queue of tasks to perform

initializePendingTasks

protected void initializePendingTasks(Queue<ViewLifecycleTask<?>> tasks)

Queues initialization phase tasks. Initializes queue of pending tasks phases.

This method will be called before during processing to determine which tasks to perform at this phase.

Specified by:

initializePendingTasks in class ViewLifecyclePhaseBase

Parameters:

tasks - The queue of tasks to perform.

initializeSuccessor

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

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

Specified by:

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.

Returns:

successor phase