Top Description Fields Constructors Methods
jakarta.faces.event

public abstract Class ComponentSystemEvent

extends SystemEvent
Class Inheritance
Known Direct Subclasses
jakarta.faces.event.PostRenderViewEvent, jakarta.faces.event.PostAddToViewEvent, jakarta.faces.event.PreRemoveFromViewEvent, jakarta.faces.event.PreDestroyViewMapEvent, jakarta.faces.event.PreRenderComponentEvent, jakarta.faces.event.PreValidateEvent, jakarta.faces.event.PreRenderViewEvent, jakarta.faces.event.PostValidateEvent, jakarta.faces.event.PostRestoreStateEvent, jakarta.faces.event.PostConstructViewMapEvent
Imports
jakarta.faces.component.UIComponent, jakarta.faces.context.FacesContext

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

Since
2.0

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides jakarta.faces.event.SystemEvent.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
ComponentSystemEvent(UIComponent
the UIComponent reference to be passed to the superclass constructor.
component)

Pass the argument component to the superclass constructor.

public
ComponentSystemEvent(FacesContext
the Faces context.
facesContext, UIComponent
the UIComponent reference to be passed to the superclass constructor.
component)

Pass the argument component to the superclass constructor.

Method Summary

Modifier and TypeMethod and Description
public UIComponent

Returns:

the component for this event
getComponent()

the source UIComponent that sent this event.

public boolean
isAppropriateListener(FacesListener
FacesListener to evaluate
listener)

Overrides jakarta.faces.event.SystemEvent.isAppropriateListener.

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

public void
processListener(FacesListener
FacesListener to evaluate
listener)

Overrides jakarta.faces.event.SystemEvent.processListener.

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

Inherited from jakarta.faces.event.SystemEvent:
getFacesContext

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides jakarta.faces.event.SystemEvent.serialVersionUID.

Constructor Detail

ComponentSystemEventback to summary
public ComponentSystemEvent(UIComponent component)

Pass the argument component to the superclass constructor.

Parameters
component:UIComponent

the UIComponent reference to be passed to the superclass constructor.

Exceptions
IllegalArgumentException:
if the argument is null.
Since
2.0
ComponentSystemEventback to summary
public ComponentSystemEvent(FacesContext facesContext, UIComponent component)

Pass the argument component to the superclass constructor.

Parameters
facesContext:FacesContext

the Faces context.

component:UIComponent

the UIComponent reference to be passed to the superclass constructor.

Exceptions
IllegalArgumentException:
if the argument is null.
Since
2.0

Method Detail

getComponentback to summary
public UIComponent getComponent()

the source UIComponent that sent this event.

Returns:UIComponent

the component for this event

Since
2.0
isAppropriateListenerback to summary
public boolean isAppropriateListener(FacesListener listener)

Overrides jakarta.faces.event.SystemEvent.isAppropriateListener.

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.

Parameters
listener:FacesListener

FacesListener to evaluate

Returns:boolean

Doc from jakarta.faces.event.SystemEvent.isAppropriateListener.

the result as specified above

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

Overrides jakarta.faces.event.SystemEvent.processListener.

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

Parameters
listener:FacesListener

FacesListener to evaluate

Annotations
@Override
Since
2.2