クラス javax.faces.event.SystemEvent の使用 (Jakarta EE 仕様 API)

SystemEvent を使用するパッケージ
パッケージ説明
javax.faces.application
javax.faces.component
javax.faces.context
javax.faces.event

SystemEvent を使用するパッケージ
パッケージ	説明
javax.faces.application
javax.faces.component
javax.faces.context
javax.faces.event

javax.faces.application 内の SystemEvent 使用

型 SystemEvent の型引数を持つ javax.faces.application のメソッドパラメーター
修飾子と型	メソッドと説明
`void`	ApplicationWrapper.`publishEvent(FacesContext context, ClassSE<? extends SystemEvent> systemEventClass, ClassSE<?> sourceBaseType, ObjectSE source)` このメソッドのデフォルトの動作は、ラップされた `Application` オブジェクトで `Application.publishEvent(javax.faces.context.FacesContext, Class, Class, Object)` を呼び出すことです。
`void`	Application.`publishEvent(FacesContext context, ClassSE<? extends SystemEvent> systemEventClass, ClassSE<?> sourceBaseType, ObjectSE source)` このメソッドは、`source` 引数の `Class` を使用する代わりに、ランタイムが引数 `sourceBaseType` を使用して一致するリスナーを検索する必要があることを除いて、`Application.publishEvent(FacesContext,Class,Object)` とまったく同じように機能します。
`void`	ApplicationWrapper.`publishEvent(FacesContext context, ClassSE<? extends SystemEvent> systemEventClass, ObjectSE source)` このメソッドのデフォルトの動作は、ラップされた `Application` オブジェクトで `Application.publishEvent(javax.faces.context.FacesContext, Class, Object)` を呼び出すことです。
`void`	Application.`publishEvent(FacesContext context, ClassSE<? extends SystemEvent> systemEventClass, ObjectSE source)` `FacesContext.isProcessingEvents()` が `true` であり、`systemEventClass` で表される型のイベントのリスナーが 1 つ以上ある場合は、それらのリスナーを呼び出して、イベントのソースとして `source` を渡します。
`void`	ApplicationWrapper.`subscribeToEvent(ClassSE<? extends SystemEvent> systemEventClass, ClassSE<?> sourceClass, SystemEventListener listener)` このメソッドのデフォルトの動作は、ラップされた `Application` オブジェクトで `Application.subscribeToEvent(Class, Class, javax.faces.event.SystemEventListener)` を呼び出すことです。
`void`	Application.`subscribeToEvent(ClassSE<? extends SystemEvent> systemEventClass, ClassSE<?> sourceClass, SystemEventListener listener)` 引数 `listener` で参照されるリスナーインスタンスを、型 `sourceClass` のオブジェクトから発生する型 `systemEventClass` のイベントのリスナーとしてアプリケーションにインストールします。
`void`	ApplicationWrapper.`subscribeToEvent(ClassSE<? extends SystemEvent> systemEventClass, SystemEventListener listener)` このメソッドのデフォルトの動作は、ラップされた `Application` オブジェクトで `Application.subscribeToEvent(Class, javax.faces.event.SystemEventListener)` を呼び出すことです。
`void`	Application.`subscribeToEvent(ClassSE<? extends SystemEvent> systemEventClass, SystemEventListener listener)` 引数 `listener` で参照されるリスナーインスタンスを、型 `systemEventClass` のイベントのリスナーとしてアプリケーションにインストールします。
`void`	ApplicationWrapper.`unsubscribeFromEvent(ClassSE<? extends SystemEvent> systemEventClass, ClassSE<?> sourceClass, SystemEventListener listener)` このメソッドのデフォルトの動作は、ラップされた `Application` オブジェクトで `Application.unsubscribeFromEvent(Class, Class, javax.faces.event.SystemEventListener)` を呼び出すことです。
`void`	Application.`unsubscribeFromEvent(ClassSE<? extends SystemEvent> systemEventClass, ClassSE<?> sourceClass, SystemEventListener listener)` `sourceClass` 型のオブジェクトから発生する `systemEventClass` 型のイベントのリスナーとして、引数 `listener` で参照されるリスナーインスタンスをアプリケーションから削除します。
`void`	ApplicationWrapper.`unsubscribeFromEvent(ClassSE<? extends SystemEvent> systemEventClass, SystemEventListener listener)` このメソッドのデフォルトの動作は、ラップされた `Application` オブジェクトで `Application.unsubscribeFromEvent(Class, javax.faces.event.SystemEventListener)` を呼び出すことです。
`void`	Application.`unsubscribeFromEvent(ClassSE<? extends SystemEvent> systemEventClass, SystemEventListener listener)` 引数 `listener` によって参照されるリスナーインスタンスを、型 `systemEventClass` のイベントのリスナーとしてアプリケーションから削除します。

javax.faces.component 内の SystemEvent 使用

型 SystemEvent の型引数を持つ javax.faces.component のメソッドパラメーター
修飾子と型	メソッドと説明
`ListSE<SystemEventListener>`	UIComponentBase.`getListenersForEventClass(ClassSE<? extends SystemEvent> eventClass)` 型 `eventClass` のイベントに関心のある、この `UIComponent` インスタンスに登録されている `SystemEventListener` インスタンスを返します。
`ListSE<SystemEventListener>`	UIComponent.`getListenersForEventClass(ClassSE<? extends SystemEvent> eventClass)` この実装は `UnsupportedOperationException` をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
`ListSE<SystemEventListener>`	UIViewRoot.`getViewListenersForEventClass(ClassSE<? extends SystemEvent> systemEvent)` 型 `eventClass` のイベントに関心のある、この `UIComponent` インスタンスに登録されている `SystemEventListener` インスタンスを返します。
`void`	UIComponentBase.`subscribeToEvent(ClassSE<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener)` 引数 `componentListener` によって参照されるリスナーインスタンスを、この `UIComponent` の特定のインスタンスから発生する `eventClass` 型のイベントのリスナーとしてインストールします。
`void`	UIComponent.`subscribeToEvent(ClassSE<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener)` この実装は `UnsupportedOperationException` をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
`void`	UIViewRoot.`subscribeToViewEvent(ClassSE<? extends SystemEvent> systemEvent, SystemEventListener listener)` 引数 `listener` によって参照されるリスナーインスタンスを、型 `systemEventClass` のイベントのリスナーとして `UIViewRoot` にインストールします。
`void`	UIComponentBase.`unsubscribeFromEvent(ClassSE<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener)` 引数 `componentListener` によって参照されるリスナーインスタンスを、この `UIComponent` の特定のインスタンスから発生する型 `eventClass` のイベントのリスナーとして削除します。
`void`	UIComponent.`unsubscribeFromEvent(ClassSE<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener)` この実装は `UnsupportedOperationException` をスローし、このクラスを継承する既存のアプリケーションを壊さないという唯一の目的のために提供されています。
`void`	UIViewRoot.`unsubscribeFromViewEvent(ClassSE<? extends SystemEvent> systemEvent, SystemEventListener listener)` 型 `systemEventClass` のイベントのリスナーとして、引数 `listener` によって参照されるリスナーインスタンスを `UIViewRoot` から削除します。

javax.faces.context 内の SystemEvent 使用

型 SystemEvent のパラメーターを持つ javax.faces.context のメソッド
修飾子と型	メソッドと説明
`void`	ExceptionHandlerWrapper.`processEvent(SystemEvent event)` このメソッドのデフォルトの動作は、ラップされた `ExceptionHandler` オブジェクトで `ExceptionHandler.processEvent(javax.faces.event.SystemEvent)` を呼び出すことです。
`abstract void`	ExceptionHandler.`processEvent(SystemEvent exceptionQueuedEvent)` 呼び出されると、リスナーは、特定の `SystemEvent` サブクラスの javadoc で指定されたすべての保証が真であると想定できます。

javax.faces.event 内の SystemEvent 使用

javax.faces.event 内の SystemEvent サブクラス
修飾子と型	クラスと説明
`class`	`ComponentSystemEvent` ComponentSystemEvent は、`UIComponent` インスタンスに固有の `SystemEvent` の基本クラスです。
`class`	`ExceptionQueuedEvent` システムイベントファシリティは、`systemEventClass` 引数として `ExceptionQueuedEvent.class` を指定して `Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)` が呼び出されるたびに、このクラスのインスタンスを作成します。
`class`	`PostAddToViewEvent` このイベントのインスタンスが `SystemEventListener.processEvent(javax.faces.event.SystemEvent)` または `ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)` に渡されると、リスナーの実装では、このイベントインスタンスの `source` が `UIComponent` インスタンスと、そのインスタンスまたはそのインスタンスの祖先のいずれかがちょうどビューに追加されたことと仮定することができます。
`class`	`PostConstructApplicationEvent` このイベントは、すべての構成リソースが解析および処理された後に、ランタイムによって発行される必要があります。
`class`	`PostConstructCustomScopeEvent` このクラスは、アプリケーションがスコープの開始を認識できるようにするために他のスコープが行うのと同じ方法で、カスタムスコープが「ポストコンストラクト」イベントを発行できるようにするために提供されています。
`class`	`PostConstructViewMapEvent` このイベントは、ビューマップが最初に作成されたときに {javax.faces.application.Application#publishEvent} を呼び出して発行する必要があります。
`class`	`PostKeepFlashValueEvent` このイベントは、値がフラッシュに保持されているときに、`Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)` を呼び出して発行する必要があります。
`class`	`PostPutFlashValueEvent` このイベントは、値がフラッシュに保存されているときに `Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)` を呼び出すことによって発行する必要があります。
`class`	`PostRenderViewEvent` このイベントのインスタンスが `SystemEventListener.processEvent(javax.faces.event.SystemEvent)` または `ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)` に渡されると、リスナーの実装は、このイベントインスタンスの `source` が、レンダリングされたばかりの `UIViewRoot` インスタンスであると想定する場合があります。
`class`	`PostRestoreStateEvent` このイベントのインスタンスが `SystemEventListener.processEvent(javax.faces.event.SystemEvent)` または `ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)` に渡されると、リスナーの実装は、このイベントインスタンスの `source` が、状態が復元されたばかりのツリーにあると想定する場合があります。
`class`	`PostValidateEvent` このイベントのインスタンスが `SystemEventListener.processEvent(javax.faces.event.SystemEvent)` または `ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)` に渡されると、リスナー実装は、このイベントインスタンスの `source` が、検証されたばかりの `UIComponent` インスタンスであると想定する場合があります。
`class`	`PreClearFlashEvent` このイベントは、フラッシュがクリアされる前に、`Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)` を呼び出して発行する必要があります。
`class`	`PreDestroyApplicationEvent` このイベントは、この `Application` に関連付けられたファクトリがリリースされる前に、ランタイムによって発行される必要があります。
`class`	`PreDestroyCustomScopeEvent` このクラスは、アプリケーションがスコープの始まりを認識できるようにするために他のスコープが行うのと同じ方法で、カスタムスコープが「事前構成」イベントを発行できるようにするために提供されています。
`class`	`PreDestroyViewMapEvent` このイベントは、`UIViewRoot.getViewMap()` から返されたマップで `clear` メソッドが呼び出されたときに、`Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)` を呼び出して発行する必要があります。
`class`	`PreRemoveFlashValueEvent` このイベントは、フラッシュから値が削除されたときに `Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)` を呼び出して発行する必要があります。
`class`	`PreRemoveFromViewEvent` このイベントのインスタンスが `SystemEventListener.processEvent(javax.faces.event.SystemEvent)` または `ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)` に渡されると、リスナーの実装は、このイベントインスタンスの `source` がビューから削除されようとしている `UIComponent` インスタンスであると想定する場合があります。
`class`	`PreRenderComponentEvent` このイベントのインスタンスが `SystemEventListener.processEvent(javax.faces.event.SystemEvent)` または `ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)` に渡されると、リスナーの実装は、このイベントインスタンスの `source` がレンダリングされる `UIComponent` インスタンスであり、`UIComponent.getParent()`、`UIComponent.getClientId()`、その他のメソッドを呼び出しても安全であると想定する場合があります。ビューにあるコンポーネントインスタンスに依存します。
`class`	`PreRenderViewEvent` このイベントのインスタンスが `SystemEventListener.processEvent(javax.faces.event.SystemEvent)` または `ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)` に渡されると、リスナーの実装は、このイベントインスタンスの `source` が、これからレンダリングされる `UIViewRoot` インスタンスであると想定する場合があります。
`class`	`PreValidateEvent` このイベントのインスタンスが `SystemEventListener.processEvent(javax.faces.event.SystemEvent)` または `ComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)` に渡されると、リスナーの実装は、このイベントインスタンスの `source` が検証される `UIComponent` インスタンスであると想定する場合があります。

型 SystemEvent のパラメーターを持つ javax.faces.event のメソッド
修飾子と型	メソッドと説明
`void`	SystemEventListener.`processEvent(SystemEvent event)` 呼び出されると、リスナーは、特定の `SystemEvent` サブクラスの javadoc で指定されたすべての保証が真であると想定できます。

型 SystemEvent の型引数を持つ javax.faces.event のメソッドパラメーター
修飾子と型	メソッドと説明
`ListSE<SystemEventListener>`	SystemEventListenerHolder.`getListenersForEventClass(ClassSE<? extends SystemEvent> facesEventClass)`
`ListSE<SystemEventListener>`	ExceptionQueuedEventContext.`getListenersForEventClass(ClassSE<? extends SystemEvent> facesEventClass)` 現在のリクエストの `ExceptionHandler` という 1 つのエントリを含む `List` を返します。

クラスの使用 javax.faces.event.SystemEvent

javax.faces.application 内の SystemEvent 使用

javax.faces.component 内の SystemEvent 使用

javax.faces.context 内の SystemEvent 使用

javax.faces.event 内の SystemEvent 使用

クラスの使用
javax.faces.event.SystemEvent