Package jakarta.faces.component.visit

Class VisitContext

    • Field Detail

      • ALL_IDS

        public static final Collection<String> ALL_IDS

        This unmodifiable Collection is returned by getIdsToVisit() and getSubtreeIdsToVisit() in cases where all ids should be visited.

        To simplify logic for visitTree() implementations, this Collection always returns false for isEmpty. All other methods throw UnsupportedOperationException.

        Since:
        2.0

    • Constructor Detail

      • VisitContext

        public VisitContext()

    • Method Detail

      • getFacesContext

        public abstract FacesContext getFacesContext()

        Returns the FacesContext for the current request.

        Returns:
        the FacesContext.
        Since:
        2.0

      • getIdsToVisit

        public abstract Collection<String> getIdsToVisit()

        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.

        Returns:
        the ids of the components to visit

      • getSubtreeIdsToVisit

        public abstract Collection<String> getSubtreeIdsToVisit​(UIComponent component)

        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.

        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.
        Throws:
        IllegalArgumentException - if component is not an instance of NamingContainer

      • invokeVisitCallback

        public abstract VisitResult invokeVisitCallback​(UIComponent component,
                                                VisitCallback callback)

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

        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.

      • getHints

        public abstract Set<VisitHint> getHints()

        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.

        Returns:
        a non-empty, unmodifiable collection of VisitHints

      • createVisitContext

        public static VisitContext createVisitContext​(FacesContext context)

        Creates a VisitContext instance for use with UIComponent.visitTree(). This method can be used to obtain a VisitContext instance when all components should be visited with the default visit hints.

        Parameters:
        context - the FacesContext for the current request
        Returns:
        a VisitContext instance