javax.faces.component.visit

APIs for traversing a user interface component view. The following example visits all nodes in the view. UIViewRoot root = facesContext. getViewRoot ( ) ; root. visitTree ( VisitContext. createVisitContext ( context ) , new VisitCallback ( ) { public VisitResult visit ( VisitContext context, UIComponent target ) { // take some action on target return VisitResult. ACCEPT ; } } ) ; The following example visits two subtrees within the component view. Set<String> toVisit = getSet ( "form1:optionsPanel" , "form2:detailPanel" ) ; UIViewRoot root = facesContext. getViewRoot ( ) ; root. visitTree ( VisitContext. createVisitContext ( context, toVisit, null ) , new VisitCallback ( ) { public VisitResult visit ( VisitContext context, UIComponent target ) { // take some action on target return VisitResult. ACCEPT ; } } ) ; Note that every child node of those two subtrees is visited. more ...

Interfaces:

VisitCallback

A simple callback interface that enables taking action on a specific UIComponent (either facet or child) during a component tree visit.

code | html

Abstract Classes:

VisitContext

A context object that is used to hold state relating to performing a component tree visit.

Component tree visits are initiated by calling UIComponent#visitTree , at which point both a VisitContext and a VisitCallback must be provided.

code | html

VisitContextFactory

Provide for separation of interface and implementation for the VisitContext contract.

code | html

VisitContextWrapper

Provides a simple implementation of VisitContext that can be subclassed by developers wishing to provide specialized behavior to an existing VisitContext instance.

code | html

Classes:

VisitHint

An enum that specifies hints that impact the behavior of a component tree visit.

code | html

VisitResult

An enum that specifies the possible results of a call to VisitCallback#visit .

code | html

APIs for traversing a user interface component view.

The following example visits all nodes in the view.

UIViewRoot root = facesContext.getViewRoot();
root.visitTree(VisitContext.createVisitContext(context), 
               new VisitCallback() {
                   public VisitResult visit(VisitContext context, 
                                            UIComponent target) {
                       // take some action on target
                       return VisitResult.ACCEPT;
                   }
               }); 

The following example visits two subtrees within the component view.

Set<String> toVisit = getSet("form1:optionsPanel", "form2:detailPanel");
UIViewRoot root = facesContext.getViewRoot();
root.visitTree(VisitContext.createVisitContext(context, toVisit, null), 
               new VisitCallback() {
                   public VisitResult visit(VisitContext context, 
                                            UIComponent target) {
                       // take some action on target
                       return VisitResult.ACCEPT;
                   }
               }); 

Note that every child node of those two subtrees is visited.