-
@Retention(value=RUNTIME) @Target(value=TYPE) @Inherited public @interface ListenerFor
Classes tagged with this annotation are installed as listeners using the method
Application.subscribeToEvent(java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Class<?>, javax.faces.event.SystemEventListener)orUIComponent.subscribeToEvent(java.lang.Class<? extends javax.faces.event.SystemEvent>, javax.faces.event.ComponentSystemEventListener)(depending on the circumstances, described below).The default implementation must support attaching this annotation to
UIComponentorRendererclasses. In both cases, the annotation processing described herein must commence during the implementation of any variant ofApplication.createComponent()and must complete before theUIComponentinstance is returned fromcreateComponent(). The annotation processing must proceed according to an algorithm semantically equivalent to the following.If this annotation is not present on the class in question, no action must be taken.
-
Determine the variant of
subscribeToEvent()to call and the parameters to pass to it.If "target" is a
UIComponentcallUIComponent.subscribeToEvent(Class, ComponentSystemEventListener), passing thesystemEventClass()of the annotation as the first argument and the instance of the class to which this annotation is attached (which must implementComponentSystemEventListener) as the second argument.If "target" is the
Applicationinstance, inspect the value of thesourceClass()annotation attribute value.If the value is
Void.class, callApplication.subscribeToEvent(Class, SystemEventListener), passing the value ofsystemEventClass()as the first argument and the instance of the class to which this annotation is attached (which must implementSystemEventListener) as the second argument.Otherwise, call
Application.subscribeToEvent(Class, Class, SystemEventListener), passing the value ofsystemEventClass()as the first argument, the value ofsourceClass()as the second argument, and the instance of the class to which this annotation is attached (which must implementSystemEventListener) as the third argument.
Determine the "target" on which to call
subscribeToEvent.If the class to which this annotation is attached implements
ComponentSystemEventListenerand is aUIComponentinstance, "target" is theUIComponentinstance.If the class to which this annotation is attached implements
ComponentSystemEventListenerand is aRendererinstance, "target" is theUIComponentinstance that is to be rendered by thisRendererinstance.If the class to which this annotation is attached implements
ComponentSystemEventListenerand is neither an instance ofRenderernorUIComponent, the action taken is unspecified. This case must not trigger any kind of error.If the class to which this annotation is attached implements
SystemEventListenerand does not implementComponentSystemEventListener, "target" is theApplicationinstance.Example: The standard renderer for
javax.faces.resource.Stylesheetmust have the following annotation declaration:@ListenerFor(systemEventClass=PostAddToViewEvent.class)This will cause the renderer to be added as a listener for the
PostAddToViewEventto all components that list it as their renderer.- Since:
- 2.0
-
-
Required Element Summary
Required Elements Modifier and Type Required Element and Description Class<? extends SystemEvent>systemEventClassThe kind of system event for which this class will be installed as a listener.
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element and Description ClasssourceClassThe kind of object that emits events of the type given by the value of the
systemEventClass()attribute.
-
-
-
Element Detail
-
systemEventClass
public abstract Class<? extends SystemEvent> systemEventClass
The kind of system event for which this class will be installed as a listener. The implementation only supports exact matches on the
Classand must not honor subclass relationships. It is valid to have EL Expressions in the value of this attribute, as long as the expression resolves to an instance of the expected type.
-
-
-
sourceClass
public abstract Class sourceClass
The kind of object that emits events of the type given by the value of the
systemEventClass()attribute. It is valid to have EL Expressions in the value of this attribute, as long as the expression resolves to an instance of the expected type.- Default:
- java.lang.Void.class
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/faces/event/listenerfor.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.