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.
ALL_IDS| Constructor and Description |
|---|
VisitContextWrapper()
Deprecated.
Use the other constructor taking the implementation being wrapped.
|
VisitContextWrapper(VisitContext 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 |
|---|---|
FacesContext |
getFacesContext()
Returns the FacesContext for the current request. |
java.util.Set<VisitHint> |
getHints()
Returns hints that influence the behavior of the tree visit.
|
java.util.Collection<java.lang.String> |
getIdsToVisit()
Returns the ids of the components to visit. |
java.util.Collection<java.lang.String> |
getSubtreeIdsToVisit(UIComponent component)
Given a |
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 by
UIComponent.visitTree()
to visit a single component. |
createVisitContext, createVisitContext@Deprecated public 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.
wrapped - The implementation being wrapped.public VisitContext getWrapped()
FacesWrapperA class that implements this interface uses this method to return an instance of the class being wrapped.
getWrapped in interface FacesWrapper<VisitContext>public FacesContext getFacesContext()
VisitContextReturns the FacesContext for the current request.
getFacesContext in class VisitContextpublic java.util.Set<VisitHint> getHints()
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 calling
VisitContext.getHints().contains(), passing in one of the
hints defined by VisitHint.
getHints in class VisitContextpublic java.util.Collection<java.lang.String> getIdsToVisit()
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.
getIdsToVisit in class VisitContextpublic java.util.Collection<java.lang.String> getSubtreeIdsToVisit(UIComponent component)
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.
getSubtreeIdsToVisit in class VisitContextcomponent - a NamingContainer componentVisitContext.ALL_IDS collection.public VisitResult invokeVisitCallback(UIComponent component, VisitCallback callback)
VisitContextCalled by UIComponent.visitTree()
to visit a single component.
invokeVisitCallback in class VisitContextcomponent - the component to visitcallback - the VisitCallback to call