インターフェース ClientBehavior
- すべてのスーパーインターフェース:
Behavior
- すべての既知の実装クラス:
AjaxBehavior,ClientBehaviorBase
ClientBehavior は、ClientBehaviorHolder コンポーネントによって公開されるクライアント側のイベントにスクリプトコンテンツを添付する Behavior の基本契約です。ClientBehavior のインスタンスは、ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior) を呼び出すことにより、ClientBehaviorHolder 契約を実装するコンポーネントに接続できます。ClientBehavior が ClientBehaviorHolder コンポーネントに接続されると、コンポーネントは getScript(jakarta.faces.component.behavior.ClientBehaviorContext) を呼び出して動作のスクリプトを取得し、コンポーネントはこれを適切なクライアント側のイベントハンドラーに接続します。このメソッドによって返されるスクリプトコンテンツは、常にインラインスクリプトコンテンツであることに注意してください。実装クラスが他のスクリプトリソースで定義された関数を呼び出す場合、実装クラスは ResourceDependency または ResourceDependencies アノテーションを使用する必要があります。
- 導入:
- 2.0
方法の概要
修飾子と型メソッド説明voiddecode(FacesContext context, UIComponent component) 指定されたFacesContextに含まれるリクエストから、このClientBehaviorの新しい状態をデコードします。getHints()ClientBehavior 実装の動作を説明するヒントを返します。getScript(ClientBehaviorContext behaviorContext) この ClientBehavior のクライアント側ロジックを実装するスクリプトを返します。
メソッドの詳細
getScript
この ClientBehavior のクライアント側ロジックを実装するスクリプトを返します。
ClientBehavior.getScript() 実装は、この特定の getScript() 呼び出しにスクリプトが必要ないことを示すために null を返すことができます。例: 動作が無効になっている場合、ClientBehavior 実装は null を返す場合があります。
- パラメーター:
behaviorContext- この getScript() 呼び出しに影響を与える可能性のあるプロパティを提供するClientBehaviorContext。ClientBehaviorContext インスタンスは、getScript() への呼び出しの間のみ有効な短期間のオブジェクトであることに注意してください。ClientBehavior の実装は、ClientBehaviorContexts への参照を保持してはなりません。- 戻り値:
- クライアント側の動作を提供するスクリプト。スクリプトが不要な場合は null。
- 例外:
NullPointerExceptionSE-behaviorContextがnullの場合- 導入:
- 2.0
decode
指定された
FacesContextに含まれるリクエストから、このClientBehaviorの新しい状態をデコードします。デコード中に、
queueEvent()を呼び出すことにより、後の処理のために(インタレストを登録したイベントリスナーによって)イベントがキューに入れられる場合があります。デフォルトの実装は、デコードをClientBehaviorRenderer.decode(FacesContext, UIComponent, ClientBehavior)に委譲します- パラメーター:
context-FacesContext(処理中のリクエスト)component-UIComponentこのBehaviorに関連付けられているコンポーネント- 例外:
NullPointerExceptionSE-contextまたはcomponentがnullの場合。- 導入:
- 2.0
getHints
SetSE<ClientBehaviorHint> getHints()ClientBehavior 実装の動作を説明するヒントを返します。ヒントは、振る舞いが存在する場合のレンダラーの動作に影響を与える可能性があります。例:
ClientBehaviorHint.SUBMITTINGを指定する動作が存在する場合、レンダラーはそれ自体が生成するスクリプトを代替することを選択できます。- 戻り値:
- ClientBehaviorHints の null 以外の変更不可能なコレクション。
- 導入:
- 2.0