クラス FacesEvent
- java.lang.ObjectSE
-
- java.util.EventObjectSE
-
- jakarta.faces.event.FacesEvent
- 実装済みのインターフェース一覧:
SerializableSE
- 既知の直属サブクラス
ActionEvent、BehaviorEvent、ValueChangeEvent
public abstract class FacesEvent extends EventObjectSE
FacesEvent は、
UIComponentによって起動できるユーザーインターフェースとアプリケーションイベントの基本クラスです。具象イベントクラスは、リクエスト処理ライフサイクルでサポートされるために、FacesEventをサブクラス化する必要があります。- 関連事項:
- 連載形式
フィールド概要
クラス java.util.EventObjectSE から継承されたフィールド
sourceSE
コンストラクター概要
コンストラクター コンストラクター 説明 FacesEvent(UIComponent component)指定されたソースコンポーネントから新しいイベントオブジェクトを構築します。FacesEvent(FacesContext facesContext, UIComponent component)Faces コンテキストと指定されたソースコンポーネントから新しいイベントオブジェクトを構築します。
方法の概要
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 UIComponentgetComponent()このイベントを送信したソースUIComponentを返します。FacesContextgetFacesContext()Faces コンテキストを取得します。PhaseIdgetPhaseId()このイベントを配信する必要があるリクエスト処理フェーズの識別子を返します。abstract booleanisAppropriateListener(FacesListener listener)このFacesListenerがこのイベントがサポートするリスナークラスのインスタンスである場合、trueを返します。abstract voidprocessListener(FacesListener listener)適切なメカニズムにより、このFacesEventを指定されたFacesListenerにブロードキャストします。voidqueue()現在のリクエスト処理ライフサイクルフェーズの最後にブロードキャストのためにこのイベントをキューに入れる便利なメソッド。voidsetPhaseId(PhaseId phaseId)このイベントが配信されるPhaseIdを設定します。クラス java.util.EventObjectSE から継承されたメソッド
getSource, toString
コンストラクターの詳細
FacesEvent
public FacesEvent(UIComponent component)
指定されたソースコンポーネントから新しいイベントオブジェクトを構築します。
- パラメーター:
component- このイベントのソースUIComponent- 例外:
IllegalArgumentExceptionSE-componentがnullの場合
FacesEvent
public FacesEvent(FacesContext facesContext, UIComponent component)
Faces コンテキストと指定されたソースコンポーネントから新しいイベントオブジェクトを構築します。
- パラメーター:
facesContext- Faces コンテキスト。component- このイベントのソースUIComponent。- 例外:
IllegalArgumentExceptionSE-componentがnullの場合- 導入:
- 2.3
メソッドの詳細
getComponent
public UIComponent getComponent()
このイベントを送信したソース
UIComponentを返します。- 戻り値:
- ソース UI コンポーネント。
getFacesContext
public FacesContext getFacesContext()
Faces コンテキストを取得します。
コンストラクターに FacesContext が渡された場合はそれを返し、そうでない場合は FacesContext.getCurrentInstance() を呼び出して返します。
- 戻り値:
- Faces コンテキスト。
- 導入:
- 2.3
getPhaseId
public PhaseId getPhaseId()
このイベントを配信する必要があるリクエスト処理フェーズの識別子を返します。有効な値は、デフォルト値である
PhaseId.ANY_PHASEを含む、PhaseIdクラスによって定義されたシングルトンインスタンスです。- 戻り値:
- フェーズ ID。
setPhaseId
public void setPhaseId(PhaseId phaseId)
このイベントが配信される
PhaseIdを設定します。- パラメーター:
phaseId- フェーズ ID。- 例外:
IllegalArgumentExceptionSE- phaseId は null です。
queue
public void queue()
現在のリクエスト処理ライフサイクルフェーズの最後にブロードキャストのためにこのイベントをキューに入れる便利なメソッド。
- 例外:
IllegalStateExceptionSE- このイベントのソースコンポーネントがUIViewRootの子孫でない場合
isAppropriateListener
public abstract boolean isAppropriateListener(FacesListener listener)
この
FacesListenerがこのイベントがサポートするリスナークラスのインスタンスである場合、trueを返します。通常、これは、リスナークラスの "instanceof" チェックによって実現されます。- パラメーター:
listener- 評価するFacesListener- 戻り値:
- 適切なインスタンスである場合は true、そうでない場合は false。
processListener
public abstract void processListener(FacesListener listener)
適切なメカニズムにより、この
FacesEventを指定されたFacesListenerにブロードキャストします。通常、これはイベント処理メソッドを呼び出し、このFacesEventをパラメーターとして渡すことで実現されます。- パラメーター:
listener- このFacesEventを送信するFacesListener- 例外:
AbortProcessingException- Jakarta Faces 実装に、現在のイベントでこれ以上の処理を実行しないことを通知します