Class PartialVisitContext
java.lang.Object
jakarta.faces.component.visit.VisitContext
org.apache.myfaces.component.visit.PartialVisitContext
A VisitContext implementation that is used when performing a partial component tree visit.
- Version:
- $Rev$ $Date$
- Author:
- Werner Punz, Blake Sullivan (latest modification by $Author$)
-
Field Summary
Fields inherited from class jakarta.faces.component.visit.VisitContext
ALL_IDS
-
Constructor Summary
ConstructorsConstructorDescriptionPartialVisitContext
(FacesContext facesContext, Collection<String> clientIds) Creates a PartialVisitorContext instance.PartialVisitContext
(FacesContext facesContext, Collection<String> clientIds, Set<VisitHint> hints) Creates a PartialVisitorContext instance with the specified hints. -
Method Summary
Modifier and TypeMethodDescriptiongetHints()
getSubtreeIdsToVisit
(UIComponent component) invokeVisitCallback
(UIComponent component, VisitCallback callback) Methods inherited from class jakarta.faces.component.visit.VisitContext
createVisitContext, createVisitContext
-
Constructor Details
-
PartialVisitContext
Creates a PartialVisitorContext instance.- Parameters:
facesContext
- the FacesContext for the current requestclientIds
- the client ids of the components to visit- Throws:
NullPointerException
- iffacesContext
isnull
-
PartialVisitContext
public PartialVisitContext(FacesContext facesContext, Collection<String> clientIds, Set<VisitHint> hints) Creates a PartialVisitorContext instance with the specified hints.- Parameters:
facesContext
- the FacesContext for the current requestclientIds
- the client ids of the components to visithints
- a the VisitHints for this visit- Throws:
NullPointerException
- iffacesContext
isnull
IllegalArgumentException
- if the phaseId is specified and hints does not contain VisitHint.EXECUTE_LIFECYCLE
-
-
Method Details
-
getFacesContext
- Specified by:
getFacesContext
in classVisitContext
- See Also:
-
getHints
- Specified by:
getHints
in classVisitContext
- See Also:
-
getIdsToVisit
- Specified by:
getIdsToVisit
in classVisitContext
- See Also:
-
getSubtreeIdsToVisit
- Specified by:
getSubtreeIdsToVisit
in classVisitContext
- See Also:
-
invokeVisitCallback
- Specified by:
invokeVisitCallback
in classVisitContext
- See Also:
-