クラス ClientBehaviorContext

メソッドの詳細

• createClientBehaviorContext

  public static ClientBehaviorContext createClientBehaviorContext(FacesContext context, UIComponent component, StringSE eventName, StringSE sourceId, CollectionSE<ClientBehaviorContext.Parameter> parameters)

  ClientBehaviorContext インスタンスを作成します。

  パラメーター:

  context - 現在のリクエストの FacesContext。

  component - ClientBehavior が接続されているコンポーネントインスタンス。

  eventName - ClientBehavior が接続されている動作イベントの名前。

  sourceId - ClientBehavior の「ソース」として使用する ID。

  parameters - リクエストに含める ClientBehaviors を送信するためのパラメーターのコレクション。

  戻り値:

  提供された値で構成された ClientBehaviorContext インスタンス。

  例外:

  NullPointerExceptionSE - context、component、eventName が null の場合

  導入:

  2.0

• getFacesContext

  public abstract FacesContext getFacesContext()

  現在のリクエストの FacesContext を返します。

  戻り値:

  FacesContext

  導入:

  2.0

• getComponent

  public abstract UIComponent getComponent()

  ClientBehavior スクリプトをリクエストしている UIComponent を返します。

  戻り値:

  コンポーネント。

  導入:

  2.0

• getEventName

  public abstract StringSE getEventName()

  ClientBehavior スクリプトがリクエストされている動作イベントの名前を返します。

  戻り値:

  イベント名。

  導入:

  2.0

• getSourceId

  public abstract StringSE getSourceId()

  ClientBehavior ソースとして使用するための ID を返します。Faces ライフサイクルにサブミットする ClientBehavior 実装は、jakarta.faces.source リクエストパラメーターを介して ClientBehavior によって開始されたリクエストをトリガーしたコンポーネントを識別するために必要です。ほとんどの場合、ソース ID は、振る舞いーのクライアント側スクリプトが添付されている要素から簡単に派生できます。ソース ID は通常、この要素の ID です。ただし、より複雑なコンテンツを生成するコンポーネントでは、動作スクリプトが jakarta.faces.source 値に使用する正しい ID を決定できない場合があります。getSourceId() メソッドにより、コンポーネントはこの情報を ClientBehavior.getScript(jakarta.faces.component.behavior.ClientBehaviorContext) 実装に渡すことができます。

  戻り値:

  振る舞いのスクリプトが「ソース」として使用する ID。振る舞いのスクリプトが DOM からソースを識別できる場合は null。

  導入:

  2.0

• getParameters

  public abstract CollectionSE<ClientBehaviorContext.Parameter> getParameters()

  Faces ライフサイクルにデータをポストバックするときに ClientBehavior 実装を「送信」する必要があるパラメーターを返します。パラメーターが指定されていない場合、このメソッドは空の（null 以外の）コレクションを返します。

  戻り値:

  パラメーター。

  導入:

  2.0