クラス AjaxBehavior
- java.lang.ObjectSE
-
- jakarta.faces.component.behavior.BehaviorBase
-
- jakarta.faces.component.behavior.ClientBehaviorBase
-
- jakarta.faces.component.behavior.AjaxBehavior
- 実装されているすべてのインターフェース:
Behavior、ClientBehavior、PartialStateHolder、StateHolder
public class AjaxBehavior extends ClientBehaviorBase
このクラスの インスタンスは、コンポーネントが実装する
ClientBehaviorHolder.addClientBehavior(java.lang.String, jakarta.faces.component.behavior.ClientBehavior)契約を使用して、コンポーネントにClientBehaviorとして追加されます。このClientBehaviorが存在すると、コンポーネントのレンダリング時に、仕様のパブリック JavaScript API を使用してAjaxリクエストを生成する JavaScript がレンダリングされます。コンポーネントが
EditableValueHolderのインスタンスの場合、可能な場合は、コンポーネントでフォーカスが失われたときではなく、初期値が変更されたときにコンポーネントが UI に ajax イベントを登録する必要があります。- 導入:
- 2.0
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 static StringSEBEHAVIOR_IDこの動作の標準 ID。
コンストラクターの概要
コンストラクター コンストラクター 説明 AjaxBehavior()このインスタンスを作成するだけのデフォルトコンストラクター。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 voidaddAjaxBehaviorListener(AjaxBehaviorListener listener)指定されたAjaxBehaviorListenerを、このAjaxBehaviorからイベント通知を受信するために登録されたリスナーのセットに追加します。StringSEgetDelay()遅延値を返します。値が設定されていない場合はnullを返します。CollectionSE<StringSE>getExecute()リクエスト処理ライフサイクルのexecuteフェーズで処理する必要があるコンポーネントを識別するために使用されるコンポーネント識別子の空でないCollection<String>を返します。SetSE<ClientBehaviorHint>getHints()StringSEgetOnerror()エラー発生時に実行する必要があるクライアントコールバック関数を識別するために使用される JavaScript 関数名のStringを返します。StringSEgetOnevent()クライアント側イベントの発生時に実行されるクライアントコールバック関数を識別するために使用される JavaScript 関数名のStringを返します。CollectionSE<StringSE>getRender()リクエスト処理ライフサイクルのrenderフェーズで処理する必要があるコンポーネントを識別するために使用されるコンポーネント識別子の空でないCollection<String>を返します。StringSEgetRendererType()動作に使用するClientBehaviorRendererのレンダラー型を返します。ValueExpressiongetValueExpression(StringSE name)指定されたプロパティ名がある場合、その値の計算に使用されるValueExpressionを返します。booleanisDisabled()この動作の無効ステータスを返します。booleanisImmediate()この動作の即時ステータスを返します。booleanisImmediateSet()即時属性が指定されているかどうかをテストします。booleanisResetValues()この動作の resetValues ステータスを返します。booleanisResetValuesSet()resetValues 属性が指定されているかどうかをテストします。voidremoveAjaxBehaviorListener(AjaxBehaviorListener listener)このAjaxBehaviorからイベント通知を受信するために登録されたリスナーのセットから、指定されたAjaxBehaviorListenerを削除します。voidrestoreState(FacesContext context, ObjectSE state)ObjectSEsaveState(FacesContext context)voidsetDelay(StringSE delay)request() の呼び出しの間隔が delay ミリ秒未満の場合、最新の呼び出しのみが送信され、他のすべてのリクエストは破棄されます。voidsetDisabled(boolean disabled)この動作の無効ステータスを設定します。voidsetExecute(CollectionSE<StringSE> execute)リクエスト処理ライフサイクルのexecuteフェーズで処理する必要があるコンポーネントを識別するために使用されるコンポーネント識別子を設定します。voidsetImmediate(boolean immediate)この動作の即時ステータスを設定します。voidsetOnerror(StringSE onerror)エラー発生時に実行する必要があるクライアントコールバック関数を識別するために使用される JavaScript 関数名を設定します。voidsetOnevent(StringSE onevent)イベントアクティビティにレスポンスして実行されるクライアントコールバック関数を識別するために使用される JavaScript 関数名を設定します。voidsetRender(CollectionSE<StringSE> render)リクエスト処理ライフサイクルのrenderフェーズで処理する必要があるコンポーネントを識別するために使用されるコンポーネント識別子を設定します。voidsetResetValues(boolean resetValues)この動作の resetValues ステータスを設定します。voidsetValueExpression(StringSE name, ValueExpression binding)指定されたプロパティ名の値を計算するために使用されるValueExpressionを設定します。クラス jakarta.faces.component.behavior.ClientBehaviorBase から継承されたメソッド
decode, getRenderer, getScript
クラス jakarta.faces.component.behavior.BehaviorBase から継承されたメソッド
addBehaviorListener, broadcast, clearInitialState, initialStateMarked, isTransient, markInitialState, removeBehaviorListener, setTransient
メソッドの詳細
getRendererType
public StringSE getRendererType()
クラスからコピーされた説明:ClientBehaviorBase動作に使用する
ClientBehaviorRendererのレンダラー型を返します。デフォルトの実装は null を返します。サブクラスは、このメソッドをオーバーライドして、使用するClientBehaviorRendererの型を識別する文字列を返すか、ClientBehaviorBase.getScript(jakarta.faces.component.behavior.ClientBehaviorContext)をオーバーライドして、ClientBehavior実装でローカルにスクリプトレンダリングを実行する必要があります。- オーバーライド:
- クラス
ClientBehaviorBaseのgetRendererType - 戻り値:
- デフォルトのレンダラー型。null です。
getHints
public SetSE<ClientBehaviorHint> getHints()
このメソッドは、
ClientBehaviorHintSUBMITTINGを含む変更不可能なSetを返します。- 次で指定:
- インターフェース
ClientBehaviorのgetHints - オーバーライド:
- クラス
ClientBehaviorBaseのgetHints - 戻り値:
- ヒント
ClientBehaviorHintSUBMITTINGを含む変更不可能なセット。 - 導入:
- 2.0
getOnerror
public StringSE getOnerror()
エラー発生時に実行する必要があるクライアントコールバック関数を識別するために使用される JavaScript 関数名の
Stringを返します。- 戻り値:
ONERRORの JavaScript 関数名。- 導入:
- 2.0
setOnerror
public void setOnerror(StringSE onerror)
エラー発生時に実行する必要があるクライアントコールバック関数を識別するために使用される JavaScript 関数名を設定します。
- パラメーター:
onerror- エラー処理関数名- 導入:
- 2.0
getOnevent
public StringSE getOnevent()
クライアント側イベントの発生時に実行されるクライアントコールバック関数を識別するために使用される JavaScript 関数名の
Stringを返します。- 戻り値:
ONEVENTの JavaScript 関数名。- 導入:
- 2.0
setOnevent
public void setOnevent(StringSE onevent)
イベントアクティビティにレスポンスして実行されるクライアントコールバック関数を識別するために使用される JavaScript 関数名を設定します。
- パラメーター:
onevent- イベント処理関数名- 導入:
- 2.0
getExecute
public CollectionSE<StringSE> getExecute()
リクエスト処理ライフサイクルの
executeフェーズで処理する必要があるコンポーネントを識別するために使用されるコンポーネント識別子の空でないCollection<String>を返します。返されたコレクションは変更できない場合があることに注意してください。変更は、
setExecute(java.util.Collection<java.lang.String>)を呼び出して実行する必要があります。- 戻り値:
EXECUTEの JavaScript 関数名。- 導入:
- 2.0
setExecute
public void setExecute(CollectionSE<StringSE> execute)
リクエスト処理ライフサイクルの
executeフェーズで処理する必要があるコンポーネントを識別するために使用されるコンポーネント識別子を設定します。- パラメーター:
execute- 実行するコンポーネントの ID- 導入:
- 2.0
getDelay
public StringSE getDelay()
遅延値を返します。値が設定されていない場合は
nullを返します。- 戻り値:
- 遅延値。
- 導入:
- 2.2
setDelay
public void setDelay(StringSE delay)
request() の呼び出しの間に遅延ミリ秒未満が経過すると、最新のリクエストのみが送信され、他のすべてのリクエストは破棄されます。遅延の値は引用符なし文字列リテラルの
'none'ある場合は、このオプションのデフォルト値は 300 です、遅延は使用されません。- パラメーター:
delay- ajax 遅延値- 導入:
- 2.2
getRender
public CollectionSE<StringSE> getRender()
リクエスト処理ライフサイクルの
renderフェーズで処理する必要があるコンポーネントを識別するために使用されるコンポーネント識別子の空でないCollection<String>を返します。返されたコレクションは変更できない場合があることに注意してください。変更は、
setRender(java.util.Collection<java.lang.String>)を呼び出して実行する必要があります。- 戻り値:
- レンダリングするコンポーネントの ID。
- 導入:
- 2.0
setRender
public void setRender(CollectionSE<StringSE> render)
リクエスト処理ライフサイクルの
renderフェーズで処理する必要があるコンポーネントを識別するために使用されるコンポーネント識別子を設定します。- パラメーター:
render- レンダリングするコンポーネントの ID- 導入:
- 2.0
isResetValues
public boolean isResetValues()
この動作の resetValues ステータスを返します。
- 戻り値:
- resetValues ステータス。
- 導入:
- 2.2
setResetValues
public void setResetValues(boolean resetValues)
この動作の resetValues ステータスを設定します。
- パラメーター:
resetValues- resetValues ステータス。- 導入:
- 2.2
isDisabled
public boolean isDisabled()
この動作の無効ステータスを返します。
- 戻り値:
- この動作の無効ステータス。
- 導入:
- 2.0
setDisabled
public void setDisabled(boolean disabled)
この動作の無効ステータスを設定します。
- パラメーター:
disabled- 設定するフラグ。- 導入:
- 2.0
isImmediate
public boolean isImmediate()
この動作の即時ステータスを返します。
- 戻り値:
- 即時ステータス。
- 導入:
- 2.0
setImmediate
public void setImmediate(boolean immediate)
この動作の即時ステータスを設定します。
- パラメーター:
immediate- 設定するフラグ。- 導入:
- 2.0
isImmediateSet
public boolean isImmediateSet()
即時属性が指定されているかどうかをテストします。ローカルに設定されたプロパティまたは値式のいずれかとして immediate 属性が指定されている場合は true を返します。この情報により、
AjaxBehaviorで immediate が明示的に指定されていない場合に、関連するクライアント動作レンダラーが親コンポーネントの immediate ステータスにフォールバックできます。- 戻り値:
- 即時属性が指定されているかどうかのフラグ。
- 導入:
- 2.0
isResetValuesSet
public boolean isResetValuesSet()
resetValues 属性が指定されているかどうかをテストします。ローカルに設定されたプロパティまたは値式として resetValues 属性が指定されている場合は true を返します。
- 戻り値:
- resetValues 属性が指定されているかどうかを示すフラグ。
- 導入:
- 2.2
getValueExpression
public ValueExpression getValueExpression(StringSE name)
指定されたプロパティ名がある場合、その値の計算に使用される
ValueExpressionを返します。- パラメーター:
name-ValueExpressionを取得するプロパティの名前- 戻り値:
ValueExpression- 例外:
NullPointerExceptionSE-nameがnullの場合
setValueExpression
public void setValueExpression(StringSE name, ValueExpression binding)
指定されたプロパティ名の値を計算するために使用される
ValueExpressionを設定します。- パラメーター:
name-ValueExpressionを設定するプロパティの名前binding- 設定するValueExpression、または現在設定されているValueExpressionを削除するnull- 例外:
NullPointerExceptionSE-nameがnullの場合
addAjaxBehaviorListener
public void addAjaxBehaviorListener(AjaxBehaviorListener listener)
指定された
AjaxBehaviorListenerを、このAjaxBehaviorからイベント通知を受信するために登録されたリスナーのセットに追加します。- パラメーター:
listener- 登録するAjaxBehaviorListener- 例外:
NullPointerExceptionSE-listenerがnullの場合- 導入:
- 2.0
removeAjaxBehaviorListener
public void removeAjaxBehaviorListener(AjaxBehaviorListener listener)
この
AjaxBehaviorからイベント通知を受信するために登録されたリスナーのセットから、指定されたAjaxBehaviorListenerを削除します。- パラメーター:
listener- 削除するAjaxBehaviorListener- 例外:
NullPointerExceptionSE-listenerがnullの場合- 導入:
- 2.0
saveState
public ObjectSE saveState(FacesContext context)
クラスからコピーされた説明:BehaviorBase- 次で指定:
- インターフェース
StateHolderのsaveState - オーバーライド:
- クラス
BehaviorBaseのsaveState - パラメーター:
context- Faces コンテキスト。- 戻り値:
- 保存された状態。
restoreState
public void restoreState(FacesContext context, ObjectSE state)
クラスからコピーされた説明:BehaviorBase- 次で指定:
- インターフェース
StateHolderのrestoreState - オーバーライド:
- クラス
BehaviorBaseのrestoreState - パラメーター:
context- Faces コンテキスト。state- 状態。