Class AjaxBehaviorEvent

java.lang.Object

java.util.EventObject

jakarta.faces.event.FacesEvent

jakarta.faces.event.BehaviorEvent

jakarta.faces.event.AjaxBehaviorEvent

All Implemented Interfaces:

Serializable

public class AjaxBehaviorEvent
extends BehaviorEvent

AjaxBehaviorEvent represents the component behavior specific to Ajax).

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class BehaviorEvent

BehaviorEvent.FacesComponentEvent

Modifier and Type	Class	Description
static enum	BehaviorEvent.FacesComponentEvent	Behavior events supported by Faces components.

Field Summary

Fields inherited from class EventObject

source

Constructor Summary

Constructors

Constructor	Description
AjaxBehaviorEvent(UIComponent component, Behavior behavior)	Construct a new event object from the specified source component and Ajax behavior.
AjaxBehaviorEvent(FacesContext facesContext, UIComponent component, Behavior behavior)	Construct a new event object from the Faces context, specified source component and Ajax behavior.

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from class BehaviorEvent

getBehavior

Modifier and Type	Method	Description
Behavior	getBehavior()	Return the source Behavior that sent this event.

Methods inherited from class FacesEvent

getComponent, getFacesContext, getPhaseId, queue, setPhaseId

Modifier and Type	Method	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.
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.

Methods inherited from class EventObject

getSource, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AjaxBehaviorEvent

public AjaxBehaviorEvent(UIComponent component,
 Behavior behavior)

Construct a new event object from the specified source component and Ajax behavior.

Parameters:

component - Source UIComponent for this event

behavior - Behavior for this event

Throws:

IllegalArgumentException - if component or ajaxBehavior is null

Since:

2.0

AjaxBehaviorEvent

public AjaxBehaviorEvent(FacesContext facesContext,
 UIComponent component,
 Behavior behavior)

Construct a new event object from the Faces context, specified source component and Ajax behavior.

Parameters:

facesContext - the FacesContext.

component - Source UIComponent for this event

behavior - Behavior for this event

Throws:

IllegalArgumentException - if component or ajaxBehavior is null

Since:

2.3

Method Details

isAppropriateListener

public boolean isAppropriateListener(FacesListener listener)

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

Specified by:

isAppropriateListener in class FacesEvent

Parameters:

listener - FacesListener to evaluate

Returns:

true if it is the appropriate instance, false otherwise.

Since:

2.0

processListener

public 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.

Specified by:

processListener in class FacesEvent

Parameters:

listener - FacesListener to invoke

Throws:

AbortProcessingException - Signal the Jakarta Faces implementation that no further processing on the current event should be performed

Since:

2.0