Class SearchKeywordResolver

java.lang.Object
jakarta.faces.component.search.SearchKeywordResolver
Direct Known Subclasses:
AbstractSearchKeywordResolverImpl, CompositeSearchKeywordResolver, SearchKeywordResolverImplChild, SearchKeywordResolverImplComposite, SearchKeywordResolverImplNext, SearchKeywordResolverImplParent, SearchKeywordResolverImplPrevious, SearchKeywordResolverImplRoot, SearchKeywordResolverImplThis

public abstract class SearchKeywordResolver
extends Object

A SearchKeywordResolver is responsible for resolving a single keyword. Implementations must support the following set of SearchKeywordResolver implementations, each with the associated behavior.

List of required supported keywords and their behaviors
Search Keyword Behavior
@all All components in the view
@child(n) The nth child of the base component
@composite The composite component parent of the base component
@form The closest form ancestor of the base component
@id(id) Resolves to the components with the specified component id (not clientId). This is useful when the exact location of the component tree is unknown, but must be used with caution when there multiple occurrences of the given id within the view.
@namingcontainer The closest NamingContainer ancestor component of the base component
@next The next component in the view after the base component
@none No component
@parent The parent of the base component
@previous The previous component to the base component
@root The UIViewRoot
@this The base component

New SearchKeywordResolvers can be registered via Application.addSearchKeywordResolver(jakarta.faces.component.search.SearchKeywordResolver) or in the application configuration resources.

 
 <application>
   <search-keyword-resolver>...</search-keyword-resolver>
 </application>
 
 
Since:
2.3