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.
| Modifier and Type | Field and Description |
|---|---|
| private VisitContext |
| Access | Constructor and Description |
|---|---|
| public | |
| public | VisitContextWrapper(VisitContext
The implementation being wrapped. wrapped)If this visit context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. |
| Modifier and Type | Method and Description |
|---|---|
| public FacesContext | getFacesContext()
Implements abstract jakarta. Returns the FacesContext for the current request. |
| public Set | getHints()
Implements abstract jakarta. Returns hints that influence the behavior of the tree visit. |
| public Collection | getIdsToVisit()
Implements abstract jakarta. Returns the ids of the components to visit. |
| public Collection | getSubtreeIdsToVisit(UIComponent
a NamingContainer component component)Implements abstract jakarta.
Given a |
| public VisitContext | getWrapped()
Implements jakarta. A class that implements this interface uses this method to return an instance of the class being wrapped. |
| public VisitResult | invokeVisitCallback(UIComponent
the component to visit component, VisitCallback the VisitCallback to call callback)Implements abstract jakarta.
Called by |
| wrapped | back to summary |
|---|---|
| private VisitContext wrapped | |
| VisitContextWrapper | back to summary |
|---|---|
| public VisitContextWrapper()
Deprecated Use the other constructor taking the implementation being wrapped.
| |
| VisitContextWrapper | back to summary |
|---|---|
| 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
| |
| getFacesContext | back to summary |
|---|---|
| public FacesContext getFacesContext() Implements abstract jakarta. Doc from jakarta. Returns the FacesContext for the current request.
| |
| getHints | back to summary |
|---|---|
| public Set Implements abstract jakarta. Doc from jakarta. Returns hints that influence the behavior of the tree visit.
Interested parties, such as | |
| getIdsToVisit | back to summary |
|---|---|
| public Collection Implements abstract jakarta. Doc from jakarta. 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.
| |
| getSubtreeIdsToVisit | back to summary |
|---|---|
| public Collection Implements abstract jakarta. Doc from jakarta.
Given a 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.
| |
| getWrapped | back to summary |
|---|---|
| public VisitContext getWrapped() Implements jakarta. Doc from jakarta. A class that implements this interface uses this method to return an instance of the class being wrapped.
| |
| invokeVisitCallback | back to summary |
|---|---|
| public VisitResult invokeVisitCallback(UIComponent component, VisitCallback callback) Implements abstract jakarta. Doc from jakarta.
Called by
| |