Top Description Fields Constructors Methods
jakarta.faces.component.search

public Class SearchKeywordContext

extends Object
Class Inheritance
Imports
jakarta.faces.component.ContextCallback, .UIComponent

SearchKeywordContext provides context information that may be useful to SearchKeywordResolver#resolve implementations.

Since
2.3

Field Summary

Modifier and TypeField and Description
private final ContextCallback
callback

private boolean
keywordResolved

private final String
remainingExpression

private final SearchExpressionContext
searchExpressionContext

Constructor Summary

AccessConstructor and Description
public
SearchKeywordContext(SearchExpressionContext
the SearchExpressionContext for the current request.
searchExpressionContext, ContextCallback
the ContextCallback.
callback, String
the remaining expression.
remainingExpression)

Construct a new context with the given arguments.

Method Summary

Modifier and TypeMethod and Description
public ContextCallback

Returns:

the ContextCallback.
getCallback()

Returns the ContextCallback for the current request.

public String

Returns:

the remaining expression.
getRemainingExpression()

Returns the remaining expression for the current request.

public SearchExpressionContext

Returns:

the SearchExpressionContext.
getSearchExpressionContext()

Returns the SearchExpressionContext for the current request.

public void
invokeContextCallback(UIComponent
the resolved UIComponent.
target)

This method will be called by an implementation of SearchKeywordResolver#resolve with the resolved component for the keyword.

public boolean

Returns:

if the keyword was resolved.
isKeywordResolved()

Returns if the keyword was resolved.

public void
setKeywordResolved(boolean
if the keyword was resolved.
keywordResolved)

Sets if the keyword was resolved.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

callbackback to summary
private final ContextCallback callback
keywordResolvedback to summary
private boolean keywordResolved
remainingExpressionback to summary
private final String remainingExpression
searchExpressionContextback to summary
private final SearchExpressionContext searchExpressionContext

Constructor Detail

SearchKeywordContextback to summary
public SearchKeywordContext(SearchExpressionContext searchExpressionContext, ContextCallback callback, String remainingExpression)

Construct a new context with the given arguments.

Parameters
searchExpressionContext:SearchExpressionContext

the SearchExpressionContext for the current request.

callback:ContextCallback

the ContextCallback.

remainingExpression:String

the remaining expression.

Method Detail

getCallbackback to summary
public ContextCallback getCallback()

Returns the ContextCallback for the current request.

Returns:ContextCallback

the ContextCallback.

Since
2.3
getRemainingExpressionback to summary
public String getRemainingExpression()

Returns the remaining expression for the current request.

Returns:String

the remaining expression.

Since
2.3
getSearchExpressionContextback to summary
public SearchExpressionContext getSearchExpressionContext()

Returns the SearchExpressionContext for the current request.

Returns:SearchExpressionContext

the SearchExpressionContext.

Since
2.3
invokeContextCallbackback to summary
public void invokeContextCallback(UIComponent target)

This method will be called by an implementation of SearchKeywordResolver#resolve with the resolved component for the keyword.

Parameters
target:UIComponent

the resolved UIComponent.

Since
2.3
isKeywordResolvedback to summary
public boolean isKeywordResolved()

Returns if the keyword was resolved.

Returns:boolean

if the keyword was resolved.

Since
2.3
setKeywordResolvedback to summary
public void setKeywordResolved(boolean keywordResolved)

Sets if the keyword was resolved.

Parameters
keywordResolved:boolean

if the keyword was resolved.

Since
2.3