パッケージ jakarta.faces.event

クラス FacesEvent

  • 実装されたすべてのインターフェース:
    SerializableSE
    既知の直属サブクラス
    ActionEventBehaviorEventValueChangeEvent

    public abstract class FacesEvent
    extends EventObjectSE

    FacesEvent は、UIComponent によって起動できるユーザーインターフェースとアプリケーションイベントの基本クラスです。具象イベントクラスは、リクエスト処理ライフサイクルでサポートされるために、FacesEvent をサブクラス化する必要があります。

    関連事項:
    直列化された形式
    • コンストラクターの詳細

      • 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 実装に、現在のイベントでこれ以上の処理を実行しないことを通知します