javax.faces.component
Class UIViewRoot

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIViewRoot
All Implemented Interfaces:
StateHolder

public class UIViewRoot
extends UIComponentBase


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String UNIQUE_ID_PREFIX
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
UIViewRoot()
          Construct an instance of the UIViewRoot.
 
Method Summary
 void addPhaseListener(PhaseListener phaseListener)
          Adds a The phaseListeners attached to ViewRoot.
 java.lang.String createUniqueId()
           
 void encodeBegin(FacesContext context)
           
 void encodeEnd(FacesContext context)
           
 javax.el.MethodExpression getAfterPhaseListener()
          Gets
 javax.el.MethodExpression getBeforePhaseListener()
          Gets
 java.lang.String getFamily()
           
 java.util.Locale getLocale()
          Gets The locale for this ViewRoot.
 java.lang.String getRenderKitId()
          Gets The initial value of this component.
 java.lang.String getViewId()
          Gets The viewId.
 void processApplication(FacesContext context)
           
 void processDecodes(FacesContext context)
           
 void processUpdates(FacesContext context)
          This isn't an input component, so just pass on the processUpdates call to child components and facets that might be input components.
 void processValidators(FacesContext context)
           
 void queueEvent(FacesEvent event)
           
 void removePhaseListener(PhaseListener phaseListener)
          Removes a The phaseListeners attached to ViewRoot.
 void restoreState(FacesContext facesContext, java.lang.Object state)
          Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
 java.lang.Object saveState(FacesContext facesContext)
          Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.
 void setAfterPhaseListener(javax.el.MethodExpression afterPhaseListener)
          Sets
 void setBeforePhaseListener(javax.el.MethodExpression beforePhaseListener)
          Sets
 void setLocale(java.util.Locale locale)
          Sets The locale for this ViewRoot.
 void setRenderKitId(java.lang.String renderKitId)
          Sets The initial value of this component.
 void setViewId(java.lang.String viewId)
          Sets The viewId.
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId, getValueExpression, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

UNIQUE_ID_PREFIX

public static final java.lang.String UNIQUE_ID_PREFIX
See Also:
Constant Field Values
Constructor Detail

UIViewRoot

public UIViewRoot()
Construct an instance of the UIViewRoot.

Method Detail

queueEvent

public void queueEvent(FacesEvent event)
Overrides:
queueEvent in class UIComponentBase

processDecodes

public void processDecodes(FacesContext context)
Overrides:
processDecodes in class UIComponentBase

processValidators

public void processValidators(FacesContext context)
Overrides:
processValidators in class UIComponentBase

processUpdates

public void processUpdates(FacesContext context)
Description copied from class: UIComponentBase
This isn't an input component, so just pass on the processUpdates call to child components and facets that might be input components.

Components that were never rendered can't possibly be receiving update data (no corresponding fields were ever put into the response) so if this component is not rendered then this method does not invoke processUpdates on its children.

Overrides:
processUpdates in class UIComponentBase

processApplication

public void processApplication(FacesContext context)

encodeBegin

public void encodeBegin(FacesContext context)
                 throws java.io.IOException
Overrides:
encodeBegin in class UIComponentBase
Throws:
java.io.IOException

encodeEnd

public void encodeEnd(FacesContext context)
               throws java.io.IOException
Overrides:
encodeEnd in class UIComponentBase
Throws:
java.io.IOException

createUniqueId

public java.lang.String createUniqueId()

getLocale

public java.util.Locale getLocale()
Gets The locale for this ViewRoot.

Returns:
the new locale value

setLocale

public void setLocale(java.util.Locale locale)
Sets The locale for this ViewRoot.

Parameters:
locale - the new locale value

getRenderKitId

public java.lang.String getRenderKitId()
Gets The initial value of this component.

Returns:
the new renderKitId value

setRenderKitId

public void setRenderKitId(java.lang.String renderKitId)
Sets The initial value of this component.

Parameters:
renderKitId - the new renderKitId value

getViewId

public java.lang.String getViewId()
Gets The viewId.

Returns:
the new viewId value

setViewId

public void setViewId(java.lang.String viewId)
Sets The viewId.

Parameters:
viewId - the new viewId value

addPhaseListener

public void addPhaseListener(PhaseListener phaseListener)
Adds a The phaseListeners attached to ViewRoot.


removePhaseListener

public void removePhaseListener(PhaseListener phaseListener)
Removes a The phaseListeners attached to ViewRoot.


getBeforePhaseListener

public javax.el.MethodExpression getBeforePhaseListener()
Gets

Returns:
the new beforePhaseListener value

setBeforePhaseListener

public void setBeforePhaseListener(javax.el.MethodExpression beforePhaseListener)
Sets

Parameters:
beforePhaseListener - the new beforePhaseListener value

getAfterPhaseListener

public javax.el.MethodExpression getAfterPhaseListener()
Gets

Returns:
the new afterPhaseListener value

setAfterPhaseListener

public void setAfterPhaseListener(javax.el.MethodExpression afterPhaseListener)
Sets

Parameters:
afterPhaseListener - the new afterPhaseListener value

saveState

public java.lang.Object saveState(FacesContext facesContext)
Description copied from class: UIComponentBase
Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.

Specified by:
saveState in interface StateHolder
Overrides:
saveState in class UIComponentBase

restoreState

public void restoreState(FacesContext facesContext,
                         java.lang.Object state)
Description copied from class: UIComponentBase
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIComponentBase
state - is an object previously returned by the saveState method of this class.

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class UIComponent


Copyright © 2009 Apache Software Foundation. All Rights Reserved.