Listener di eventi

Funzione listener definita al di fuori di una classe

L'esempio di codice seguente crea un file SWF semplice in cui viene visualizzato un quadrato rosso. La funzione listener clickHandler() , che non fa parte di una classe, monitora gli eventi click del mouse sul quadrato rosso.

package 
{ 
    import flash.display.Sprite; 
 
    public class ClickExample extends Sprite 
    { 
        public function ClickExample() 
        { 
            var child:ChildSprite = new ChildSprite(); 
            addChild(child); 
        } 
    } 
} 
 
import flash.display.Sprite; 
import flash.events.MouseEvent; 
 
class ChildSprite extends Sprite 
{ 
    public function ChildSprite() 
    { 
        graphics.beginFill(0xFF0000); 
        graphics.drawRect(0,0,100,100); 
        graphics.endFill(); 
        addEventListener(MouseEvent.CLICK, clickHandler); 
    } 
} 
 
function clickHandler(event:MouseEvent):void 
{ 
    trace("clickHandler detected an event of type: " + event.type); 
    trace("the this keyword refers to: " + this); 
}

Quando un utente interagisce con il file SWF facendo clic sul quadrato, Flash Player o AIR generano il seguente output di traccia:

clickHandler detected an event of type: click 
the this keyword refers to: [object global]

Notate che l'oggetto evento viene passato come argomento a clickHandler() . Questo permette alla funzione listener di analizzare l'oggetto evento. In questo esempio, è necessario usare la proprietà type dell'oggetto evento per determinare se l'evento è un clic del mouse.

L'esempio verifica anche il valore della parola chiave this . In questo caso, this rappresenta l'oggetto globale; questo è opportuno perché la funzione è definita al di fuori di qualsiasi classe predefinita o oggetto.

Funzione listener definita come metodo di classe

L'esempio seguente è identico a quello precedente che definisce la classe ClickExample, con la sola eccezione che la funzione clickHandler() è definita come metodo della classe ChildSprite:

package 
{ 
    import flash.display.Sprite; 
 
    public class ClickExample extends Sprite 
    { 
        public function ClickExample() 
        { 
            var child:ChildSprite = new ChildSprite(); 
            addChild(child); 
        } 
    } 
} 
 
import flash.display.Sprite; 
import flash.events.MouseEvent; 
 
class ChildSprite extends Sprite 
{ 
    public function ChildSprite() 
    { 
        graphics.beginFill(0xFF0000); 
        graphics.drawRect(0,0,100,100); 
        graphics.endFill(); 
        addEventListener(MouseEvent.CLICK, clickHandler); 
    } 
    private function clickHandler(event:MouseEvent):void 
    { 
        trace("clickHandler detected an event of type: " + event.type); 
        trace("the this keyword refers to: " + this); 
    } 
}

Quando un utente interagisce con il file SWF facendo clic sul quadrato rosso, Flash Player o AIR generano il seguente output di traccia:

clickHandler detected an event of type: click 
the this keyword refers to: [object ChildSprite]

Notate che la parola chiave this si riferisce all'istanza di ChildSprite denominata child . Questo rappresenta un cambiamento rispetto a quanto avviene in ActionScript 2.0. Chi ha dimestichezza con i componenti in ActionScript 2.0 ricorderà che quando un metodo di classe viene passato a UIEventDispatcher.addEventListener() , l'area di validità del metodo è legata al componente che ha trasmesso l'evento anziché alla classe in cui il metodo listener è stato definito. In altre parole, usando questa tecnica in ActionScript 2.0, la parola chiave this farebbe riferimento al componente che trasmette l'evento anziché all'istanza di ChildSprite.

Questo rappresenta un problema notevole per i programmatori perché significa che non possono accedere ad altri metodi e proprietà della classe che contiene il metodo listener. Per aggirare il problema, i programmatori di ActionScript 2.0 potevano usare la classe mx.util.Delegate per cambiare l'area di validità del metodo listener. Questo espediente non è tuttavia più necessario perché ActionScript 3.0 crea un metodo vincolato quando viene chiamato addEventListener() . Di conseguenza, la parola chiave this fa riferimento all'istanza di ChildSprite denominata child e il programmatore ha accesso agli altri metodi e alle proprietà della classe ChildSprite.

Listener di eventi da evitare

Esiste una terza possibilità, sconsigliata, che consiste nel creare un oggetto generico dotato di una proprietà che punta a una funzione listener assegnata in modo dinamico. Questa tecnica viene comunque presentata qui perché era usata comunemente in ActionScript 2.0, ma se ne sconsiglia l'impiego in ActionScript 3.0, in quanto la parola chiave this farebbe riferimento all'oggetto globale e non all'oggetto listener.

L'esempio che segue è identico all'esempio precedente della classe ClickExample, con l'eccezione che qui la funzione listener è definita come parte di un oggetto generico denominato myListenerObj :

package 
{ 
    import flash.display.Sprite; 
 
    public class ClickExample extends Sprite 
    { 
        public function ClickExample() 
        { 
            var child:ChildSprite = new ChildSprite(); 
            addChild(child); 
        } 
    } 
} 
 
import flash.display.Sprite; 
import flash.events.MouseEvent; 
 
class ChildSprite extends Sprite 
{ 
    public function ChildSprite() 
    { 
        graphics.beginFill(0xFF0000); 
        graphics.drawRect(0,0,100,100); 
        graphics.endFill(); 
        addEventListener(MouseEvent.CLICK, myListenerObj.clickHandler); 
    } 
} 
 
var myListenerObj:Object = new Object(); 
myListenerObj.clickHandler = function (event:MouseEvent):void 
{ 
        trace("clickHandler detected an event of type: " + event.type); 
        trace("the this keyword refers to: " + this); 
}

Il risultato dell'output di traccia è il seguente:

clickHandler detected an event of type: click 
the this keyword refers to: [object global]

In questo caso this fa riferimento all'oggetto globale e non a myListenerObj e l'output di traccia non è [object Object] . Quando passate il nome di una proprietà dinamica come argomento a addEventListener() , Flash Player o AIR non è in grado di creare un metodo vincolato perché il parametro passato come listener non è altro che l'indirizzo di memoria della funzione listener e Flash Player e AIR non hanno modo di collegare quell'indirizzo all'istanza di myListenerObj .

Aggiunta dei listener di eventi

Il metodo addEventListener() è il pezzo forte dell'interfaccia IEventDispatcher e consente di registrare le funzioni listener. I due parametri obbligatori sono type e listener . Con il parametro type specificate il tipo di evento, mentre con il parametro listener specificate la funzione listener da eseguire quando si verifica l'evento. Il parametro listener può essere un riferimento a una funzione o a un metodo di classe.

addEventListener(MouseEvent.CLICK, clickHandler)

Il parametro useCapture del metodo addEventListener() consente di controllare la fase del flusso di eventi in cui il listener sarà attivo. Se useCapture è impostato su true , il listener sarà attivo durante la fase di cattura del flusso di eventi. Se useCapture è impostato su false , il listener sarà attivo durante la fase target e di bubbling del flusso di eventi. Per monitorare un evento durante tutte le fasi del flusso di eventi, chiamate addEventListener() due volte, una volta con useCapture impostato su true e una seconda volta con useCapture impostato su false .

Il parametro priority del metodo addEventListener() non è un elemento ufficiale del modello eventi DOM Level 3, però è stato incluso in ActionScript 3.0 per rendere più flessibile l'organizzazione dei listener di eventi. Quando chiamate addEventListener() , potete impostare la priorità per quel listener di eventi passando un valore intero come parametro priority . Il valore predefinito è 0, ma è possibile modificarlo in un valore intero negativo o positivo. Più è alto il numero, prima verrà eseguito il listener di eventi. I listener di eventi con la stessa priorità vengono eseguiti nell'ordine in cui sono stati aggiunti, quindi prima è stato aggiunto un listener, prima viene eseguito.

Il parametro useWeakReference permette di specificare se il riferimento alla funzione listener è debole o normale. Impostando questo parametro su true è possibile evitare situazioni in cui le funzioni listener rimangono in memoria anche quando diventano superflue. Flash Player e AIR usano la tecnica garbage collection per eliminare dalla memoria gli oggetti inutilizzati. Un oggetto viene considerato inutilizzato quando non esistono più riferimenti ad esso. L'operazione di garbage collection non tiene in considerazione i riferimenti deboli, vale a dire che una funzione listener per cui esiste solo un riferimento debole diventa una candidata per la garbage collection.

Eliminazione dei listener di eventi

Per rimuovere i listener di eventi inutilizzati si può usare il metodo removeEventListener() . È buona norma rimuovere i listener diventati superflui. I parametri obbligatori sono eventName e listener , cioè gli stessi parametri del metodo addEventListener() . Ricordate che potete monitorare gli eventi durante tutte le fasi del flusso di eventi chiamando due volte addEventListener() : una con useCapture impostato su true e una seconda con il parametro impostato su false . Per eliminare entrambi i listener di eventi dovete chiamare removeEventListener() due volte: una prima volta con useCapture impostato su true e una seconda volta con il parametro impostato su false .

Invio degli eventi

I programmatori esperti possono usare il metodo dispatchEvent() per inviare un oggetto evento personalizzato nel flusso di eventi. L'unico parametro accettato da questo metodo è un riferimento a un oggetto evento, che deve essere un'istanza o una sottoclasse della classe Event. Una volta inviato l'evento, la proprietà target dell'oggetto evento viene impostata sull'oggetto su cui il metodo dispatchEvent() è stato chiamato.

Verifica della presenza di listener di eventi

Gli ultimi due metodi dell'interfaccia IEventDispatcher forniscono informazioni utili per individuare l'esistenza di listener di eventi. Il metodo hasEventListener() restituisce il valore true se individua un listener di eventi per un tipo di evento specifico su un particolare oggetto dell'elenco di visualizzazione. Anche il metodo willTrigger() restituisce il valore true se individua un listener per un oggetto specifico dell'elenco di visualizzazione, ma willTrigger() verifica la presenza di listener non solo sull'oggetto di visualizzazione in sé ma anche su tutti gli antenati dell'oggetto per tutte le fasi del flusso di eventi.