Package jakarta.faces.event
package jakarta.faces.event
-
ClassDescriptionAn exception that may be thrown by event listeners to terminate the processing of the current event.An
ActionEventrepresents the activation of a user interface component (such as aUICommand).A listener interface for receivingActionEvents.Provides a simple implementation ofActionListenerthat can be subclassed by developers wishing to provide specialized behavior to an existingActionListenerinstance.AjaxBehaviorEvent represents the component behavior specific toAjax).By implementing this class, an object indicates that it is a listener for one or more kinds ofBehaviorEvents.BehaviorEvent is the event that can be generated from componentBehavior.A generic base interface for event listeners for various types ofBehaviorEvents.ComponentSystemEvent is the base class forSystemEvents that are specific to aUIComponentinstance.Implementors of this class do not need anisListenerForSource()method because they are only installed on specific component instances, therefore theisListenerForSource()method is implicit.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.classassystemEventClassargument.This helper class provides context to theExceptionQueuedEventregarding the state of the system at the point in time when theExceptionQueuedEventoccurs and links theExceptionQueuedEventto theExceptionHandlerby virtue of implementingSystemEventListener.FacesEvent is the base class for user interface and application events that can be fired byUIComponents.A generic base interface for event listeners for various types ofFacesEvents.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).Container annotation to specify multipleListenerForannotations on a single class.The presence of this annotation on a class automatically registers the class with the runtime as aComponentSystemEventfor use with the<f:event />tag in a page.PhaseEvent represents the beginning or ending of processing for a particular phase of the request processing lifecycle, for the request encapsulated by the specifiedFacesContext.Typesafe enumeration of the legal values that may be returned by thegetPhaseId()method of theFacesEventinterface.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.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 thesourceof this event instance is aUIComponentinstance and that either that instance or an ancestor of that instance was just added to the view.This event must be published by the runtime after all configuration resources have been parsed and processed.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.This event must be published by a call to {jakarta.faces.application.Application#publishEvent} when the view map is first created.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.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.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 thesourceof this event instance is theUIViewRootinstance that has just been rendered.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 thesourceof this event instance is in a tree that has just had its state restored.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 thesourceof this event instance is theUIComponentinstance that is that has just been validated.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.This event must be published by the runtime before the factories associated with thisApplicationare released.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.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 theclearmethod is called on the map returned fromUIViewRoot.getViewMap().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.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 thesourceof this event instance is aUIComponentinstance that is about to be removed from the view.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 thesourceof this event instance is theUIComponentinstance 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.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 thesourceof this event instance is theUIViewRootinstance that is about to be rendered.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 thesourceof this event instance is theUIComponentinstance that is about to be validated.A structure that contains the name of the scope and the scope itself exposed as aMap<String, Object>.SystemEvent is the base class for non-application specific events that can be fired by arbitrary objects.By implementing this class, an object indicates that it is a listener for one or more kinds ofSystemEvents.Classes that implement this interface agree to maintain a list ofSystemEventListenerinstances for each kind ofSystemEventthey can generate.AValueChangeEventis a notification that the local value of the source component has been change as a result of user interface activity.A listener interface for receivingValueChangeEvents.Marker interface forSystemEvents that indicate the view map has been created (PostConstructViewMapEvent, or destroyed (PreDestroyViewMapEvent).This web socket event will be fired when a new<f:websocket>has been@WebsocketEvent.Openedor@WebsocketEvent.Closed.Indicates that a<f:websocket>has closed.Indicates that a<f:websocket>has opened.