Class Hierarchy All Classes All Fields and Methods

 

Class javax.faces.component.UIViewRoot 

java.lang.Object
        javax.faces.component.UIComponent
                javax.faces.component.UIComponentBase
                        javax.faces.component.UIViewRoot

public class UIViewRoot
extends UIComponentBase

UIViewRoot is the UIComponent that represents the root of the UIComponent tree. This component has no rendering, it just serves as the root of the component tree.

Field Index
Field Description
COMPONENT_FAMILY The standard component family for this component.
COMPONENT_TYPE The standard component type for this component.
UNIQUE_ID_PREFIX The prefix that will be used for identifiers generated by the createUniqueId() method.

Constructor Index
Constructor Description
UIViewRoot() Create a new UIViewRoot instance with default property values.

Method Index
Method Description
String createUniqueId() Generate an identifier for a component.
void encodeBegin(FacesContext) Override the default encodeBegin behavior to reset the mechanism used in createUniqueId before falling through to the standard superclass processing.
long getCreated() Return the time this view was created.
String getFamily()  
Locale getLocale() Return the Locale to be used in localizing the response being created for this view.
String getRenderKitId() Return the render kit identifier of the RenderKit associated with this view.
String getViewId() Return the view identifier for this view.
void processApplication(FacesContext) Broadcast any events that have been queued for the Invoke Application phase of the request processing lifecycle.
void processDecodes(FacesContext) Override the default processDecodes behavior to broadcast any queued events after the default processing has been completed and to clear out any events for later phases if the event processing for this phase caused renderResponse to be called.
void processUpdates(FacesContext) Override the default UIComponentBase behavior to broadcast any queued events after the default processing has been completed.
void processValidators(FacesContext) Override the default processValidators behavior to broadcast any queued events after the default processing has been completed and to clear out any events for later phases if the event processing for this phase caused renderResponse to be called.
void queueEvent(FacesEvent) Override the default queueEvent behavior to accumulate the queued events for later broadcaster.
void restoreState(FacesContext, Object)  
Object saveState(FacesContext)  
void setCreated(long) Set the Set the creation timestam for this piew.
void setLocale(Locale) Set the Locale to be used in localizing the response being created for this view.
void setRenderKitId(String) Set the render kit identifier of the RenderKit associated with this view.
void setViewId(String) Set the view identifier for this view.

 

Fields

 

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

 

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

 

UNIQUE_ID_PREFIX

public static final java.lang.String UNIQUE_ID_PREFIX

The prefix that will be used for identifiers generated by the createUniqueId() method.

 

Constructors

 

UIViewRoot

public UIViewRoot()

Create a new UIViewRoot instance with default property values.

 

Methods

 

createUniqueId

public String createUniqueId()

Generate an identifier for a component. The identifier will be prefixed with UNIQUE_ID_PREFIX, and will be unique within this UIViewRoot.

 

encodeBegin

public void encodeBegin(FacesContext context) throws IOException

Override the default encodeBegin behavior to reset the mechanism used in createUniqueId before falling through to the standard superclass processing.

 

getCreated

public long getCreated()

Return the time this view was created.

 

getFamily

public String getFamily()

 

getLocale

public Locale getLocale()

Return the Locale to be used in localizing the response being created for this view.

Algorithm:

If we have a locale ivar, return it. If we have a value binding for "locale", get its value. If the value is null, return the result of calling calculateLocale. If the value is an instance of java.util.Locale return it. If the value is a String, convert it to a java.util.Locale and return it. If there is no value binding for "locale", return the result of calling calculateLocale.

 

getRenderKitId

public String getRenderKitId()

Return the render kit identifier of the RenderKit associated with this view. Unless explicitly set, this will be the value defined by RenderKitFactory.HTML_BASIC_RENDER_KIT.

 

getViewId

public String getViewId()

Return the view identifier for this view.

 

processApplication

public void processApplication(FacesContext context)

Broadcast any events that have been queued for the Invoke Application phase of the request processing lifecycle.

 

processDecodes

public void processDecodes(FacesContext context)

Override the default processDecodes behavior to broadcast any queued events after the default processing has been completed and to clear out any events for later phases if the event processing for this phase caused renderResponse to be called.

 

processUpdates

public void processUpdates(FacesContext context)

Override the default UIComponentBase behavior to broadcast any queued events after the default processing has been completed.

 

processValidators

public void processValidators(FacesContext context)

Override the default processValidators behavior to broadcast any queued events after the default processing has been completed and to clear out any events for later phases if the event processing for this phase caused renderResponse to be called.

 

queueEvent

public void queueEvent(FacesEvent event)

Override the default queueEvent behavior to accumulate the queued events for later broadcaster.

 

restoreState

public void restoreState(FacesContext context,
                         Object state)

 

saveState

public Object saveState(FacesContext context)

 

setCreated

public void setCreated(long created)

Set the Set the creation timestam for this piew.

 

setLocale

public void setLocale(Locale locale)

Set the Locale to be used in localizing the response being created for this view.

 

setRenderKitId

public void setRenderKitId(String renderKitId)

Set the render kit identifier of the RenderKit associated with this view. This method may be called at any time between the end of Apply Request Values phase of the request processing lifecycle (i.e. when events are being broadcast) and the beginning of the Render Response phase.

 

setViewId

public void setViewId(String viewId)

Set the view identifier for this view.

Class Hierarchy All Classes All Fields and Methods