Class SearchKeywordContext
- java.lang.Object
-
- jakarta.faces.component.search.SearchKeywordContext
-
public class SearchKeywordContext extends Object
SearchKeywordContext provides context information that may be useful to
SearchKeywordResolver.resolve(jakarta.faces.component.search.SearchKeywordContext, jakarta.faces.component.UIComponent, java.lang.String)
implementations.- Since:
- 2.3
-
-
Constructor Summary
Constructors Constructor Description SearchKeywordContext(SearchExpressionContext searchExpressionContext, ContextCallback callback, String remainingExpression)
Construct a new context with the given arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ContextCallback
getCallback()
Returns theContextCallback
for the current request.String
getRemainingExpression()
Returns the remaining expression for the current request.SearchExpressionContext
getSearchExpressionContext()
Returns theSearchExpressionContext
for the current request.void
invokeContextCallback(UIComponent target)
This method will be called by an implementation ofSearchKeywordResolver.resolve(jakarta.faces.component.search.SearchKeywordContext, jakarta.faces.component.UIComponent, java.lang.String)
with the resolved component for the keyword.boolean
isKeywordResolved()
Returns if the keyword was resolved.void
setKeywordResolved(boolean keywordResolved)
Sets if the keyword was resolved.
-
-
-
Constructor Detail
-
SearchKeywordContext
public SearchKeywordContext(SearchExpressionContext searchExpressionContext, ContextCallback callback, String remainingExpression)
Construct a new context with the given arguments.
- Parameters:
searchExpressionContext
- theSearchExpressionContext
for the current request.callback
- theContextCallback
.remainingExpression
- the remaining expression.
-
-
Method Detail
-
invokeContextCallback
public void invokeContextCallback(UIComponent target)
This method will be called by an implementation of
SearchKeywordResolver.resolve(jakarta.faces.component.search.SearchKeywordContext, jakarta.faces.component.UIComponent, java.lang.String)
with the resolved component for the keyword.- Parameters:
target
- the resolvedUIComponent
.- Since:
- 2.3
-
getSearchExpressionContext
public SearchExpressionContext getSearchExpressionContext()
Returns the
SearchExpressionContext
for the current request.- Returns:
- the
SearchExpressionContext
. - Since:
- 2.3
-
getCallback
public ContextCallback getCallback()
Returns the
ContextCallback
for the current request.- Returns:
- the
ContextCallback
. - Since:
- 2.3
-
getRemainingExpression
public String getRemainingExpression()
Returns the remaining expression for the current request.
- Returns:
- the remaining expression.
- Since:
- 2.3
-
isKeywordResolved
public boolean isKeywordResolved()
Returns if the keyword was resolved.
- Returns:
- if the keyword was resolved.
- Since:
- 2.3
-
setKeywordResolved
public void setKeywordResolved(boolean keywordResolved)
Sets if the keyword was resolved.
- Parameters:
keywordResolved
- if the keyword was resolved.- Since:
- 2.3
-
-