org.apache.myfaces.component.visit
Class PartialVisitContext

java.lang.Object
  extended by javax.faces.component.visit.VisitContext
      extended by 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: 1296362 $ $Date: 2012-03-02 13:27:53 -0500 (Fri, 02 Mar 2012) $
Author:
Werner Punz, Blake Sullivan (latest modification by $Author: lu4242 $)

Field Summary
 
Fields inherited from class javax.faces.component.visit.VisitContext
ALL_IDS
 
Constructor Summary
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 Summary
 FacesContext getFacesContext()
           
 Set<VisitHint> getHints()
           
 Collection<String> getIdsToVisit()
           
 Collection<String> getSubtreeIdsToVisit(UIComponent component)
           
 VisitResult invokeVisitCallback(UIComponent component, 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
 

Constructor Detail

PartialVisitContext

public 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 facesContext is null

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 request
clientIds - the client ids of the components to visit
hints - a the VisitHints for this visit
Throws:
NullPointerException - if facesContext is null
IllegalArgumentException - if the phaseId is specified and hints does not contain VisitHint.EXECUTE_LIFECYCLE
Method Detail

getFacesContext

public FacesContext getFacesContext()
Specified by:
getFacesContext in class VisitContext
See Also:
VisitContext.getFacesContext()

getHints

public Set<VisitHint> getHints()
Specified by:
getHints in class VisitContext
See Also:
VisitContext.getHints

getIdsToVisit

public Collection<String> getIdsToVisit()
Specified by:
getIdsToVisit in class VisitContext
See Also:
VisitContext.getIdsToVisit()

getSubtreeIdsToVisit

public Collection<String> getSubtreeIdsToVisit(UIComponent component)
Specified by:
getSubtreeIdsToVisit in class VisitContext
See Also:
VisitContext.getSubtreeIdsToVisit()

invokeVisitCallback

public VisitResult invokeVisitCallback(UIComponent component,
                                       VisitCallback callback)
Specified by:
invokeVisitCallback in class VisitContext
See Also:
VisitContext.invokeVisitCallback()


Copyright © 2014 The Apache Software Foundation. All Rights Reserved.