インターフェース ClientBehavior
- すべてのスーパーインターフェース:
Behavior
- すべての既知の実装クラス:
AjaxBehavior
,ClientBehaviorBase
public interface ClientBehavior extends Behavior
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
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 void
decode(FacesContext context, UIComponent component)
指定されたFacesContext
に含まれるリクエストから、このClientBehavior
の新しい状態をデコードします。SetSE<ClientBehaviorHint>
getHints()
ClientBehavior 実装の動作を説明するヒントを返します。StringSE
getScript(ClientBehaviorContext behaviorContext)
この ClientBehavior のクライアント側ロジックを実装するスクリプトを返します。
メソッドの詳細
getScript
StringSE getScript(ClientBehaviorContext behaviorContext)
この ClientBehavior のクライアント側ロジックを実装するスクリプトを返します。
ClientBehavior.getScript() 実装は、この特定の getScript() 呼び出しにスクリプトが必要ないことを示すために null を返すことができます。例: 動作が無効になっている場合、ClientBehavior 実装は null を返す場合があります。
- パラメーター:
behaviorContext
- この getScript() 呼び出しに影響を与える可能性のあるプロパティを提供するClientBehaviorContext
。ClientBehaviorContext インスタンスは、getScript() への呼び出しの間のみ有効な短期間のオブジェクトであることに注意してください。ClientBehavior の実装は、ClientBehaviorContexts への参照を保持してはなりません。- 戻り値:
- クライアント側の動作を提供するスクリプト。スクリプトが不要な場合は null。
- 例外:
NullPointerExceptionSE
-behaviorContext
がnull
の場合- 導入:
- 2.0
decode
void decode(FacesContext context, UIComponent component)
指定された
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