javax.faces.component.visit.package.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javaee-web-api Show documentation

Java(TM) EE 8 Web Profile Specification APIs

There is a newer version: 8.0.1





Package Description for "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.