Package com.webmethods.caf.faces.component

Class ViewRoot

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIViewRoot

com.webmethods.caf.faces.component.ViewRoot

All Implemented Interfaces:

EventListener, NamingContainer, PartialStateHolder, StateHolder, TransientStateHolder, UniqueIdVendor, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder

public class ViewRoot
extends UIViewRoot
implements NamingContainer

View root.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<List<FacesEvent>>	m_events	Two-dimensional list of FacesEvents (a separate list for each phase).
protected int	m_uniqueId	Next unique-id suffix for components with auto-generated ids.
static final String	PORTLET_NAMESPACE_PARAM	Param to use to store portlet namespace.
static final String	PREFIX_UNIQUE_ID	Unique-id prefix for components with auto-generated ids.

Fields inherited from class javax.faces.component.UIViewRoot

COMPONENT_FAMILY, COMPONENT_TYPE, METADATA_FACET_NAME, UNIQUE_ID_PREFIX, VIEW_PARAMETERS_KEY, VIEWROOT_PHASE_LISTENER_QUEUES_EXCEPTIONS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor	Description
ViewRoot()

Method Summary

Modifier and Type	Method	Description
void	addComponentResource(FacesContext context, UIComponent componentResource, String target)
void	broadcastEvents(FacesContext context, PhaseId phaseId)	Broadcasts queued events for specified phase.
protected String	calculateId()	Calculates an id for this view root that will be unique on a portal page.
protected void	clearEventQueue()	Clears all pending events from event queues.
String	createUniqueId()
void	encodeBegin(FacesContext context)
UIComponent	getFacet(String name)
protected void	initEventQueue()	Lazy-inits event queue, if not already initialized.
void	processApplication(FacesContext context)
void	processDecodes(FacesContext context)
void	processUpdates(FacesContext context)
void	processValidators(FacesContext context)
void	queueEvent(FacesEvent event)
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)

Methods inherited from class javax.faces.component.UIViewRoot

addComponentResource, addPhaseListener, createUniqueId, encodeChildren, encodeEnd, getAfterPhaseListener, getBeforePhaseListener, getComponentResources, getComponentResources, getFamily, getLocale, getPhaseListeners, getRenderKitId, getRendersChildren, getViewId, getViewListenersForEventClass, getViewMap, getViewMap, isInView, processEvent, processRestoreState, removeComponentResource, removeComponentResource, removePhaseListener, resetValues, restoreViewScopeState, setAfterPhaseListener, setBeforePhaseListener, setInView, setLocale, setRenderKitId, setViewId, subscribeToViewEvent, unsubscribeFromViewEvent

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isVisitable, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Field Details

PREFIX_UNIQUE_ID

public static final String PREFIX_UNIQUE_ID

Unique-id prefix for components with auto-generated ids.

See Also:

• Constant Field Values

PORTLET_NAMESPACE_PARAM

public static final String PORTLET_NAMESPACE_PARAM

Param to use to store portlet namespace.

See Also:

• Constant Field Values

m_uniqueId

protected int m_uniqueId

Next unique-id suffix for components with auto-generated ids.

m_events

protected transient List<List<FacesEvent>> m_events

Two-dimensional list of FacesEvents (a separate list for each phase).

Constructor Details

ViewRoot

public ViewRoot()

Method Details

restoreState

public void restoreState(FacesContext context,
 Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIViewRoot

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIViewRoot

createUniqueId

public String createUniqueId()

Overrides:

createUniqueId in class UIViewRoot

queueEvent

public void queueEvent(FacesEvent event)

Overrides:

queueEvent in class UIViewRoot

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIViewRoot

Throws:

IOException

processDecodes

public void processDecodes(FacesContext context)

Overrides:

processDecodes in class UIViewRoot

processValidators

public void processValidators(FacesContext context)

Overrides:

processValidators in class UIViewRoot

processUpdates

public void processUpdates(FacesContext context)

Overrides:

processUpdates in class UIViewRoot

processApplication

public void processApplication(FacesContext context)

Overrides:

processApplication in class UIViewRoot

calculateId

protected String calculateId()

Calculates an id for this view root that will be unique on a portal page.

broadcastEvents

public void broadcastEvents(FacesContext context,
 PhaseId phaseId)

Broadcasts queued events for specified phase. TODO: verify that this works for JSF 2.x

Overrides:

broadcastEvents in class UIViewRoot

initEventQueue

protected void initEventQueue()

Lazy-inits event queue, if not already initialized.

clearEventQueue

protected void clearEventQueue()

Clears all pending events from event queues.

getFacet

public UIComponent getFacet(String name)

Overrides:

getFacet in class UIComponentBase

addComponentResource

public void addComponentResource(FacesContext context,
 UIComponent componentResource,
 String target)

Overrides:

addComponentResource in class UIViewRoot