Module jakarta.faces
Package jakarta.faces.component.visit

Class VisitContextWrapper

java.lang.Object
jakarta.faces.component.visit.VisitContext
jakarta.faces.component.visit.VisitContextWrapper
All Implemented Interfaces:
FacesWrapper<VisitContext>
public abstract class VisitContextWrapper extends VisitContext implements FacesWrapper<VisitContext>

Provides a simple implementation of VisitContext that can be subclassed by developers wishing to provide specialized behavior to an existing VisitContext instance. The default implementation of all methods is to call through to the wrapped VisitContext instance.

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped() to access the instance being wrapped.

Since:
2.0

  • Constructor Details

    • VisitContextWrapper

      @Deprecated public VisitContextWrapper()
      Deprecated.
      Use the other constructor taking the implementation being wrapped.

    • VisitContextWrapper

      public VisitContextWrapper(VisitContext wrapped)

      If this visit context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The getWrapped() will then return the implementation being wrapped.

      Parameters:
      wrapped - The implementation being wrapped.
      Since:
      2.3

  • Method Details

    • getWrapped

      public VisitContext getWrapped()
      Description copied from interface: FacesWrapper

      A class that implements this interface uses this method to return an instance of the class being wrapped.

      Specified by:
      getWrapped in interface FacesWrapper<VisitContext>
      Returns:
      the wrapped instance.

    • getFacesContext

      public FacesContext getFacesContext()
      Description copied from class: VisitContext

      Returns the FacesContext for the current request.

      Specified by:
      getFacesContext in class VisitContext
      Returns:
      the FacesContext.

    • getHints

      public Set<VisitHint> getHints()
      Description copied from class: VisitContext

      Returns hints that influence the behavior of the tree visit.

      Interested parties, such as UIComponent.visitTree() implementations, may check to see whether a particular hint is present by calling VisitContext.getHints().contains(), passing in one of the hints defined by VisitHint.

      Specified by:
      getHints in class VisitContext
      Returns:
      a non-empty, unmodifiable collection of VisitHints

    • getIdsToVisit

      public Collection<String> getIdsToVisit()
      Description copied from class: VisitContext

      Returns the ids of the components to visit.

      In the case of a full tree visit, this method returns the ALL_IDS collection. Otherwise, if a partial visit is beign performed, returns a modifiable collection containing the client ids of the components that should be visited.

      Specified by:
      getIdsToVisit in class VisitContext
      Returns:
      the ids of the components to visit

    • getSubtreeIdsToVisit

      public Collection<String> getSubtreeIdsToVisit(UIComponent component)
      Description copied from class: VisitContext

      Given a NamingContainer component, returns the client ids of any components underneath the NamingContainer that should be visited.

      This method is called by NamingContainer visitTree() implementations to determine whether the NamingContainer contains components to be visited. In the case where no such components exist, the NamingContainer can short-circuit the tree visit and avoid descending into child subtrees.

      In addition, iterating components such as UIData may be able to use the returned ids to determine which iterated states (ie. rows) need to be visited. This allows the visit traversal to be contstrained such only those rows that contain visit targets need to be traversed.

      Specified by:
      getSubtreeIdsToVisit in class VisitContext
      Parameters:
      component - a NamingContainer component
      Returns:
      an unmodifiable Collection containing the client ids of any components underneath the NamingContainer that are known to be targets of the tree visit. If no such components exist, returns an empty Collection. If all components underneath the NamingContainer should be visited, returns the VisitContext.ALL_IDS collection.

    • invokeVisitCallback

      public VisitResult invokeVisitCallback(UIComponent component, VisitCallback callback)
      Description copied from class: VisitContext

      Called by UIComponent.visitTree() to visit a single component.

      Specified by:
      invokeVisitCallback in class VisitContext
      Parameters:
      component - the component to visit
      callback - the VisitCallback to call
      Returns:
      a VisitResult value that indicates whether to continue visiting the component's subtree, skip visiting the component's subtree or abort the visit altogether.