public abstract class FacesEvent extends EventObjectSE
FacesEvent は、UIComponent
によって起動できるユーザーインターフェースとアプリケーションイベントの基本クラスです。具象イベントクラスは、リクエスト処理ライフサイクルでサポートされるために、FacesEvent
をサブクラス化する必要があります。
sourceSE
コンストラクターと説明 |
---|
FacesEvent(FacesContext facesContext, UIComponent component) Faces コンテキストと指定されたソースコンポーネントから新しいイベントオブジェクトを構築します。 |
FacesEvent(UIComponent component) 指定されたソースコンポーネントから新しいイベントオブジェクトを構築します。 |
修飾子と型 | メソッドと説明 |
---|---|
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 を設定します。 |
getSourceSE, toStringSE
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE
public FacesEvent(UIComponent component)
指定されたソースコンポーネントから新しいイベントオブジェクトを構築します。
component
- このイベントのソース UIComponent
IllegalArgumentExceptionSE
- component
が null
の場合 public FacesEvent(FacesContext facesContext, UIComponent component)
Faces コンテキストと指定されたソースコンポーネントから新しいイベントオブジェクトを構築します。
facesContext
- Faces コンテキスト。component
- このイベントのソース UIComponent
。IllegalArgumentExceptionSE
- component
が null
の場合 public UIComponent getComponent()
このイベントを送信したソース UIComponent
を返します。
public FacesContext getFacesContext()
Faces コンテキストを取得します。
コンストラクターに FacesContext が渡された場合はそれを返し、そうでない場合は FacesContext.getCurrentInstance() を呼び出して返します。
public PhaseId getPhaseId()
このイベントを配信する必要があるリクエスト処理フェーズの識別子を返します。有効な値は、デフォルト値である PhaseId.ANY_PHASE
を含む、PhaseId
クラスによって定義されたシングルトンインスタンスです。
public void setPhaseId(PhaseId phaseId)
このイベントが配信される PhaseId
を設定します。
phaseId
- フェーズ ID。IllegalArgumentExceptionSE
- phaseId は null です。public void queue()
現在のリクエスト処理ライフサイクルフェーズの最後にブロードキャストのためにこのイベントをキューに入れる便利なメソッド。
IllegalStateExceptionSE
- このイベントのソースコンポーネントが UIViewRoot
の子孫でない場合 public abstract boolean isAppropriateListener(FacesListener listener)
この FacesListener
がこのイベントがサポートするリスナークラスのインスタンスである場合、true
を返します。通常、これは、リスナークラスの "instanceof" チェックによって実現されます。
listener
- 評価する FacesListener
public abstract void processListener(FacesListener listener)
適切なメカニズムにより、この FacesEvent
を指定された FacesListener
にブロードキャストします。通常、これはイベント処理メソッドを呼び出し、この FacesEvent
をパラメーターとして渡すことで実現されます。
listener
- この FacesEvent
を送信する FacesListener
AbortProcessingException
- Jakarta Server Faces 実装に、現在のイベントでこれ以上の処理を実行しないことを通知します Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.