Package javax.faces.event
package javax.faces.event
Interfaces describing
events and event listeners, and concrete event implementation classes.
All events extend from FacesEvent
and all
listeners extend from FacesListener
.
For your convenience here is a UML class diagram of the classes in this package.
-
ClassDescriptionAn exception that may be thrown by event listeners to terminate the processing of the current event.An
ActionEvent
represents the activation of a user interface component (such as aUICommand
).A listener interface for receivingActionEvent
s.Provides a simple implementation ofActionListener
that can be subclassed by developers wishing to provide specialized behavior to an existingActionListener
instance.AjaxBehaviorEvent represents the component behavior specific toAjax
).By implementing this class, an object indicates that it is a listener for one or more kinds ofBehaviorEvent
s.BehaviorEvent is the event that can be generated from componentBehavior
.A generic base interface for event listeners for various types ofBehaviorEvent
s.ComponentSystemEvent is the base class forSystemEvent
s that are specific to aUIComponent
instance.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(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)
is called withExceptionQueuedEvent.class
assystemEventClass
argument.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 is the base class for user interface and application events that can be fired byUIComponent
s.A generic base interface for event listeners for various types ofFacesEvent
s.Classes tagged with this annotation are installed as listeners using the methodApplication.subscribeToEvent(java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Class<?>, javax.faces.event.SystemEventListener)
orUIComponent.subscribeToEvent(java.lang.Class<? extends javax.faces.event.SystemEvent>, javax.faces.event.ComponentSystemEventListener)
(depending on the circumstances, described below).Container annotation to specify multipleListenerFor
annotations on a single class.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.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 theFacesEvent
interface.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(javax.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(javax.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.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 {javax.faces.application.Application#publishEvent} when the view map is first created.This event must be published by a call toApplication.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)
when a value is kept in the flash.This event must be published by a call toApplication.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)
when a value is stored in the flash.When an instance of this event is passed toSystemEventListener.processEvent(javax.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(javax.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.When an instance of this event is passed toSystemEventListener.processEvent(javax.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIComponent
instance that is that has just been validated.This event must be published by a call toApplication.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)
before the flash is cleared.This event must be published by the runtime before the factories associated with thisApplication
are 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(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)
when theclear
method is called on the map returned fromUIViewRoot.getViewMap()
.This event must be published by a call toApplication.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object)
when a value is removed from the flash.When an instance of this event is passed toSystemEventListener.processEvent(javax.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(javax.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.When an instance of this event is passed toSystemEventListener.processEvent(javax.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(javax.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.When an instance of this event is passed toSystemEventListener.processEvent(javax.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIViewRoot
instance that is about to be rendered.When an instance of this event is passed toSystemEventListener.processEvent(javax.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(javax.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIComponent
instance 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 ofSystemEvent
s.Classes that implement this interface agree to maintain a list ofSystemEventListener
instances for each kind ofSystemEvent
they can generate.AValueChangeEvent
is a notification that the local value of the source component has been change as a result of user interface activity.A listener interface for receivingValueChangeEvent
s.Marker interface forSystemEvent
s that indicate the view map has been created (PostConstructViewMapEvent
, or destroyed (PreDestroyViewMapEvent
).