Package jakarta.faces.event
-
Interface Summary Interface Description ActionListener A listener interface for receivingActionEvent
s.AjaxBehaviorListener By implementing this class, an object indicates that it is a listener for one or more kinds ofBehaviorEvent
s.BehaviorListener A generic base interface for event listeners for various types ofBehaviorEvent
s.ComponentSystemEventListener Implementors of this class do not need anisListenerForSource()
method because they are only installed on specific component instances, therefore theisListenerForSource()
method is implicit.FacesListener A generic base interface for event listeners for various types ofFacesEvent
s.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.SystemEventListener By implementing this class, an object indicates that it is a listener for one or more kinds ofSystemEvent
s.SystemEventListenerHolder Classes that implement this interface agree to maintain a list ofSystemEventListener
instances for each kind ofSystemEvent
they can generate.ValueChangeListener A listener interface for receivingValueChangeEvent
s.ViewMapListener Marker interface forSystemEvent
s that indicate the view map has been created (PostConstructViewMapEvent
, or destroyed (PreDestroyViewMapEvent
). -
Class Summary Class Description ActionEvent AnActionEvent
represents the activation of a user interface component (such as aUICommand
).ActionListenerWrapper Provides a simple implementation ofActionListener
that can be subclassed by developers wishing to provide specialized behavior to an existingActionListener
instance.AjaxBehaviorEvent AjaxBehaviorEvent represents the component behavior specific toAjax
).BehaviorEvent BehaviorEvent is the event that can be generated from componentBehavior
.ComponentSystemEvent ComponentSystemEvent is the base class forSystemEvent
s that are specific to aUIComponent
instance.ExceptionQueuedEvent The system event facility will create an instance of this class wheneverApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
is called withExceptionQueuedEvent.class
assystemEventClass
argument.ExceptionQueuedEventContext This helper class provides context to theExceptionQueuedEvent
regarding the state of the system at the point in time when theExceptionQueuedEvent
occurs and links theExceptionQueuedEvent
to theExceptionHandler
by virtue of implementingSystemEventListener
.FacesEvent FacesEvent is the base class for user interface and application events that can be fired byUIComponent
s.MethodExpressionActionListener MethodExpressionValueChangeListener PhaseEvent PhaseEvent represents the beginning or ending of processing for a particular phase of the request processing lifecycle, for the request encapsulated by the specifiedFacesContext
.PhaseId Typesafe enumeration of the legal values that may be returned by thegetPhaseId()
method of theFacesEvent
interface.PostAddToViewEvent When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is aUIComponent
instance and that either that instance or an ancestor of that instance was just added to the view.PostConstructApplicationEvent This event must be published by the runtime after all configuration resources have been parsed and processed.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.PostConstructViewMapEvent This event must be published by a call to {jakarta.faces.application.Application#publishEvent} when the view map is first created.PostKeepFlashValueEvent This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is kept in the flash.PostPutFlashValueEvent This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is stored in the flash.PostRenderViewEvent When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIViewRoot
instance that has just been rendered.PostRestoreStateEvent When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is in a tree that has just had its state restored.PostValidateEvent When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIComponent
instance that is that has just been validated.PreClearFlashEvent This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
before the flash is cleared.PreDestroyApplicationEvent This event must be published by the runtime before the factories associated with thisApplication
are released.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.PreDestroyViewMapEvent This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when theclear
method is called on the map returned fromUIViewRoot.getViewMap()
.PreRemoveFlashValueEvent This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is removed from the flash.PreRemoveFromViewEvent When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is aUIComponent
instance that is about to be removed from the view.PreRenderComponentEvent When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIComponent
instance that is about to be rendered and that it is safe to callUIComponent.getParent()
,UIComponent.getClientId()
, and other methods that depend upon the component instance being in the view.PreRenderViewEvent When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIViewRoot
instance that is about to be rendered.PreValidateEvent When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIComponent
instance that is about to be validated.ScopeContext A structure that contains the name of the scope and the scope itself exposed as aMap<String, Object>
.SystemEvent SystemEvent is the base class for non-application specific events that can be fired by arbitrary objects.ValueChangeEvent AValueChangeEvent
is a notification that the local value of the source component has been change as a result of user interface activity.WebsocketEvent This web socket event will be fired when a new<f:websocket>
has been@
WebsocketEvent.Opened
or@
WebsocketEvent.Closed
. -
Exception Summary Exception Description AbortProcessingException An exception that may be thrown by event listeners to terminate the processing of the current event. -
Annotation Types Summary Annotation Type Description ListenerFor Classes tagged with this annotation are installed as listeners using the methodApplication.subscribeToEvent(java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Class<?>, jakarta.faces.event.SystemEventListener)
orUIComponent.subscribeToEvent(java.lang.Class<? extends jakarta.faces.event.SystemEvent>, jakarta.faces.event.ComponentSystemEventListener)
(depending on the circumstances, described below).ListenersFor Container annotation to specify multipleListenerFor
annotations on a single class.NamedEvent The presence of this annotation on a class automatically registers the class with the runtime as aComponentSystemEvent
for use with the<f:event />
tag in a page.WebsocketEvent.Closed Indicates that a<f:websocket>
has closed.WebsocketEvent.Opened Indicates that a<f:websocket>
has opened.