- java.lang.Object
-
- javax.faces.component.visit.VisitContext
-
- javax.faces.component.visit.VisitContextWrapper
-
- All Implemented Interfaces:
- FacesWrapper<VisitContext>
public abstract class VisitContextWrapper extends VisitContext implements FacesWrapper<VisitContext>
Provides a simple implementation of
VisitContextthat can be subclassed by developers wishing to provide specialized behavior to an existingVisitContextinstance. The default implementation of all methods is to call through to the wrappedVisitContextinstance.Usage: extend this class and override
getWrapped()to return the instance we are wrapping.- Since:
- 2.0
-
-
Field Summary
-
Fields inherited from class javax.faces.component.visit.VisitContext
ALL_IDS
-
-
Constructor Summary
Constructors Constructor and Description VisitContextWrapper()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description FacesContextgetFacesContext()Returns the FacesContext for the current request.
Set<VisitHint>getHints()Returns hints that influence the behavior of the tree visit.Collection<String>getIdsToVisit()Returns the ids of the components to visit.
Collection<String>getSubtreeIdsToVisit(UIComponent component)Given a
NamingContainercomponent, returns the client ids of any components underneath the NamingContainer that should be visited.abstract VisitContextgetWrapped()A class that implements this interface uses this method to return an instance of the class being wrapped.
VisitResultinvokeVisitCallback(UIComponent component, VisitCallback callback)Called byUIComponent.visitTree()to visit a single component.-
Methods inherited from class javax.faces.component.visit.VisitContext
createVisitContext, createVisitContext
-
-
-
-
Method Detail
-
getFacesContext
public FacesContext getFacesContext()
Description copied from class:VisitContextReturns the FacesContext for the current request.
- Specified by:
getFacesContextin classVisitContext
-
getHints
public Set<VisitHint> getHints()
Description copied from class:VisitContextReturns 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 callingVisitContext.getHints().contains(), passing in one of the hints defined byVisitHint.- Specified by:
getHintsin classVisitContext- Returns:
- a non-empty, unmodifiable collection of VisitHints
-
getIdsToVisit
public Collection<String> getIdsToVisit()
Description copied from class:VisitContextReturns 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:
getIdsToVisitin classVisitContext
-
getSubtreeIdsToVisit
public Collection<String> getSubtreeIdsToVisit(UIComponent component)
Description copied from class:VisitContextGiven a
NamingContainercomponent, 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:
getSubtreeIdsToVisitin classVisitContext- 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_IDScollection.
-
invokeVisitCallback
public VisitResult invokeVisitCallback(UIComponent component, VisitCallback callback)
Description copied from class:VisitContextCalled by
UIComponent.visitTree()to visit a single component.- Specified by:
invokeVisitCallbackin classVisitContext- Parameters:
component- the component to visitcallback- 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.
-
getWrapped
public abstract VisitContext getWrapped()
Description copied from interface:FacesWrapperA class that implements this interface uses this method to return an instance of the class being wrapped.
- Specified by:
getWrappedin interfaceFacesWrapper<VisitContext>
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
22/08/2025 07:46:28 Cette version de la page est en cache (à la date du 22/08/2025 07:46:28) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/faces/component/visit/VisitContextWrapper.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.