クラス SearchKeywordResolver
- java.lang.ObjectSE
-
- jakarta.faces.component.search.SearchKeywordResolver
public abstract class SearchKeywordResolver extends ObjectSE
SearchKeywordResolver は、単一のキーワードを解決します。実装は、それぞれが関連する動作を伴う、以下の
SearchKeywordResolver
実装のセットをサポートする必要があります。サポートされている必要なキーワードとその動作のリスト 検索キーワード 振る舞い @all ビュー内のすべてのコンポーネント @child(n) 基本コンポーネントの n 番目の子 @composite 基本コンポーネントの複合コンポーネントの親 @form 基本コンポーネントの最も近いフォームの祖先 @id(id) 指定されたコンポーネント ID (clientId ではない) を持つコンポーネントに解決します。これは、コンポーネントツリーの正確な場所が不明な場合に便利ですが、ビュー内に指定された ID が複数出現する場合は注意して使用する必要があります。 @namingcontainer 基本コンポーネントの最も近い NamingContainer
祖先コンポーネント@next ビューのベースコンポーネントの次のコンポーネント @none コンポーネントなし @parent 基本コンポーネントの親 @previous 前のコンポーネントからベースコンポーネントへ @root UIViewRoot
@this 基本コンポーネント 新しい
SearchKeywordResolver
は、Application.addSearchKeywordResolver(jakarta.faces.component.search.SearchKeywordResolver)
を介して、またはアプリケーション構成リソースに登録できます。<application> <search-keyword-resolver>...</search-keyword-resolver> </application>
- 導入:
- 2.3
コンストラクターのサマリー
コンストラクター コンストラクター 説明 SearchKeywordResolver()
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 boolean
isLeaf(SearchExpressionContext searchExpressionContext, StringSE keyword)
リーフキーワードは、右側のキーワードまたは ID チェーンと組み合わせることを許可しないキーワードです。boolean
isPassthrough(SearchExpressionContext searchExpressionContext, StringSE keyword)
パススルーキーワードは、コンテキストに応じて、サーバーで解決する必要がないキーワードであり、「未解決」でクライアントに渡すことができます。abstract boolean
isResolverForKeyword(SearchExpressionContext searchExpressionContext, StringSE keyword)
SearchKeywordResolver
の現在のインスタンスがキーワードの解決を担当しているかどうかを確認します。abstract void
resolve(SearchKeywordContext searchKeywordContext, UIComponent current, StringSE keyword)
キーワードに基づいて 1 つまたは複数のUIComponent
を解決し、解決されたコンポーネントごとにSearchKeywordContext.invokeContextCallback(jakarta.faces.component.UIComponent)
を呼び出します。
メソッドの詳細
resolve
public abstract void resolve(SearchKeywordContext searchKeywordContext, UIComponent current, StringSE keyword)
キーワードに基づいて 1 つまたは複数の
UIComponent
を解決し、解決されたコンポーネントごとにSearchKeywordContext.invokeContextCallback(jakarta.faces.component.UIComponent)
を呼び出します。- パラメーター:
searchKeywordContext
-SearchKeywordContext
current
- 以前に解決されたコンポーネントまたはソースコンポーネント (チェーンの最初のキーワードが必要な場合)keyword
- キーワード- 導入:
- 2.3
isResolverForKeyword
public abstract boolean isResolverForKeyword(SearchExpressionContext searchExpressionContext, StringSE keyword)
SearchKeywordResolver
の現在のインスタンスがキーワードの解決を担当しているかどうかを確認します。- パラメーター:
searchExpressionContext
-SearchExpressionContext
keyword
- キーワード- 戻り値:
- このキーワードの解決を担当している場合は
true
- 導入:
- 2.3
isPassthrough
public boolean isPassthrough(SearchExpressionContext searchExpressionContext, StringSE keyword)
パススルーキーワードは、コンテキストに応じて、サーバーで解決する必要がないキーワードであり、「未解決」でクライアントに渡すことができます。
- パラメーター:
searchExpressionContext
-SearchExpressionContext
keyword
- キーワード- 戻り値:
- パススルーキーワードの場合は
true
。 - 導入:
- 2.3
isLeaf
public boolean isLeaf(SearchExpressionContext searchExpressionContext, StringSE keyword)
リーフキーワードは、右側のキーワードまたは ID チェーンと組み合わせることを許可しないキーワードです。例: @none:@parent。
- パラメーター:
searchExpressionContext
-SearchExpressionContext
keyword
- キーワード- 戻り値:
- リーフキーワードの場合は
true
。 - 導入:
- 2.3