Class PartialVisitContext
- java.lang.Object
- 
- jakarta.faces.component.visit.VisitContext
- 
- org.apache.myfaces.component.visit.PartialVisitContext
 
 
- 
 public class PartialVisitContext extends VisitContext 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.VisitContextALL_IDS
 
- 
 - 
Constructor SummaryConstructors Constructor Description PartialVisitContext(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 SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description FacesContextgetFacesContext()Set<VisitHint>getHints()Collection<String>getIdsToVisit()Collection<String>getSubtreeIdsToVisit(UIComponent component)VisitResultinvokeVisitCallback(UIComponent component, VisitCallback callback)- 
Methods inherited from class jakarta.faces.component.visit.VisitContextcreateVisitContext, createVisitContext
 
- 
 
- 
- 
- 
Constructor Detail- 
PartialVisitContextpublic PartialVisitContext(FacesContext facesContext, Collection<String> clientIds) Creates a PartialVisitorContext instance.- Parameters:
- facesContext- the FacesContext for the current request
- clientIds- the client ids of the components to visit
- Throws:
- NullPointerException- if- facesContextis- null
 
 - 
PartialVisitContextpublic PartialVisitContext(FacesContext facesContext, Collection<String> clientIds, Set<VisitHint> hints) Creates a PartialVisitorContext instance with the specified hints.- Parameters:
- facesContext- the FacesContext for the current request
- clientIds- the client ids of the components to visit
- hints- a the VisitHints for this visit
- Throws:
- NullPointerException- if- facesContextis- null
- IllegalArgumentException- if the phaseId is specified and hints does not contain VisitHint.EXECUTE_LIFECYCLE
 
 
- 
 - 
Method Detail- 
getFacesContextpublic FacesContext getFacesContext() - Specified by:
- getFacesContextin class- VisitContext
- See Also:
- VisitContext.getFacesContext()
 
 - 
getHintspublic Set<VisitHint> getHints() - Specified by:
- getHintsin class- VisitContext
- See Also:
- VisitContext.getHints
 
 - 
getIdsToVisitpublic Collection<String> getIdsToVisit() - Specified by:
- getIdsToVisitin class- VisitContext
- See Also:
- VisitContext.getIdsToVisit()
 
 - 
getSubtreeIdsToVisitpublic Collection<String> getSubtreeIdsToVisit(UIComponent component) - Specified by:
- getSubtreeIdsToVisitin class- VisitContext
- See Also:
- VisitContext.getSubtreeIdsToVisit()
 
 - 
invokeVisitCallbackpublic VisitResult invokeVisitCallback(UIComponent component, VisitCallback callback) - Specified by:
- invokeVisitCallbackin class- VisitContext
- See Also:
- VisitContext.invokeVisitCallback()
 
 
- 
 
-