public abstract class FacesEvent
extends java.util.EventObject
FacesEvent is the base class
for user interface and application events that can be fired by UIComponent
s.
Concrete event classes must subclass FacesEvent
in order to be supported
by the request processing lifecycle.
Constructor and Description |
---|
FacesEvent(FacesContext facesContext,
UIComponent component)
Construct a new event object from the Faces context and specified source component. |
FacesEvent(UIComponent component)
Construct a new event object from the specified source component. |
Modifier and Type | Method and Description |
---|---|
UIComponent |
getComponent()
Return the source
UIComponent that sent this event. |
FacesContext |
getFacesContext()
Get the Faces context. |
PhaseId |
getPhaseId()
Return the identifier of the request processing phase during
which this event should be delivered.
|
abstract boolean |
isAppropriateListener(FacesListener listener)
Return
true if this FacesListener is an instance
of a listener class that this event supports. |
abstract void |
processListener(FacesListener listener)
Broadcast this
FacesEvent to the specified
FacesListener , by whatever mechanism is appropriate. |
void |
queue()
Convenience method to queue this event for broadcast at the end
of the current request processing lifecycle phase.
|
void |
setPhaseId(PhaseId phaseId)
Set the
PhaseId during which this event will be
delivered. |
public FacesEvent(UIComponent component)
Construct a new event object from the specified source component.
component
- Source UIComponent
for this eventjava.lang.IllegalArgumentException
- if component
is null
public FacesEvent(FacesContext facesContext, UIComponent component)
Construct a new event object from the Faces context and specified source component.
facesContext
- the Faces context.component
- Source UIComponent
for this event.java.lang.IllegalArgumentException
- if component
is null
public UIComponent getComponent()
Return the source UIComponent
that sent this event.
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 PhaseId getPhaseId()
Return the identifier of the request processing phase during
which this event should be delivered. Legal values are the
singleton instances defined by the PhaseId
class,
including PhaseId.ANY_PHASE
, which is the default
value.
public void setPhaseId(PhaseId phaseId)
Set the PhaseId
during which this event will be
delivered.
phaseId
- the phase id.java.lang.IllegalArgumentException
- phaseId is null.public void queue()
Convenience method to queue this event for broadcast at the end of the current request processing lifecycle phase.
java.lang.IllegalStateException
- if the source component for this
event is not a descendant of a UIViewRoot
public abstract boolean isAppropriateListener(FacesListener listener)
Return true
if this FacesListener
is an instance
of a listener class that this event supports. Typically, this will be
accomplished by an "instanceof" check on the listener class.
listener
- FacesListener
to evaluatepublic abstract void processListener(FacesListener listener)
Broadcast this FacesEvent
to the specified
FacesListener
, by whatever mechanism is appropriate. Typically,
this will be accomplished by calling an event processing method, and
passing this FacesEvent
as a paramter.
listener
- FacesListener
to send this FacesEvent
toAbortProcessingException
- Signal the Jakarta Server Faces
implementation that no further processing on the current event
should be performed