Top Description Fields Constructors Methods
jakarta.faces.event

public Class ActionEvent

extends FacesEvent
Class Inheritance
Imports
jakarta.faces.component.UIComponent, jakarta.faces.context.FacesContext

An ActionEvent represents the activation of a user interface component (such as a UICommand).

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides jakarta.faces.event.FacesEvent.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
ActionEvent(UIComponent
Source UIComponent for this event
component)

Construct a new event object from the specified source component and action command.

public
ActionEvent(FacesContext
the Faces context.
facesContext, UIComponent
Source UIComponent for this event.
component)

Construct a new event object from the Faces context, specified source component and action command.

Method Summary

Modifier and TypeMethod and Description
public boolean
isAppropriateListener(FacesListener
FacesListener to evaluate
listener)

Implements abstract jakarta.faces.event.FacesEvent.isAppropriateListener.

Return true if this FacesListener is an instance of a listener class that this event supports.

public void
processListener(FacesListener
FacesListener to send this FacesEvent to
listener)

Implements abstract jakarta.faces.event.FacesEvent.processListener.

Broadcast this FacesEvent to the specified FacesListener, by whatever mechanism is appropriate.

Inherited from jakarta.faces.event.FacesEvent:
getComponentgetFacesContextgetPhaseIdqueuesetPhaseId

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.faces.event.FacesEvent.serialVersionUID.

Constructor Detail

ActionEventback to summary
public ActionEvent(UIComponent component)

Construct a new event object from the specified source component and action command.

Parameters
component:UIComponent

Source UIComponent for this event

Exceptions
IllegalArgumentException:
if component is null
ActionEventback to summary
public ActionEvent(FacesContext facesContext, UIComponent component)

Construct a new event object from the Faces context, specified source component and action command.

Parameters
facesContext:FacesContext

the Faces context.

component:UIComponent

Source UIComponent for this event.

Exceptions
IllegalArgumentException:
if component is null
Since
2.3

Method Detail

isAppropriateListenerback to summary
public boolean isAppropriateListener(FacesListener listener)

Implements abstract jakarta.faces.event.FacesEvent.isAppropriateListener.

Doc from jakarta.faces.event.FacesEvent.isAppropriateListener.

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.

Parameters
listener:FacesListener

FacesListener to evaluate

Returns:boolean

true if it is the appropriate instance, false otherwise.

Annotations
@Override
processListenerback to summary
public void processListener(FacesListener listener)

Implements abstract jakarta.faces.event.FacesEvent.processListener.

Doc from jakarta.faces.event.FacesEvent.processListener.

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.

Parameters
listener:FacesListener

FacesListener to send this FacesEvent to

Annotations
@Override
Exceptions
AbortProcessingException:
Signal the Jakarta Faces implementation that no further processing on the current event should be performed