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

Version:
$Rev: 783358 $ $Date: 2009-06-10 08:35:32 -0500 (Wed, 10 Jun 2009) $ Implementation of a PartialVisitContext! The partial visit context works on a subset of ids and has several differences to a Full visit context! First getIds returns a mutable set Secondly getSubtreeIdsToVisit returns either a valid id subset or ALL_IDS
Author:
Werner Punz (latest modification by $Author: werpu $)

Field Summary
 
Fields inherited from class javax.faces.component.visit.VisitContext
ALL_IDS
 
Constructor Summary
PartialVisitContext(FacesContext context, java.util.Collection<VisitHint> hints, java.util.Collection<java.lang.String> ids)
           
 
Method Summary
 FacesContext getFacesContext()
           
 java.util.Set<VisitHint> getHints()
           
 java.util.Collection<java.lang.String> getIdsToVisit()
          Returns the collection of ids, as mutable collection! (In our case our internal PartialVisitProxy doing the heavy lifting)
 java.util.Collection<java.lang.String> getSubtreeIdsToVisit(UIComponent component)
          returns all visit ids below the component given the component has to be a naming container! To speed things up we use an inverse cache, the component itself does not have to be in the visting list it can even be the body element!
 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 context,
                           java.util.Collection<VisitHint> hints,
                           java.util.Collection<java.lang.String> ids)
Method Detail

getFacesContext

public FacesContext getFacesContext()
Specified by:
getFacesContext in class VisitContext

getHints

public java.util.Set<VisitHint> getHints()
Specified by:
getHints in class VisitContext

getIdsToVisit

public java.util.Collection<java.lang.String> getIdsToVisit()
Returns the collection of ids, as mutable collection! (In our case our internal PartialVisitProxy doing the heavy lifting)

Specified by:
getIdsToVisit in class VisitContext

getSubtreeIdsToVisit

public java.util.Collection<java.lang.String> getSubtreeIdsToVisit(UIComponent component)
returns all visit ids below the component given the component has to be a naming container! To speed things up we use an inverse cache, the component itself does not have to be in the visting list it can even be the body element!

Specified by:
getSubtreeIdsToVisit in class VisitContext
Parameters:
component -
Returns:

invokeVisitCallback

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


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