public abstract class ClientBehaviorContext extends ObjectSE
ClientBehaviorContext は、ClientBehavior.getScript(javax.faces.component.behavior.ClientBehaviorContext)
の実装に役立つコンテキスト情報を提供します。
修飾子と型 | クラスと説明 |
---|---|
static class | ClientBehaviorContext.Parameter パラメーターインスタンスは、Faces ライフサイクルにポストバックするときに ClientBehavior 実装を「送信」するときに含める必要がある名前 / 値のペアを表します。 |
修飾子と型 | フィールドと説明 |
---|---|
static StringSE | BEHAVIOR_EVENT_PARAM_NAME リクエストパラメーター値が動作イベントの型を識別するリクエストパラメーター名。 |
static StringSE | BEHAVIOR_SOURCE_PARAM_NAME リクエストパラメーター値が動作イベントのソースコンポーネントを識別するリクエストパラメーター名。 |
コンストラクターと説明 |
---|
ClientBehaviorContext() |
修飾子と型 | メソッドと説明 |
---|---|
static ClientBehaviorContext | createClientBehaviorContext(FacesContext context, UIComponent component, StringSE eventName, StringSE sourceId, CollectionSE<ClientBehaviorContext.Parameter> parameters) ClientBehaviorContext インスタンスを作成します。 |
abstract UIComponent | getComponent()
|
abstract StringSE | getEventName() ClientBehavior スクリプトがリクエストされている動作イベントの名前を返します。 |
abstract FacesContext | getFacesContext() 現在のリクエストの |
abstract CollectionSE<ClientBehaviorContext.Parameter> | getParameters() Faces ライフサイクルにデータをポストバックするときに |
abstract StringSE | getSourceId()
|
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public static final StringSE BEHAVIOR_SOURCE_PARAM_NAME
リクエストパラメーター値が動作イベントのソースコンポーネントを識別するリクエストパラメーター名。
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
の場合 public abstract FacesContext getFacesContext()
現在のリクエストの FacesContext
を返します。
FacesContext
public abstract UIComponent getComponent()
ClientBehavior
スクリプトをリクエストしている UIComponent
を返します。
public abstract StringSE getEventName()
ClientBehavior スクリプトがリクエストされている動作イベントの名前を返します。
public abstract StringSE getSourceId()
ClientBehavior
ソースとして使用する ID を返します。Faces ライフサイクルにサブミットする ClientBehavior 実装は、javax.faces.source
リクエストパラメーターを介して ClientBehavior が開始するリクエストをトリガーしたコンポーネントを識別する必要があります。ほとんどの場合、ソース ID は、振る舞いーのクライアント側スクリプトがアタッチされている要素から簡単に取得できます。ソース ID は通常、この要素の ID です。ただし、より複雑なコンテンツを生成するコンポーネントでは、動作スクリプトが javax.faces.source 値に使用する正しい ID を判別できない場合があります。getSourceId()
メソッドを使用すると、コンポーネントはこの情報を ClientBehavior.getScript(javax.faces.component.behavior.ClientBehaviorContext)
実装に渡すことができます。
public abstract CollectionSE<ClientBehaviorContext.Parameter> getParameters()
Faces ライフサイクルにデータをポストバックするときに ClientBehavior
実装を「送信」する必要があるパラメーターを返します。パラメーターが指定されていない場合、このメソッドは空の(null 以外の)コレクションを返します。
Copyright © 2019 Eclipse Foundation.
Use is subject to license terms.