public abstract class SystemEvent
extends java.util.EventObject
SystemEvent is the base class for non-application specific events that can be fired by arbitrary objects.
Constructor and Description |
---|
SystemEvent(FacesContext facesContext,
java.lang.Object source)
Pass the argument |
SystemEvent(java.lang.Object source)
Pass the argument |
Modifier and Type | Method and Description |
---|---|
FacesContext |
getFacesContext()
Get the Faces context. |
boolean |
isAppropriateListener(FacesListener listener)
Return
true if this FacesListener is an instance of a
the appropriate listener class that this event supports. |
void |
processListener(FacesListener listener)
Broadcast this event instance to the specified
FacesListener , by whatever mechanism is appropriate. |
public SystemEvent(java.lang.Object source)
Pass the argument source
to the superclass constructor.
source
- the source
reference to be passed to the superclass constructor.java.lang.IllegalArgumentException
- if the argument is null
.public SystemEvent(FacesContext facesContext, java.lang.Object source)
Pass the argument source
to the superclass constructor.
facesContext
- the Faces context.source
- the source
reference to be passed to the superclass constructor.java.lang.IllegalArgumentException
- if the argument is null
.public FacesContext getFacesContext()
Get the Faces context.
If the constructor was passed a FacesContext we return it, otherwise we call FacesContext.getCurrentInstance() and return it.
public boolean isAppropriateListener(FacesListener listener)
Return true
if this FacesListener
is an instance of a
the appropriate listener class that this event supports. The default implementation
returns true if the listener is a ComponentSystemEventListener
.
listener
- FacesListener
to evaluatepublic void processListener(FacesListener listener)
Broadcast this event instance to the specified FacesListener
, by whatever mechanism is appropriate.
Typically, this will be accomplished by calling an event processing method, and passing this instance as a parameter.
listener
- FacesListener
to send this FacesEvent
toAbortProcessingException
- Signal the Jakarta Faces implementation that no further processing on the
current event should be performed