Uses of Class
jakarta.faces.event.SystemEvent
Package
Description
-
Uses of SystemEvent in com.sun.faces.application
Modifier and TypeMethodDescriptionClass
<? extends SystemEvent> NamedEventManager.getNamedEvent
(String name) Modifier and TypeMethodDescriptionvoid
ValidateComponentNesting.processEvent
(SystemEvent event) Process PostAddToViewEvent on UIViewRoot to validate form - action/input nesting.Modifier and TypeMethodDescriptionvoid
NamedEventManager.addDuplicateName
(String name, Class<? extends SystemEvent> event) void
NamedEventManager.addNamedEvent
(String name, Class<? extends SystemEvent> event) void
ApplicationImpl.publishEvent
(FacesContext context, Class<? extends SystemEvent> systemEventClass, Class<?> sourceBaseType, Object source) void
ApplicationImpl.publishEvent
(FacesContext context, Class<? extends SystemEvent> systemEventClass, Object source) void
ApplicationImpl.subscribeToEvent
(Class<? extends SystemEvent> systemEventClass, SystemEventListener listener) void
ApplicationImpl.subscribeToEvent
(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener) void
ApplicationImpl.unsubscribeFromEvent
(Class<? extends SystemEvent> systemEventClass, SystemEventListener listener) void
ApplicationImpl.unsubscribeFromEvent
(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener) -
Uses of SystemEvent in com.sun.faces.application.annotation
Modifier and TypeMethodDescriptionvoid
AnnotationManager.applySystemEventAnnotations
(FacesContext ctx, SystemEvent e) -
Uses of SystemEvent in com.sun.faces.application.applicationimpl
Modifier and TypeMethodDescriptionvoid
Events.publishEvent
(FacesContext context, Class<? extends SystemEvent> systemEventClass, Class<?> sourceBaseType, Object source, ProjectStage projectStage) void
Events.subscribeToEvent
(Class<? extends SystemEvent> systemEventClass, SystemEventListener listener) void
Events.subscribeToEvent
(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener) void
Events.unsubscribeFromEvent
(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener) -
Uses of SystemEvent in com.sun.faces.application.applicationimpl.events
Modifier and TypeMethodDescriptionvoid
ReentrantLisneterInvocationGuard.clearGuard
(FacesContext ctx, Class<? extends SystemEvent> systemEventClass) ComponentSystemEventHelper.getEventInfo
(Class<? extends SystemEvent> systemEvent, Class<?> sourceClass) SystemEventHelper.getEventInfo
(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass) SystemEventHelper.getEventInfo
(Class<? extends SystemEvent> systemEventClass, Object source, Class<?> sourceBaseType, boolean useSourceForLookup) boolean
ReentrantLisneterInvocationGuard.isGuardSet
(FacesContext ctx, Class<? extends SystemEvent> systemEventClass) void
ReentrantLisneterInvocationGuard.setGuard
(FacesContext ctx, Class<? extends SystemEvent> systemEventClass) ModifierConstructorDescriptionEventInfo
(Class<? extends SystemEvent> systemEvent, Class<?> sourceClass) SystemEventInfo
(Class<? extends SystemEvent> systemEvent) -
Uses of SystemEvent in com.sun.faces.application.view
Modifier and TypeMethodDescriptionvoid
ViewScopeEventListener.processEvent
(SystemEvent se) Handle the system event.void
ViewScopeManager.processEvent
(SystemEvent systemEvent) Process the system event. -
Uses of SystemEvent in com.sun.faces.context
Modifier and TypeMethodDescriptionvoid
AjaxExceptionHandlerImpl.processEvent
(SystemEvent event) void
ExceptionHandlerImpl.processEvent
(SystemEvent event) -
Uses of SystemEvent in com.sun.faces.facelets.tag.composite
Modifier and TypeMethodDescriptionvoid
BehaviorHolderWrapper.subscribeToEvent
(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) void
BehaviorHolderWrapper.unsubscribeFromEvent
(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) -
Uses of SystemEvent in com.sun.faces.facelets.tag.faces.core
Modifier and TypeMethodDescriptionprotected Class
<? extends SystemEvent> EventHandler.getEventClass
(FaceletContext ctx) -
Uses of SystemEvent in com.sun.faces.push
Modifier and TypeMethodDescriptionvoid
WebsocketFacesListener.processEvent
(SystemEvent event) If the websocket has just switched itsrendered
orconnected
attribute, then render either theopen()
script or theclose()
script. -
Uses of SystemEvent in jakarta.faces.application
Modifier and TypeMethodDescriptionvoid
Application.publishEvent
(FacesContext context, Class<? extends SystemEvent> systemEventClass, Class<?> sourceBaseType, Object source) This method functions exactly likeApplication.publishEvent(FacesContext,Class,Object)
, except the run-time must use the argumentsourceBaseType
to find the matching listener instead of using theClass
of thesource
argument.void
Application.publishEvent
(FacesContext context, Class<? extends SystemEvent> systemEventClass, Object source) IfFacesContext.isProcessingEvents()
istrue
and there are one or more listeners for events of the type represented bysystemEventClass
, call those listeners, passingsource
as the source of the event.void
ApplicationWrapper.publishEvent
(FacesContext context, Class<? extends SystemEvent> systemEventClass, Class<?> sourceBaseType, Object source) The default behavior of this method is to callApplication.publishEvent(jakarta.faces.context.FacesContext, Class, Class, Object)
on the wrappedApplication
object.void
ApplicationWrapper.publishEvent
(FacesContext context, Class<? extends SystemEvent> systemEventClass, Object source) The default behavior of this method is to callApplication.publishEvent(jakarta.faces.context.FacesContext, Class, Object)
on the wrappedApplication
object.void
Application.subscribeToEvent
(Class<? extends SystemEvent> systemEventClass, SystemEventListener listener) Install the listener instance referenced by argumentlistener
into application as a listener for events of typesystemEventClass
.void
Application.subscribeToEvent
(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener) Install the listener instance referenced by argumentlistener
into the application as a listener for events of typesystemEventClass
that originate from objects of typesourceClass
.void
ApplicationWrapper.subscribeToEvent
(Class<? extends SystemEvent> systemEventClass, SystemEventListener listener) The default behavior of this method is to callApplication.subscribeToEvent(Class, jakarta.faces.event.SystemEventListener)
on the wrappedApplication
object.void
ApplicationWrapper.subscribeToEvent
(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener) The default behavior of this method is to callApplication.subscribeToEvent(Class, Class, jakarta.faces.event.SystemEventListener)
on the wrappedApplication
object.void
Application.unsubscribeFromEvent
(Class<? extends SystemEvent> systemEventClass, SystemEventListener listener) Remove the listener instance referenced by argumentlistener
from the application as a listener for events of typesystemEventClass
.void
Application.unsubscribeFromEvent
(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener) Remove the listener instance referenced by argumentlistener
from the application as a listener for events of typesystemEventClass
that originate from objects of typesourceClass
.void
ApplicationWrapper.unsubscribeFromEvent
(Class<? extends SystemEvent> systemEventClass, SystemEventListener listener) The default behavior of this method is to callApplication.unsubscribeFromEvent(Class, jakarta.faces.event.SystemEventListener)
on the wrappedApplication
object.void
ApplicationWrapper.unsubscribeFromEvent
(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener) The default behavior of this method is to callApplication.unsubscribeFromEvent(Class, Class, jakarta.faces.event.SystemEventListener)
on the wrappedApplication
object. -
Uses of SystemEvent in jakarta.faces.component
Modifier and TypeMethodDescriptionUIComponent.getListenersForEventClass
(Class<? extends SystemEvent> eventClass) This implementation throwsUnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.UIComponentBase.getListenersForEventClass
(Class<? extends SystemEvent> eventClass) Return theSystemEventListener
instances registered on thisUIComponent
instance that are interested in events of typeeventClass
.UIViewRoot.getViewListenersForEventClass
(Class<? extends SystemEvent> systemEvent) Return theSystemEventListener
instances registered on thisUIComponent
instance that are interested in events of typeeventClass
.void
UIComponent.subscribeToEvent
(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) This implementation throwsUnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.void
UIComponentBase.subscribeToEvent
(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) Install the listener instance referenced by argumentcomponentListener
as a listener for events of typeeventClass
originating from this specific instance ofUIComponent
.void
UIViewRoot.subscribeToViewEvent
(Class<? extends SystemEvent> systemEvent, SystemEventListener listener) Install the listener instance referenced by argumentlistener
into theUIViewRoot
as a listener for events of typesystemEventClass
.void
UIComponent.unsubscribeFromEvent
(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) This implementation throwsUnsupportedOperationException
and is provided for the sole purpose of not breaking existing applications that extend this class.void
UIComponentBase.unsubscribeFromEvent
(Class<? extends SystemEvent> eventClass, ComponentSystemEventListener componentListener) Remove the listener instance referenced by argumentcomponentListener
as a listener for events of typeeventClass
originating from this specific instance ofUIComponent
.void
UIViewRoot.unsubscribeFromViewEvent
(Class<? extends SystemEvent> systemEvent, SystemEventListener listener) Remove the listener instance referenced by argumentlistener
from theUIViewRoot
as a listener for events of typesystemEventClass
. -
Uses of SystemEvent in jakarta.faces.context
Modifier and TypeMethodDescriptionabstract void
ExceptionHandler.processEvent
(SystemEvent exceptionQueuedEvent) When called, the listener can assume that any guarantees given in the javadoc for the specificSystemEvent
subclass are true.void
ExceptionHandlerWrapper.processEvent
(SystemEvent event) The default behavior of this method is to callExceptionHandler.processEvent(jakarta.faces.event.SystemEvent)
on the wrappedExceptionHandler
object. -
Uses of SystemEvent in jakarta.faces.event
Modifier and TypeClassDescriptionclass
ComponentSystemEvent is the base class forSystemEvent
s that are specific to aUIComponent
instance.class
The system event facility will create an instance of this class wheneverApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
is called withExceptionQueuedEvent.class
assystemEventClass
argument.class
When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is aUIComponent
instance and that either that instance or an ancestor of that instance was just added to the view.class
This event must be published by the runtime after all configuration resources have been parsed and processed.class
Deprecated, for removal: This API element is subject to removal in a future version.class
This event must be published by a call to {jakarta.faces.application.Application#publishEvent} when the view map is first created.class
This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is kept in the flash.class
This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is stored in the flash.class
When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIViewRoot
instance that has just been rendered.class
When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is in a tree that has just had its state restored.class
When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIComponent
instance that is that has just been validated.class
This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
before the flash is cleared.class
This event must be published by the runtime before the factories associated with thisApplication
are released.class
Deprecated, for removal: This API element is subject to removal in a future version.becauseCustomScope
has been removed from Faces in favor of CDI.class
This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when theclear
method is called on the map returned fromUIViewRoot.getViewMap()
.class
This event must be published by a call toApplication.publishEvent(jakarta.faces.context.FacesContext, java.lang.Class<? extends jakarta.faces.event.SystemEvent>, java.lang.Object)
when a value is removed from the flash.class
When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is aUIComponent
instance that is about to be removed from the view.class
When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIComponent
instance that is about to be rendered and that it is safe to callUIComponent.getParent()
,UIComponent.getClientId()
, and other methods that depend upon the component instance being in the view.class
When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIViewRoot
instance that is about to be rendered.class
When an instance of this event is passed toSystemEventListener.processEvent(jakarta.faces.event.SystemEvent)
orComponentSystemEventListener.processEvent(jakarta.faces.event.ComponentSystemEvent)
, the listener implementation may assume that thesource
of this event instance is theUIComponent
instance that is about to be validated.Modifier and TypeMethodDescriptionvoid
SystemEventListener.processEvent
(SystemEvent event) When called, the listener can assume that any guarantees given in the javadoc for the specificSystemEvent
subclass are true.Modifier and TypeMethodDescriptionExceptionQueuedEventContext.getListenersForEventClass
(Class<? extends SystemEvent> facesEventClass) Return aList
that contains a single entry, theExceptionHandler
for the current request.SystemEventListenerHolder.getListenersForEventClass
(Class<? extends SystemEvent> facesEventClass)
CustomScope
has been removed from Faces in favor of CDI.