org.apache.myfaces.component.visit
Class PartialVisitContext
java.lang.Object
javax.faces.component.visit.VisitContext
org.apache.myfaces.component.visit.PartialVisitContext
public class PartialVisitContext
- extends javax.faces.component.visit.VisitContext
A VisitContext implementation that is
used when performing a partial component tree visit.
- Version:
- $Rev: 949094 $ $Date: 2010-05-27 22:59:10 -0500 (Thu, 27 May 2010) $
- Author:
- Werner Punz, Blake Sullivan (latest modification by $Author: lu4242 $)
Fields inherited from class javax.faces.component.visit.VisitContext |
ALL_IDS |
Constructor Summary |
PartialVisitContext(javax.faces.context.FacesContext facesContext,
java.util.Collection<java.lang.String> clientIds)
Creates a PartialVisitorContext instance. |
PartialVisitContext(javax.faces.context.FacesContext facesContext,
java.util.Collection<java.lang.String> clientIds,
java.util.Set<javax.faces.component.visit.VisitHint> hints)
Creates a PartialVisitorContext instance with the specified hints. |
Method Summary |
javax.faces.context.FacesContext |
getFacesContext()
|
java.util.Set<javax.faces.component.visit.VisitHint> |
getHints()
|
java.util.Collection<java.lang.String> |
getIdsToVisit()
|
java.util.Collection<java.lang.String> |
getSubtreeIdsToVisit(javax.faces.component.UIComponent component)
|
javax.faces.component.visit.VisitResult |
invokeVisitCallback(javax.faces.component.UIComponent component,
javax.faces.component.visit.VisitCallback callback)
|
Methods inherited from class javax.faces.component.visit.VisitContext |
createVisitContext, createVisitContext |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PartialVisitContext
public PartialVisitContext(javax.faces.context.FacesContext facesContext,
java.util.Collection<java.lang.String> clientIds)
- Creates a PartialVisitorContext instance.
- Parameters:
facesContext
- the FacesContext for the current requestclientIds
- the client ids of the components to visit
- Throws:
java.lang.NullPointerException
- if facesContext
is null
PartialVisitContext
public PartialVisitContext(javax.faces.context.FacesContext facesContext,
java.util.Collection<java.lang.String> clientIds,
java.util.Set<javax.faces.component.visit.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:
java.lang.NullPointerException
- if facesContext
is null
java.lang.IllegalArgumentException
- if the phaseId is specified and
hints does not contain VisitHint.EXECUTE_LIFECYCLE
getFacesContext
public javax.faces.context.FacesContext getFacesContext()
- Specified by:
getFacesContext
in class javax.faces.component.visit.VisitContext
- See Also:
VisitContext.getFacesContext()
getHints
public java.util.Set<javax.faces.component.visit.VisitHint> getHints()
- Specified by:
getHints
in class javax.faces.component.visit.VisitContext
- See Also:
VisitContext.getHints
getIdsToVisit
public java.util.Collection<java.lang.String> getIdsToVisit()
- Specified by:
getIdsToVisit
in class javax.faces.component.visit.VisitContext
- See Also:
VisitContext.getIdsToVisit()
getSubtreeIdsToVisit
public java.util.Collection<java.lang.String> getSubtreeIdsToVisit(javax.faces.component.UIComponent component)
- Specified by:
getSubtreeIdsToVisit
in class javax.faces.component.visit.VisitContext
- See Also:
VisitContext.getSubtreeIdsToVisit()
invokeVisitCallback
public javax.faces.component.visit.VisitResult invokeVisitCallback(javax.faces.component.UIComponent component,
javax.faces.component.visit.VisitCallback callback)
- Specified by:
invokeVisitCallback
in class javax.faces.component.visit.VisitContext
- See Also:
VisitContext.invokeVisitCallback()
Copyright © 2010 The Apache Software Foundation. All Rights Reserved.