## Uses of Class
javax.faces.component.UIViewRoot

- Packages that use UIViewRoot
  Package | Description
  --- | ---
  javax.faces.application | APIs that are used to link an application's business logic objects to JavaServer Faces, as well as convenient pluggable mechanisms to manage the execution of an application that is based on JavaServer Faces.
  javax.faces.context | Classes and interfaces defining per-request state information.
  javax.faces.event | Interfaces describing events and event listeners, and concrete event implementation classes.
  javax.faces.view | Classes for defining a View Declaration Language (VDL) for authoring JavaServer Faces user interfaces.

- - ### Uses of UIViewRoot in javax.faces.application

    Methods in javax.faces.application that return UIViewRoot
    Modifier and Type | Method and Description
    --- | ---
    `UIViewRoot` | ViewHandlerWrapper.`createView(FacesContext context, String viewId)` The default behavior of this method is to call `ViewHandler.createView(javax.faces.context.FacesContext, String)` on the wrapped `ViewHandler` object.
    `abstract UIViewRoot` | ViewHandler.`createView(FacesContext context, String viewId)` Create and return a new `UIViewRoot` instance initialized with information from the argument `FacesContext` and `viewId`.
    `protected UIViewRoot` | StateManagerWrapper.`restoreTreeStructure(FacesContext context, String viewId, String renderKitId)` The default behavior of this method is to call `StateManager.restoreTreeStructure(javax.faces.context.FacesContext, String, String)` on the wrapped `StateManager` object.
    `protected UIViewRoot` | StateManager.`restoreTreeStructure(FacesContext context, String viewId, String renderKitId)` Deprecated. the distinction between tree structure and component state is now an implementation detail. The default implementation returns `null`.
    `UIViewRoot` | ViewHandlerWrapper.`restoreView(FacesContext context, String viewId)` The default behavior of this method is to call `ViewHandler.restoreView(javax.faces.context.FacesContext, String)` on the wrapped `ViewHandler` object.
    `abstract UIViewRoot` | ViewHandler.`restoreView(FacesContext context, String viewId)` Perform whatever actions are required to restore the view associated with the specified `FacesContext` and `viewId`.
    `UIViewRoot` | StateManagerWrapper.`restoreView(FacesContext context, String viewId, String renderKitId)` The default behavior of this method is to call `StateManager.restoreView(javax.faces.context.FacesContext, String, String)` on the wrapped `StateManager` object.
    `abstract UIViewRoot` | StateManager.`restoreView(FacesContext context, String viewId, String renderKitId)` Deprecated.

    Methods in javax.faces.application with parameters of type UIViewRoot
    Modifier and Type | Method and Description
    --- | ---
    `void` | ViewHandlerWrapper.`renderView(FacesContext context, UIViewRoot viewToRender)` The default behavior of this method is to call `ViewHandler.renderView(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot)` on the wrapped `ViewHandler` object.
    `abstract void` | ViewHandler.`renderView(FacesContext context, UIViewRoot viewToRender)` Perform whatever actions are required to render the response view to the response object associated with the current `FacesContext`.
    `protected void` | StateManagerWrapper.`restoreComponentState(FacesContext context, UIViewRoot viewRoot, String renderKitId)` The default behavior of this method is to call `StateManager.restoreComponentState(javax.faces.context.FacesContext, javax.faces.component.UIViewRoot, String)` on the wrapped `StateManager` object.
    `protected void` | StateManager.`restoreComponentState(FacesContext context, UIViewRoot viewRoot, String renderKitId)` Deprecated. the distinction between tree structure and component state is now an implementation detail. The default implementation does nothing.

  - ### Uses of UIViewRoot in javax.faces.context

    Methods in javax.faces.context that return UIViewRoot
    Modifier and Type | Method and Description
    --- | ---
    `UIViewRoot` | FacesContextWrapper.`getViewRoot()` The default behavior of this method is to call `FacesContext.getViewRoot()` on the wrapped `FacesContext` object.
    `abstract UIViewRoot` | FacesContext.`getViewRoot()` Return the root component that is associated with the this request.

    Methods in javax.faces.context with parameters of type UIViewRoot
    Modifier and Type | Method and Description
    --- | ---
    `void` | FacesContextWrapper.`setViewRoot(UIViewRoot root)` The default behavior of this method is to call `FacesContext.setViewRoot(UIViewRoot)` on the wrapped `FacesContext` object.
    `abstract void` | FacesContext.`setViewRoot(UIViewRoot root)` Set the root component that is associated with this request.

  - ### Uses of UIViewRoot in javax.faces.event

    Constructors in javax.faces.event with parameters of type UIViewRoot
    Constructor and Description
    `PostConstructViewMapEvent(UIViewRoot root)` Instantiate a new `PostConstructViewMapEvent` that indicates the argument `root` was just associated with its view map.
    `PreDestroyViewMapEvent(UIViewRoot root)` Instantiate a new `ViewMapDestroydEvent` that indicates the argument `root` just had its associated view map destroyed.
    `PreRenderViewEvent(UIViewRoot root)` Instantiate a new `PreRenderViewEvent` that indicates the argument `root` is about to be rendered.

  - ### Uses of UIViewRoot in javax.faces.view

    Methods in javax.faces.view that return UIViewRoot
    Modifier and Type | Method and Description
    --- | ---
    `abstract UIViewRoot` | ViewMetadata.`createMetadataView(FacesContext context)` Creates a new `UIViewRoot` containing only view parameter metadata.
    `UIViewRoot` | ViewDeclarationLanguageWrapper.`createView(FacesContext context, String viewId)`
    `abstract UIViewRoot` | ViewDeclarationLanguage.`createView(FacesContext context, String viewId)` Create a `UIViewRoot` from the VDL contained in the artifact referenced by the argument `viewId`.
    `UIViewRoot` | ViewDeclarationLanguageWrapper.`restoreView(FacesContext context, String viewId)`
    `abstract UIViewRoot` | ViewDeclarationLanguage.`restoreView(FacesContext context, String viewId)` Restore a `UIViewRoot` from a previously created view.
    `abstract UIViewRoot` | StateManagementStrategy.`restoreView(FacesContext context, String viewId, String renderKitId)` Restore the state of the view with information in the request.

    Methods in javax.faces.view with parameters of type UIViewRoot
    Modifier and Type | Method and Description
    --- | ---
    `void` | ViewDeclarationLanguageWrapper.`buildView(FacesContext context, UIViewRoot root)`
    `abstract void` | ViewDeclarationLanguage.`buildView(FacesContext context, UIViewRoot root)` Take any actions specific to this VDL implementation to cause the argument `UIViewRoot` which must have been created via a call to `ViewDeclarationLanguage.createView(javax.faces.context.FacesContext, java.lang.String)`, to be populated with children.
    `static Collection<UIViewAction>` | ViewMetadata.`getViewActions(UIViewRoot root)` Utility method to extract view metadata from the provided `UIViewRoot`.
    `static Collection<UIViewParameter>` | ViewMetadata.`getViewParameters(UIViewRoot root)` Utility method to extract view metadata from the provided `UIViewRoot`.
    `static boolean` | ViewMetadata.`hasMetadata(UIViewRoot root)` Utility method to determine if the the provided `UIViewRoot` has metadata.
    `void` | ViewDeclarationLanguageWrapper.`renderView(FacesContext context, UIViewRoot view)`
    `abstract void` | ViewDeclarationLanguage.`renderView(FacesContext context, UIViewRoot view)` Render a view rooted at argument`view`.

Copyright © 1996-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.