javax.faces.component.visit

Interface VisitCallback

public interface VisitCallback

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

Since:

2.0

See Also:

UIComponent.visitTree()

Method Summary

Modifier and Type	Method and Description
VisitResult	visit(VisitContext context, UIComponent target) This method is called during component tree visits by VisitContext.invokeVisitCallback() to visit the specified component.

Method Detail

visit

VisitResult visit(VisitContext context,
                  UIComponent target)

This method is called during component tree visits by VisitContext.invokeVisitCallback() to visit the specified component. At the point in time when this method is called, the argument target is guaranteed to be in the proper state with respect to its ancestors in the View.

Parameters:

context - the VisitContext for this tree visit.

target - the UIComponent to visit

Returns:

a VisitResult that indicates whether to continue visiting the component's subtree, skip visiting the component's subtree or end the visit.