Disponibilité

Flash Player 6 (6.0.79.0).

Edition

Flash MX 2004 ou Flash MX Professional 2004.

Utilisation

componentInstance.addEventListener(event, listener)

Paramètres

event Chaîne correspondant au nom de l'événement.

listener Référence à une fonction ou à un objet écouteur.

Valeur renvoyée

Aucune.

Description

Méthode qui associe un objet écouteur à une occurrence de composant qui diffuse un événement. Lorsque l'événement est déclenché, l'objet écouteur ou la fonction est averti(e). Vous pouvez appeler cette méthode à partir de toute occurrence de composant. Le code suivant, par exemple, enregistre un écouteur dans l'occurrence du composant myButton :

myButton.addEventListener("click", myListener);

Vous devez définir l'écouteur en tant qu'objet ou fonction avant d'appeler addEventListener() pour enregistrer l'écouteur avec l'occurrence de composant. Si l'écouteur est un objet, il doit avoir une fonction de rappel, invoquée lorsque l'événement se produit. En général, cette fonction de rappel porte le même nom que l'événement associé à l'écouteur. Si l'écouteur est une fonction, celle-ci est invoquée lorsque l'événement se produit. Pour plus d'informations, consultez Gestion des événements à l'aide d'écouteurs dans Utilisation des composants ActionScript 2.0.

Vous pouvez enregistrer plusieurs écouteurs dans une même occurrence de composant, mais vous devez appeler addEventListener() séparément pour chacun d'eux. Vous pouvez également enregistrer un écouteur dans plusieurs occurrences de composant, mais vous devez appeler addEventListener() séparément pour chacune d'elles. Le code suivant, par exemple, définit un objet écouteur et l'affecte à deux occurrences du composant Button, dont les propriétés label sont respectivement button1 et button2 :

lo = new Object();
lo.click = function(evt){
    trace(evt.target.label + " clicked");
}
button1.addEventListener("click", lo);
button2.addEventListener("click", lo);

L'ordre d'exécution n'est pas garanti. Vous ne pouvez pas anticiper l'ordre dans lequel les écouteurs seront appelés.

Un objet événement est transmis à l'écouteur sous forme de paramètre. L'objet événement a des propriétés contenant des informations sur l'événement qui s'est produit. Vous pouvez utiliser l'objet événement à l'intérieur de la fonction de rappel de l'écouteur pour connaître le type d'événement qui s'est produit et l'occurrence qui a diffusé l'événement. Dans l'exemple ci-dessus, l'objet événement correspond à evt (vous pouvez utiliser n'importe quel identifiant comme nom d'objet événement) et il est utilisé dans les instructions if pour connaître l'occurrence Button sur laquelle l'utilisateur a cliqué. Pour plus d'informations, consultez Objet événement dans Utilisation des composants ActionScript 2.0.

Exemple

L'exemple suivant définit un objet écouteur, myListener, et définit la fonction de rappel de l'événement click. Il appelle ensuite addEventListener() pour enregistrer l'objet écouteur myListener avec l'occurrence du composant myButton.

myListener = new Object();
myListener.click = function(evt){
    trace(evt.type + " triggered");
}
myButton.addEventListener("click", myListener);

Pour tester ce code, placez sur la scène une occurrence du composant Button nommée myButton, puis insérez ce code dans l'image 1.