javax.faces.component
Class UIViewRoot

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

All Implemented Interfaces:

StateHolder

public class UIViewRoot
extends UIComponentBase

Creates a JSF View, which is a container that holds all of the components that are part of the view.

Unless otherwise specified, all attributes accept static values or EL expressions.

See Javadoc of JSF Specification

Version:

$Revision: 684538 $ $Date: 2008-08-10 11:11:38 -0500 (Sun, 10 Aug 2008) $

Author:

Manfred Geiler (latest modification by $Author: skitching $)

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	UNIQUE_ID_PREFIX

Constructor Summary

UIViewRoot()

Method Summary

java.lang.String	createUniqueId() Provides a unique id for this component instance.
void	encodeBegin(FacesContext context)
java.lang.String	getClientId(FacesContext context) DO NOT USE.
java.lang.String	getFamily()
java.lang.String	getId() An identifier for this particular component instance within a component view.
java.util.Locale	getLocale() The locale of this view.
java.lang.String	getRenderKitId() Defines what renderkit should be used to render this view.
java.lang.String	getViewId()
boolean	isRendered() A boolean value that indicates whether this component should be rendered.
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	restoreState(FacesContext context, 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 context) 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	setId(java.lang.String id) DO NOT USE.
void	setLocale(java.util.Locale locale)
void	setRendered(boolean state) DO NOT USE.
void	setRenderKitId(java.lang.String renderKitId)
void	setViewId(java.lang.String viewId)

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

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()

Method Detail

getViewId

public java.lang.String getViewId()

setViewId

public void setViewId(java.lang.String viewId)

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

createUniqueId

public java.lang.String createUniqueId()

Provides a unique id for this component instance.

getLocale

public java.util.Locale getLocale()

The locale of this view. Default: the default locale from the configuration file.

setLocale

public void setLocale(java.util.Locale locale)

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIComponent

getRenderKitId

public java.lang.String getRenderKitId()

Defines what renderkit should be used to render this view.

Note that in JSF1.1 this property cannot be set via the f:view tag (this is possible in JSF1.2).

setRenderKitId

public void setRenderKitId(java.lang.String renderKitId)

setRendered

public void setRendered(boolean state)

DO NOT USE.

Although this class extends a base-class that defines a read/write rendered property, it makes no sense for this particular subclass to support it. Yes, this is broken OO design: direct all complaints to the JSF spec group.

Ideally this method would throw an UnsupportedOperationException when invoked. Unfortunately, the JSF TCK calls this method, so instead we just pass on the call to the default inherited implementation.

Overrides:

setRendered in class UIComponentBase

isRendered

public boolean isRendered()

Description copied from class: UIComponentBase

A boolean value that indicates whether this component should be rendered. Default value: true.

Overrides:

isRendered in class UIComponentBase

setId

public void setId(java.lang.String id)

DO NOT USE.

Although this class extends a base-class that defines a read/write id property, it makes no sense for this particular subclass to support it. The tag library does not export this property for use, but there is no way to "undeclare" a java method. Yes, this is broken OO design: direct all complaints to the JSF spec group.

This property should be disabled (ie throw an exception if invoked). However there are currently several places that call this method (eg during restoreState) so it just does the normal thing for the moment. TODO: fix callers then make this throw an exception.

Overrides:

setId in class UIComponentBase

getId

public java.lang.String getId()

Description copied from class: UIComponentBase

An identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

Overrides:

getId in class UIComponentBase

getClientId

public java.lang.String getClientId(FacesContext context)

DO NOT USE.

As this component has no "id" property, it has no clientId property either.

Ideally, this method would just return null when called (or even throw an exception) Unforunately, the TCK invokes it so we just invoke the interited implementation instead.

Overrides:

getClientId in class UIComponentBase

saveState

public java.lang.Object saveState(FacesContext context)

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 context,
                         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.