EE4J 10.0.0 · jakarta.faces.event

Interface Summary

Modifier and Type	Interface and Description
public interface	ActionListener A listener interface for receiving `ActionEvent`s.
public interface	AjaxBehaviorListener By implementing this class, an object indicates that it is a listener for one or more kinds of `BehaviorEvent`s.
public interface	BehaviorListener A generic base interface for event listeners for various types of `BehaviorEvent`s.
public interface	ComponentSystemEventListener Implementors of this class do not need an `isListenerForSource()` method because they are only installed on specific component instances, therefore the `isListenerForSource()` method is implicit.
public interface	FacesListener A generic base interface for event listeners for various types of `FacesEvent`s.
public interface	PhaseListener An interface implemented by objects that wish to be notified at the beginning and ending of processing for each standard phase of the request processing lifecycle.
public interface	SystemEventListener By implementing this class, an object indicates that it is a listener for one or more kinds of `SystemEvent`s.
public interface	SystemEventListenerHolder Classes that implement this interface agree to maintain a list of `SystemEventListener` instances for each kind of `SystemEvent` they can generate.
public interface	ValueChangeListener A listener interface for receiving `ValueChangeEvent`s.
public interface	ViewMapListener Marker interface for `SystemEvent`s that indicate the view map has been created (`PostConstructViewMapEvent`, or destroyed (`PreDestroyViewMapEvent`).

Modifier and Type	Annotation and Description
public @interface	ListenerFor Classes tagged with this annotation are installed as listeners using the method `jakarta.faces.application.Application#subscribeToEvent` or `jakarta.faces.component.UIComponent#subscribeToEvent` (depending on the circumstances, described below).
public @interface	ListenersFor Container annotation to specify multiple `ListenerFor` annotations on a single class.
public @interface	NamedEvent The presence of this annotation on a class automatically registers the class with the runtime as a `ComponentSystemEvent` for use with the `<f:event />` tag in a page.

Class Summary

Modifier and Type	Class and Description
public class	AbortProcessingException An exception that may be thrown by event listeners to terminate the processing of the current event.
public class	ActionEvent An `ActionEvent` represents the activation of a user interface component (such as a `UICommand`).
public abstract class	ActionListenerWrapper Provides a simple implementation of `ActionListener` that can be subclassed by developers wishing to provide specialized behavior to an existing `ActionListener` instance.
public class	AjaxBehaviorEvent AjaxBehaviorEvent represents the component behavior specific to `Ajax`).
public abstract class	BehaviorEvent BehaviorEvent is the event that can be generated from component `jakarta.faces.component.behavior.Behavior`.
public abstract class	ComponentSystemEvent ComponentSystemEvent is the base class for `SystemEvent`s that are specific to a `UIComponent` instance.
public class	ExceptionQueuedEvent The system event facility will create an instance of this class whenever `jakarta.faces.application.Application#publishEvent` is called with `ExceptionQueuedEvent.class` as `systemEventClass` argument.
public class	ExceptionQueuedEventContext This helper class provides context to the `ExceptionQueuedEvent` regarding the state of the system at the point in time when the `ExceptionQueuedEvent` occurs and links the `ExceptionQueuedEvent` to the `jakarta.faces.context.ExceptionHandler` by virtue of implementing `SystemEventListener`.
public abstract class	FacesEvent FacesEvent is the base class for user interface and application events that can be fired by `UIComponent`s.
public class	MethodExpressionActionListener MethodExpressionActionListener is an `ActionListener` that wraps a `MethodExpression`.
public class	MethodExpressionValueChangeListener MethodExpressionValueChangeListener is a `ValueChangeListener` that wraps a `MethodExpression`.
public class	PhaseEvent PhaseEvent represents the beginning or ending of processing for a particular phase of the request processing lifecycle, for the request encapsulated by the specified `FacesContext`.
public class	PhaseId Typesafe enumeration of the legal values that may be returned by the `getPhaseId()` method of the `FacesEvent` interface.
public class	PostAddToViewEvent When an instance of this event is passed to `SystemEventListener#processEvent` or `ComponentSystemEventListener#processEvent`, the listener implementation may assume that the `source` of this event instance is a `UIComponent` instance and that either that instance or an ancestor of that instance was just added to the view.
public class	PostConstructApplicationEvent This event must be published by the runtime after all configuration resources have been parsed and processed.
public class	PostConstructCustomScopeEvent This class is provided to allow custom scopes to publish a "post construct" event in the same way that other scopes do to let the application become aware of the beginning of the scope.
public class	PostConstructViewMapEvent This event must be published by a call to {jakarta.faces.application.Application#publishEvent} when the view map is first created.
public class	PostKeepFlashValueEvent This event must be published by a call to `jakarta.faces.application.Application#publishEvent` when a value is kept in the flash.
public class	PostPutFlashValueEvent This event must be published by a call to `jakarta.faces.application.Application#publishEvent` when a value is stored in the flash.
public class	PostRenderViewEvent When an instance of this event is passed to `SystemEventListener#processEvent` or `ComponentSystemEventListener#processEvent`, the listener implementation may assume that the `source` of this event instance is the `UIViewRoot` instance that has just been rendered.
public class	PostRestoreStateEvent When an instance of this event is passed to `SystemEventListener#processEvent` or `ComponentSystemEventListener#processEvent`, the listener implementation may assume that the `source` of this event instance is in a tree that has just had its state restored.
public class	PostValidateEvent When an instance of this event is passed to `SystemEventListener#processEvent` or `ComponentSystemEventListener#processEvent`, the listener implementation may assume that the `source` of this event instance is the `UIComponent` instance that is that has just been validated.
public class	PreClearFlashEvent This event must be published by a call to `jakarta.faces.application.Application#publishEvent` before the flash is cleared.
public class	PreDestroyApplicationEvent This event must be published by the runtime before the factories associated with this `Application` are released.
public class	PreDestroyCustomScopeEvent This class is provided to allow custom scopes to publish a "pre construct" event in the same way that other scopes do to let the application become aware of the beginning of the scope.
public class	PreDestroyViewMapEvent This event must be published by a call to `jakarta.faces.application.Application#publishEvent` when the `clear` method is called on the map returned from `UIViewRoot#getViewMap`.
public class	PreRemoveFlashValueEvent This event must be published by a call to `jakarta.faces.application.Application#publishEvent` when a value is removed from the flash.
public class	PreRemoveFromViewEvent When an instance of this event is passed to `SystemEventListener#processEvent` or `ComponentSystemEventListener#processEvent`, the listener implementation may assume that the `source` of this event instance is a `UIComponent` instance that is about to be removed from the view.
public class	PreRenderComponentEvent When an instance of this event is passed to `SystemEventListener#processEvent` or `ComponentSystemEventListener#processEvent`, the listener implementation may assume that the `source` of this event instance is the `UIComponent` instance that is about to be rendered and that it is safe to call `UIComponent#getParent`, `UIComponent#getClientId`, and other methods that depend upon the component instance being in the view.
public class	PreRenderViewEvent When an instance of this event is passed to `SystemEventListener#processEvent` or `ComponentSystemEventListener#processEvent`, the listener implementation may assume that the `source` of this event instance is the `UIViewRoot` instance that is about to be rendered.
public class	PreValidateEvent When an instance of this event is passed to `SystemEventListener#processEvent` or `ComponentSystemEventListener#processEvent`, the listener implementation may assume that the `source` of this event instance is the `UIComponent` instance that is about to be validated.
public class	ScopeContext A structure that contains the name of the scope and the scope itself exposed as a `Map<String, Object>`.
public abstract class	SystemEvent SystemEvent is the base class for non-application specific events that can be fired by arbitrary objects.
public class	ValueChangeEvent A `ValueChangeEvent` is a notification that the local value of the source component has been change as a result of user interface activity.
public class	WebsocketEvent This web socket event will be fired when a new `<f:websocket>` has been `@Opened` or `@Closed`.

Package jakarta.faces.event

Interface Summary

Annotation Summary

Class Summary