Class BehaviorEvent

java.lang.Object

java.util.EventObject

jakarta.faces.event.FacesEvent

jakarta.faces.event.BehaviorEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AjaxBehaviorEvent

public abstract class BehaviorEvent
extends FacesEvent

BehaviorEvent is the event that can be generated from component Behavior.

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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
BehaviorEvent(UIComponent component, Behavior behavior)	Construct a new event object from the specified source component and behavior.
BehaviorEvent(FacesContext facesContext, UIComponent component, Behavior behavior)	Construct a new event object from the Faces context, specified source component and behavior.

Method Summary

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

Methods inherited from class FacesEvent

getComponent, getFacesContext, getPhaseId, isAppropriateListener, processListener, 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.
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.

Methods inherited from class EventObject

getSource, toString

Methods inherited from class Object

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

Constructor Details

BehaviorEvent

public BehaviorEvent(UIComponent component,
 Behavior behavior)

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

Parameters:

component - Source UIComponent for this event

behavior - Behavior that sent this event

Throws:

IllegalArgumentException - if component or behavior is null

Since:

2.0

BehaviorEvent

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

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

Parameters:

facesContext - the Faces context.

component - Source UIComponent for this event

behavior - Behavior that sent this event

Throws:

IllegalArgumentException - if component or behavior is null

Since:

2.3

Method Details

getBehavior

public Behavior getBehavior()

Return the source Behavior that sent this event.

Returns:

the Behavior

Since:

2.0