Cette classe de base définit la on, onceet off
méthodes des objets capables de déclencher des événements.
Méthodes
| Nom | Description |
|---|---|
addEventListener(type, listener, context) |
Obsolète. |
off(type, handler, context) → {Object} |
Supprime un ou plusieurs gestionnaires d'événements. |
on(type, handler, context) → {EventDispatcher} |
Ajoute une fonction de gestion d'événements pour un ou plusieurs événements. |
once(type, handler, context) → {Object} |
Ajoute une fonction de gestion d'événements pour un ou plusieurs événements. |
removeEventListener(type, listener, context) |
Obsolète. |
addEventListener(type, listener, context)
Paramètres :
| Nom | Type | Description |
|---|---|---|
type |
Chaîne | La chaîne de caractères identifiant le type d'événement. |
listener |
fonction | La fonction à appeler lorsque l'objet déclenche l'événement. |
context |
Objet | (Facultatif) Définit la valeur de this dans la fonction de gestion des événements. |
Déclassé — utilisation on() ou une fois() au lieu de cela.
Cette méthode permet d'enregistrer une méthode en tant qu'écouteur d'événement pour un événement spécifique.
Si aucun gestionnaire n'est enregistré pour un événement, celui-ci est ignoré localement. Si la fonction d'écoute d'événement n'existe pas, l'événement est ignoré localement.
Lance une exception si le listener Le nom n'est pas valide.
Voir : : - on() - une fois() - Evénements
off(type, gestionnaire, contexte) → {Object}
Supprime un ou plusieurs gestionnaires d'événements.
Si vous transmettez un nom d'événement et une méthode de gestion, cette dernière est supprimée pour cet événement :
obj.off("eventName", eventHandler);
Si vous transmettez plusieurs noms d'événements et une méthode de gestion, celle-ci est supprimée pour ces événements :
obj.off("eventName1 eventName2", eventHandler);
Si vous transmettez un ou plusieurs noms d'événements et non méthode de gestionnaire, tous les gestionnaires sont supprimés pour ces événements :
obj.off("event1Name event2Name");
Si vous ne passez aucun argument, tous les gestionnaires d'événements sont supprimés pour tous les événements déclenchés par l'objet :
obj.off();
Cette méthode prend également en charge une syntaxe alternative, dans laquelle le premier paramètre est un objet qui constitue une table de correspondance entre les noms d'événements et les fonctions de gestion, et le deuxième paramètre (facultatif) est le contexte utilisé pour chaque gestionnaire :
obj.off(
{
eventName1: event1Handler,
eventName2: event2Handler
});
Paramètres :
| Nom | Type | Description |
|---|---|---|
type |
Chaîne | (Facultatif) La chaîne de caractères identifiant le type d'événement. Vous pouvez utiliser un espace pour spécifier plusieurs événements, comme dans « accessAllowed accessDenied accessDialogClosed ». Si vous n'indiquez aucun type valeur (ou d'autres arguments), tous les gestionnaires d'événements sont supprimés pour l'objet. |
handler |
fonction | (Facultatif) La fonction de gestion d'événement à supprimer. La fonction de gestion doit correspondre à l'objet fonction qui a été transmis à on(). Faites attention aux fonctions auxiliaires telles que bind() qui renvoient une nouvelle fonction lorsqu’elles sont appelées. Si vous ne transmettez aucun handler, tous les gestionnaires d'événements sont supprimés pour l'événement spécifié type. |
context |
Objet | (Facultatif) Si vous spécifiez un context, le gestionnaire d'événements est supprimé pour tous les événements spécifiés et tous les gestionnaires qui utilisent le contexte spécifié. (Le contexte doit correspondre au contexte transmis à on().) |
Voir : : - on() - une fois() - Evénements
Retours :
L'objet qui a déclenché l'événement.
on(type, handler, context) → {EventDispatcher}
Ajoute une fonction de gestion d'événements pour un ou plusieurs événements.
Le code suivant ajoute un gestionnaire d'événement pour un événement :
obj.on("eventName", function (event) {
// This is the event handler.
});
Si vous transmettez plusieurs noms d'événements et une méthode de gestion, celle-ci est enregistrée pour chacun de ces événements :
obj.on("eventName1 eventName2",
function (event) {
// This is the event handler.
});
Vous pouvez également passer un troisième context paramètre (facultatif) permettant de
définir la valeur de this dans la méthode de gestionnaire :
obj.on("eventName",
function (event) {
// This is the event handler.
},
obj);
La méthode prend également en charge une syntaxe alternative, dans laquelle le premier paramètre est un objet représentant une table associative contenant les noms d'événements et les fonctions de gestion, et le deuxième paramètre (facultatif) correspond au contexte utilisé pour chaque gestionnaire :
obj.on(
{
eventName1: function (event) {
// This is the handler for eventName1.
},
eventName2: function (event) {
// This is the handler for eventName2.
}
},
obj);
Si vous n'ajoutez pas de gestionnaire pour un événement, celui-ci est ignoré au niveau local.
Paramètres :
| Nom | Type | Description |
|---|---|---|
type |
Chaîne | Chaîne de caractères identifiant le type d'événement. Vous pouvez spécifier plusieurs noms d'événements dans cette chaîne, en les séparant par un espace. Le gestionnaire d'événements traitera chacun de ces événements. |
handler |
fonction | La fonction de gestion destinée à traiter l'événement. Cette fonction prend l'objet événement en paramètre. |
context |
Objet | (Facultatif) Définit la valeur de this dans la fonction de gestion des événements. |
Voir : : - off() - une fois() - Evénements
Retours :
L'objet EventDispatcher.
once(type, handler, context) → {Object}
Ajoute une fonction de gestion d'événements pour un ou plusieurs événements. Une fois que la fonction de gestion est appelée,
la méthode de gestion spécifiée est supprimée en tant que gestionnaire de cet événement. (Lorsque vous utilisez
la on() méthode permettant d'ajouter un gestionnaire d'événements ; ce gestionnaire est pas
est supprimé lorsqu’il est appelé.) Le once() Cette méthode équivaut à
appeler la on()
méthode et appel off() lors de la première invocation du gestionnaire.
Le code suivant ajoute un gestionnaire d'événement ponctuel pour un événement :
obj.once("eventName", function (event) {
// This is the event handler.
});
Si vous transmettez plusieurs noms d'événements et une méthode de gestion, celle-ci est enregistrée pour chacun de ces événements :
obj.once("eventName1 eventName2"
function (event) {
// This is the event handler.
});
Vous pouvez également passer un troisième context paramètre (facultatif) permettant de définir
la valeur de
this dans la méthode de gestionnaire :
obj.once("eventName",
function (event) {
// This is the event handler.
},
obj);
La méthode prend également en charge une syntaxe alternative, dans laquelle le premier paramètre est un objet qui constitue une table de correspondance entre les noms d'événements et les fonctions de gestion, et le deuxième paramètre (facultatif) correspond au contexte utilisé pour chaque gestionnaire :
obj.once(
{
eventName1: function (event) {
// This is the event handler for eventName1.
},
eventName2: function (event) {
// This is the event handler for eventName1.
}
},
obj);
Paramètres :
| Nom | Type | Description |
|---|---|---|
type |
Chaîne | Chaîne identifiant le type d'événement. Vous pouvez spécifier plusieurs noms d'événements dans cette chaîne, en les séparant par un espace. Le gestionnaire d'événements traitera la première occurrence de ces événements. Une fois le premier événement survenu, le gestionnaire est supprimé (pour tous les événements spécifiés). |
handler |
fonction | La fonction de gestion destinée à traiter l'événement. Cette fonction prend l'objet événement en paramètre. |
context |
Objet | (Facultatif) Définit la valeur de this dans la fonction de gestion des événements. |
Voir : : - on() - off() - Evénements
Retours :
L'objet qui a déclenché l'événement.
removeEventListener(type, listener, context)
Paramètres :
| Nom | Type | Description |
|---|---|---|
type |
Chaîne | La chaîne de caractères identifiant le type d'événement. |
listener |
fonction | La fonction d'écouteur d'événement à supprimer. |
context |
Objet | (Facultatif) Si vous spécifiez un context, le gestionnaire d'événements est supprimé pour tous les événements spécifiés et tous les écouteurs d'événements qui utilisent le contexte spécifié. (Le contexte doit correspondre au contexte transmis à addEventListener().) |
Déclassé — utilisation off() au lieu de cela.
Supprime un écouteur d'événement pour un événement spécifique.
Lance une exception si le listener Le nom n'est pas valide.
Voir : : - off() - Evénements