Module jakarta.faces

Package jakarta.faces.event

Class ComponentSystemEvent

java.lang.Object

java.util.EventObject

jakarta.faces.event.SystemEvent

jakarta.faces.event.ComponentSystemEvent

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PostAddToViewEvent, PostConstructViewMapEvent, PostRenderViewEvent, PostRestoreStateEvent, PostValidateEvent, PreDestroyViewMapEvent, PreRemoveFromViewEvent, PreRenderComponentEvent, PreRenderViewEvent, PreValidateEvent

public abstract class ComponentSystemEvent
extends SystemEvent

ComponentSystemEvent is the base class for SystemEvents that are specific to a UIComponent instance.

Since:

2.0

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
ComponentSystemEvent(UIComponent component)	Pass the argument component to the superclass constructor.
ComponentSystemEvent(FacesContext facesContext, UIComponent component)	Pass the argument component to the superclass constructor.

Method Summary

Modifier and Type	Method	Description
UIComponent	getComponent()	the source UIComponent that sent this event.
boolean	isAppropriateListener(FacesListener listener)	Return true if the argument FacesListener is an instance of the appropriate listener class that this event supports.
void	processListener(FacesListener listener)	Broadcast this event instance to the specified FacesListener by calling the superclass's processListener() implementation.

Methods inherited from class jakarta.faces.event.SystemEvent

getFacesContext

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentSystemEvent

public ComponentSystemEvent(UIComponent component)

Pass the argument component to the superclass constructor.

Parameters:

component - the UIComponent reference to be passed to the superclass constructor.

Throws:

IllegalArgumentException - if the argument is null.

Since:

2.0

ComponentSystemEvent

public ComponentSystemEvent(FacesContext facesContext,
 UIComponent component)

Pass the argument component to the superclass constructor.

Parameters:

facesContext - the Faces context.

component - the UIComponent reference to be passed to the superclass constructor.

Throws:

IllegalArgumentException - if the argument is null.

Since:

2.0

Method Details

isAppropriateListener

public boolean isAppropriateListener(FacesListener listener)

Return true if the argument FacesListener is an instance of the appropriate listener class that this event supports. The default implementation returns true if the listener is a ComponentSystemEventListener or if super.isAppropriateListener() returns true.

Overrides:

isAppropriateListener in class SystemEvent

Parameters:

listener - FacesListener to evaluate

Returns:

the result as specified above

Since:

2.2

processListener

public void processListener(FacesListener listener)

Broadcast this event instance to the specified FacesListener by calling the superclass's processListener() implementation.

Overrides:

processListener in class SystemEvent

Parameters:

listener - FacesListener to evaluate

Since:

2.2

getComponent

public UIComponent getComponent()

the source UIComponent that sent this event.

Returns:

the component for this event

Since:

2.0