org.richfaces.context

## Class ExtendedRenderVisitContext

- java.lang.Object
- - javax.faces.component.visit.VisitContext
  - - javax.faces.component.visit.VisitContextWrapper
    - - org.richfaces.context.ExtendedVisitContext
      - - org.richfaces.context.BaseExtendedVisitContext
        - - org.richfaces.context.ExtendedRenderVisitContext

- All Implemented Interfaces:
    javax.faces.FacesWrapper<javax.faces.component.visit.VisitContext>

      public class ExtendedRenderVisitContext
      extends BaseExtendedVisitContext

  Wraps parent `VisitContext` and executes following operations:

  - makes sure implicit rendering areas (`AjaxOutput`s) are also visited
  - executes `MetaComponentEncodingVisitCallback` during `invokeVisitCallback(UIComponent, VisitCallback)` method.
  Author:
    Nick Belaevski

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.richfaces.context.BaseExtendedVisitContext

      `BaseExtendedVisitContext.ClientIdTrackingStrategy`

  - ### Field Summary

    - ### Fields inherited from class org.richfaces.context.BaseExtendedVisitContext

      `addNode, removeNode`

    - ### Fields inherited from class org.richfaces.context.ExtendedVisitContext

      `META_COMPONENT_ID`

    - ### Fields inherited from class javax.faces.component.visit.VisitContext

      `ALL_IDS`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `ExtendedRenderVisitContext(javax.faces.component.visit.VisitContext visitContextToWrap, javax.faces.context.FacesContext facesContext, Collection<String> clientIds, Set<javax.faces.component.visit.VisitHint> hints, boolean limitRender)`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `addDirectSubtreeIdsToVisitForImplicitComponents(javax.faces.component.UIComponent component, Set<String> result)` Allows to add subtrees that contains implicit components to list IDs to visit
    `protected boolean` | `hasImplicitSubtreeIdsToVisit(javax.faces.component.UIComponent component)` Return true whether this `VisitContext` allows to visit implicit IDs
    `javax.faces.component.visit.VisitResult` | `invokeVisitCallback(javax.faces.component.UIComponent component, javax.faces.component.visit.VisitCallback callbackToWrap)` Instead of execution of `VisitCallback` directly, we use `MetaComponentEncodingVisitCallback` that executes additional logic for meta-component encoding.
    `protected javax.faces.component.visit.VisitResult` | `invokeVisitCallbackForImplicitComponent(javax.faces.component.UIComponent component, javax.faces.component.visit.VisitCallback callback)`
    `static boolean` | `isExtendedRenderVisitContext(javax.faces.component.visit.VisitContext visitContext)` Determine if the VisitContext is, or wraps, the RenderExtendedVisitContext
    `protected boolean` | `shouldCompleteOnEmptyIds()`

    - ### Methods inherited from class org.richfaces.context.BaseExtendedVisitContext

      `createNamingContainerVisitContext, getDirectSubtreeIdsToVisit, getIdsToVisit, getSubtreeIdsToVisit, visitClientId`

    - ### Methods inherited from class org.richfaces.context.ExtendedVisitContext

      `buildExtendedClientId, buildExtendedComponentId, getFacesContext, getVisitMode, getWrapped, invokeMetaComponentVisitCallback`

    - ### Methods inherited from class javax.faces.component.visit.VisitContextWrapper

      `getHints`

    - ### Methods inherited from class javax.faces.component.visit.VisitContext

      `createVisitContext, createVisitContext`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### ExtendedRenderVisitContext

          public ExtendedRenderVisitContext(javax.faces.component.visit.VisitContext visitContextToWrap,
                                    javax.faces.context.FacesContext facesContext,
                                    Collection<String> clientIds,
                                    Set<javax.faces.component.visit.VisitHint> hints,
                                    boolean limitRender)

  - ### Method Detail

    - #### invokeVisitCallback

          public javax.faces.component.visit.VisitResult invokeVisitCallback(javax.faces.component.UIComponent component,
                                                                    javax.faces.component.visit.VisitCallback callbackToWrap)

      Instead of execution of `VisitCallback` directly, we use `MetaComponentEncodingVisitCallback` that executes additional logic for meta-component encoding.
      Overrides:
        `invokeVisitCallback` in class `BaseExtendedVisitContext`
      See Also:
        `VisitContext.invokeVisitCallback()`

    - #### hasImplicitSubtreeIdsToVisit

          protected boolean hasImplicitSubtreeIdsToVisit(javax.faces.component.UIComponent component)

      Description copied from class: `BaseExtendedVisitContext`
      Return true whether this `VisitContext` allows to visit implicit IDs
      Overrides:
        `hasImplicitSubtreeIdsToVisit` in class `BaseExtendedVisitContext`

    - #### addDirectSubtreeIdsToVisitForImplicitComponents

          protected void addDirectSubtreeIdsToVisitForImplicitComponents(javax.faces.component.UIComponent component,
                                                             Set<String> result)

      Description copied from class: `BaseExtendedVisitContext`
      Allows to add subtrees that contains implicit components to list IDs to visit
      Overrides:
        `addDirectSubtreeIdsToVisitForImplicitComponents` in class `BaseExtendedVisitContext`

    - #### invokeVisitCallbackForImplicitComponent

          protected javax.faces.component.visit.VisitResult invokeVisitCallbackForImplicitComponent(javax.faces.component.UIComponent component,
                                                                                        javax.faces.component.visit.VisitCallback callback)

      Overrides:
        `invokeVisitCallbackForImplicitComponent` in class `BaseExtendedVisitContext`

    - #### shouldCompleteOnEmptyIds

          protected boolean shouldCompleteOnEmptyIds()

      Overrides:
        `shouldCompleteOnEmptyIds` in class `BaseExtendedVisitContext`

    - #### isExtendedRenderVisitContext

          public static boolean isExtendedRenderVisitContext(javax.faces.component.visit.VisitContext visitContext)

      Determine if the VisitContext is, or wraps, the RenderExtendedVisitContext
      Parameters:
        `visitContext` - The VisitContext of the component tree visit.

Copyright © 2014 JBoss by Red Hat. All Rights Reserved.