- 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
VisitContext
that can be subclassed by developers wishing to provide specialized behavior to an existingVisitContext
instance. The default implementation of all methods is to call through to the wrappedVisitContext
instance.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 FacesContext
getFacesContext()
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
NamingContainer
component, returns the client ids of any components underneath the NamingContainer that should be visited.abstract VisitContext
getWrapped()
A class that implements this interface uses this method to return an instance of the class being wrapped.
VisitResult
invokeVisitCallback(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:VisitContext
Returns the FacesContext for the current request.
- Specified by:
getFacesContext
in classVisitContext
-
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 callingVisitContext.getHints().contains()
, passing in one of the hints defined byVisitHint
.- Specified by:
getHints
in classVisitContext
- 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 classVisitContext
-
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 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_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 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:FacesWrapper
A class that implements this interface uses this method to return an instance of the class being wrapped.
- Specified by:
getWrapped
in interfaceFacesWrapper<VisitContext>
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/faces/component/visit/visitcontextwrapper.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.