Package jakarta.faces.event
Class ActionEvent
java.lang.Object
java.util.EventObject
jakarta.faces.event.FacesEvent
jakarta.faces.event.ActionEvent
- All Implemented Interfaces:
Serializable
public class ActionEvent extends FacesEvent
An ActionEvent
represents the activation of a user interface component (such as a UICommand
).
- See Also:
- Serialized Form
-
Field Summary
-
Constructor Summary
Constructors Constructor Description ActionEvent(UIComponent component)
Construct a new event object from the specified source component and action command.ActionEvent(FacesContext facesContext, UIComponent component)
Construct a new event object from the Faces context, specified source component and action command. -
Method Summary
Modifier and Type Method Description boolean
isAppropriateListener(FacesListener listener)
Returntrue
if thisFacesListener
is an instance of a listener class that this event supports.void
processListener(FacesListener listener)
Broadcast thisFacesEvent
to the specifiedFacesListener
, by whatever mechanism is appropriate.Methods inherited from class jakarta.faces.event.FacesEvent
getComponent, getFacesContext, getPhaseId, queue, setPhaseId
-
Constructor Details
-
ActionEvent
Construct a new event object from the specified source component and action command.
- Parameters:
component
- SourceUIComponent
for this event- Throws:
IllegalArgumentException
- ifcomponent
isnull
-
ActionEvent
Construct a new event object from the Faces context, specified source component and action command.
- Parameters:
facesContext
- the Faces context.component
- SourceUIComponent
for this event.- Throws:
IllegalArgumentException
- ifcomponent
isnull
- Since:
- 2.3
-
-
Method Details
-
isAppropriateListener
Description copied from class:FacesEvent
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.- Specified by:
isAppropriateListener
in classFacesEvent
- Parameters:
listener
-FacesListener
to evaluate- Returns:
- true if it is the appropriate instance, false otherwise.
-
processListener
Description copied from class:FacesEvent
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.- Specified by:
processListener
in classFacesEvent
- Parameters:
listener
-FacesListener
to send thisFacesEvent
to- Throws:
AbortProcessingException
- Signal the Jakarta Server Faces implementation that no further processing on the current event should be performed
-