public abstract class VisitContextWrapper extends VisitContext
VisitContextWrapper
class so that we may be able to use
its functionality in JSF 1.2 with Trinidad 1.2ALL_IDS
Constructor and Description |
---|
VisitContextWrapper() |
Modifier and Type | Method and Description |
---|---|
javax.faces.context.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.
|
javax.faces.event.PhaseId |
getPhaseId()
Returns the PhaseId, if any that, that this visit is ocurring under
|
Collection<String> |
getSubtreeIdsToVisit(javax.faces.component.UIComponent component)
Given a NamingContainer component, returns the client ids of
any components underneath the NamingContainer that should be
visited.
|
abstract VisitContext |
getWrapped()
Get the wrapped visit context
|
VisitResult |
invokeVisitCallback(javax.faces.component.UIComponent component,
VisitCallback callback)
Called by
UIXComponent.visitTree()
to visit a single component. |
public abstract VisitContext getWrapped()
public javax.faces.context.FacesContext getFacesContext()
VisitContext
Returns the FacesContext for the current request.
getFacesContext
in class VisitContext
public javax.faces.event.PhaseId getPhaseId()
VisitContext
Returns the PhaseId, if any that, that this visit is ocurring under
getPhaseId
in class VisitContext
public Set<VisitHint> getHints()
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 calling
VisitContext.getHints().contains()
, passing in one of the
hints defined by VisitHint
.
getHints
in class VisitContext
public Collection<String> getIdsToVisit()
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 being performed, returns a modifiable collection containing the client ids of the components that should be visited.
getIdsToVisit
in class VisitContext
VisitContext.ALL_IDS
, or a modifiable
Collection of client ids.public Collection<String> getSubtreeIdsToVisit(javax.faces.component.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 VisitContext
component
- a NamingContainer componentVisitContext.ALL_IDS
collection.public VisitResult invokeVisitCallback(javax.faces.component.UIComponent component, VisitCallback callback)
VisitContext
Called by UIXComponent.visitTree()
to visit a single component.
invokeVisitCallback
in class VisitContext
component
- the component to visitcallback
- the VisitCallback to callCopyright © 2001-2016 The Apache Software Foundation. All Rights Reserved.