Package jakarta.faces.event

Interface SystemEventListenerHolder

All Known Implementing Classes:
BehaviorHolderWrapper, ComponentRef, ComponentResourceContainer, CompositeComponentImpl, ExceptionQueuedEventContext, HtmlBody, HtmlColumn, HtmlCommandButton, HtmlCommandLink, HtmlCommandScript, HtmlDataTable, HtmlDoctype, HtmlForm, HtmlGraphicImage, HtmlHead, HtmlInputFile, HtmlInputHidden, HtmlInputSecret, HtmlInputText, HtmlInputTextarea, HtmlMessage, HtmlMessages, HtmlOutcomeTargetButton, HtmlOutcomeTargetLink, HtmlOutputFormat, HtmlOutputLabel, HtmlOutputLink, HtmlOutputText, HtmlPanelGrid, HtmlPanelGroup, HtmlSelectBooleanCheckbox, HtmlSelectManyCheckbox, HtmlSelectManyListbox, HtmlSelectManyMenu, HtmlSelectOneListbox, HtmlSelectOneMenu, HtmlSelectOneRadio, PassthroughElement, RadioRenderer.GroupSelectItem, UIColumn, UICommand, UIComponent, UIComponentBase, UIData, UIDebug, UIForm, UIGraphic, UIImportConstants, UIInput, UIInstructions, UILeaf, UILiteralText, UIMessage, UIMessages, UINamingContainer, UIOutcomeTarget, UIOutput, UIPanel, UIParameter, UIRepeat, UISelectBoolean, UISelectItem, UISelectItemGroup, UISelectItemGroups, UISelectItems, UISelectMany, UISelectOne, UIText, UIValidateWholeBean, UIViewAction, UIViewParameter, UIViewRoot, UIWebsocket
public interface SystemEventListenerHolder

Classes that implement this interface agree to maintain a list of SystemEventListener instances for each kind of SystemEvent they can generate. This interface enables arbitrary Objects to act as the source for SystemEvent instances.

If the implementing class is a UIComponent or is referenced by a UIComponent, care must be taken to ensure that the implementing class, and all the members of the list returned by getListenersForEventClass(java.lang.Class<? extends jakarta.faces.event.SystemEvent>) work correctly with the state management system. One way to ensure this is to have the class and the list members implement StateHolder or Serializable.

Since:
2.0

  • Method Details

    • getListenersForEventClass

      List<SystemEventListener> getListenersForEventClass(Class<? extends SystemEvent> facesEventClass)

      Return a List of SystemEventListener instances that have been installed into the class implementing this interface.

      Parameters:
      facesEventClass - the class for which listeners are to be returned
      Returns:
      the listeners for the argument class