Class FacesEvent
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
ActionEvent
,BehaviorEvent
,ValueChangeEvent
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.
- See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
ConstructorDescriptionFacesEvent
(UIComponent component) Construct a new event object from the specified source component. -
Method Summary
Modifier and TypeMethodDescriptionReturn the sourceUIComponent
that sent this event.Return the identifier of the request processing phase during which this event should be delivered.abstract boolean
isAppropriateListener
(FacesListener listener) Returntrue
if thisFacesListener
is an instance of a listener class that this event supports.abstract void
processListener
(FacesListener listener) Broadcast thisFacesEvent
to the specifiedFacesListener
, 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 thePhaseId
during which this event will be delivered.Methods inherited from class java.util.EventObject
getSource, toString
-
Constructor Details
-
FacesEvent
Construct a new event object from the specified source component.
- Parameters:
component
- SourceUIComponent
for this event- Throws:
IllegalArgumentException
- ifcomponent
isnull
-
-
Method Details
-
getComponent
Return the source
UIComponent
that sent this event. -
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, includingPhaseId.ANY_PHASE
, which is the default value. -
setPhaseId
Set the
PhaseId
during which this event will be delivered.- Throws:
IllegalArgumentException
- phaseId is null.
-
queue
public void queue()Convenience method to queue this event for broadcast at the end of the current request processing lifecycle phase.
- Throws:
IllegalStateException
- if the source component for this event is not a descendant of aUIViewRoot
-
isAppropriateListener
Return
true
if thisFacesListener
is an instance of a listener class that this event supports. Typically, this will be accomplished by an "instanceof" check on the listener class.- Parameters:
listener
-FacesListener
to evaluate
-
processListener
Broadcast this
FacesEvent
to the specifiedFacesListener
, by whatever mechanism is appropriate. Typically, this will be accomplished by calling an event processing method, and passing thisFacesEvent
as a paramter.- Parameters:
listener
-FacesListener
to send thisFacesEvent
to- Throws:
AbortProcessingException
- Signal the JavaServer Faces implementation that no further processing on the current event should be performed
-