クラス 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 コンテキストと指定されたソースコンポーネントから新しいイベントオブジェクトを構築します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 UIComponent
getComponent()
このイベントを送信したソースUIComponent
を返します。FacesContext
getFacesContext()
Faces コンテキストを取得します。PhaseId
getPhaseId()
このイベントを配信する必要があるリクエスト処理フェーズの識別子を返します。abstract boolean
isAppropriateListener(FacesListener listener)
このFacesListener
がこのイベントがサポートするリスナークラスのインスタンスである場合、true
を返します。abstract void
processListener(FacesListener listener)
適切なメカニズムにより、このFacesEvent
を指定されたFacesListener
にブロードキャストします。void
queue()
現在のリクエスト処理ライフサイクルフェーズの最後にブロードキャストのためにこのイベントをキューに入れる便利なメソッド。void
setPhaseId(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 実装に、現在のイベントでこれ以上の処理を実行しないことを通知します