EE4J 10.0.0 · jakarta.faces.event.SystemEvent

Modifier and Type	Field and Description
private transient FacesContext	facesContext Stores the Faces context.
private static final long	serialVersionUID Hides java.util.EventObject.serialVersionUID.

Constructor Summary

Access	Constructor and Description
public	SystemEvent(Object the `source` reference to be passed to the superclass constructor. source) Pass the argument `source` to the superclass constructor.
public	SystemEvent(FacesContext the Faces context. facesContext, Object the `source` reference to be passed to the superclass constructor. source) Pass the argument `source` to the superclass constructor.

Method Summary

Modifier and Type	Method and Description
public FacesContext	Returns: the Faces context. getFacesContext() Get the Faces context.
public boolean	Returns: the result as specified above isAppropriateListener(FacesListener `FacesListener` to evaluate listener) Return `true` if this `FacesListener` is an instance of a the appropriate listener class that this event supports.
public void	processListener(FacesListener `FacesListener` to send this `FacesEvent` to listener) Broadcast this event instance to the specified `FacesListener`, by whatever mechanism is appropriate.

Inherited from java.util.EventObject:: getSource toString

Field Detail

facesContext	back to summary
private transient FacesContext facesContext Stores the Faces context.

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.EventObject.serialVersionUID.

Constructor Detail

SystemEvent back to summary

SystemEvent	back to summary
public SystemEvent(Object source) Pass the argument `source` to the superclass constructor. Parameters source:Object the `source` reference to be passed to the superclass constructor. Exceptions IllegalArgumentException: if the argument is `null`.

public SystemEvent(Object source)

Pass the argument source to the superclass constructor.

Parameters

source:Object: the source reference to be passed to the superclass constructor.

Exceptions

IllegalArgumentException:: if the argument is null.

SystemEvent back to summary

SystemEvent	back to summary
public SystemEvent(FacesContext facesContext, Object source) Pass the argument `source` to the superclass constructor. Parameters facesContext:FacesContext the Faces context. source:Object the `source` reference to be passed to the superclass constructor. Exceptions IllegalArgumentException: if the argument is `null`.

public SystemEvent(FacesContext facesContext, Object source)

Pass the argument source to the superclass constructor.

Parameters

facesContext:FacesContext: the Faces context.
source:Object: the source reference to be passed to the superclass constructor.

Exceptions

IllegalArgumentException:: if the argument is null.

Method Detail

getFacesContext	back to summary
public FacesContext getFacesContext() Get the Faces context. If the constructor was passed a FacesContext we return it, otherwise we call FacesContext.getCurrentInstance() and return it. Returns:FacesContext the Faces context. Since 2.3

getFacesContext

back to summary

public FacesContext getFacesContext()

Get the Faces context.

If the constructor was passed a FacesContext we return it, otherwise we call FacesContext.getCurrentInstance() and return it.

Returns:FacesContext: the Faces context.
Since: 2.3

isAppropriateListener back to summary

isAppropriateListener	back to summary
public boolean isAppropriateListener(FacesListener listener) Return `true` if this `FacesListener` is an instance of a the appropriate listener class that this event supports. The default implementation returns true if the listener is a `ComponentSystemEventListener`. Parameters listener:FacesListener `FacesListener` to evaluate Returns:boolean the result as specified above

public boolean isAppropriateListener(FacesListener listener)

Return true if this FacesListener is an instance of a the appropriate listener class that this event supports. The default implementation returns true if the listener is a ComponentSystemEventListener.

Parameters

listener:FacesListener: FacesListener to evaluate

Returns:boolean

the result as specified above

processListener back to summary

processListener	back to summary
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. Parameters listener:FacesListener `FacesListener` to send this `FacesEvent` to Exceptions AbortProcessingException: Signal the Jakarta Faces implementation that no further processing on the current event should be performed

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.

Parameters

listener:FacesListener: FacesListener to send this FacesEvent to

Exceptions

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

public abstract Class SystemEvent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail