Top Description Methods
jakarta.faces.component.visit

public Interface VisitCallback

Known Direct Implementers
com.sun.faces.application.ValidateComponentNesting.ValidateFormNestingCallback, com.sun.faces.context.PartialViewContextImpl.DoResetValues, com.sun.faces.context.PartialViewContextImpl.PhaseAwareVisitCallback, com.sun.faces.ext.component.WholeBeanValidator.AddRemainingCandidateFieldsCallback, jakarta.faces.component.UIViewRoot.DoResetValues
Imports
jakarta.faces.component.UIComponent

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 TypeMethod and Description
public VisitResult

Returns:

a VisitResult that indicates whether to continue visiting the component's subtree, skip visiting the component's subtree or end the visit.
visit(VisitContext
the VisitContext for this tree visit.
context, UIComponent
the UIComponent to visit
target)

This method is called during component tree visits by VisitContext.invokeVisitCallback() to visit the specified component.

Method Detail

visitback to summary
public 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:VisitContext

the VisitContext for this tree visit.

target:UIComponent

the UIComponent to visit

Returns:VisitResult

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