EventDispatcher  - AS3

Agreguje instancję klasy EventDispatcher.

Klasa EventDispatcher jest z reguły używana jako klasa podstawowa, co oznacza, że większość programistów nie musi używać tej funkcji konstruktora. Z konstruktora muszą jednak korzystać zaawansowani programiści, którzy implementują interfejs IEventDispatcher. Jeśli rozszerzenie klasy EventDispatcher nie jest możliwe i zachodzi konieczność zaimplementowania interfejsu IEventDispatcher, należy użyć tego konstruktora w celu zagregowania instancji klasy EventDispatcher.

Rejestruje obiekt detektora zdarzenia w obiekcie EventDispatcher, dzięki czemu detektor będzie otrzymywał powiadomienia o zdarzeniu. We wszystkich węzłach listy wyświetlania można rejestrować detektory zdarzeń reagujące na zdarzenia konkretnego typu, znajdujące się w określonej fazie i mające określony priorytet.

Po pomyślnym zarejestrowaniu detektora zdarzeń nie można zmienić jego priorytetu poprzez dodatkowe wywołania metody addEventListener(). Aby zmienić priorytet detektora, należy najpierw wywołać metodę removeListener(). Następnie można ponownie zarejestrować detektor z nowym poziomem priorytetu.

Należy pamiętać, że po zarejestrowaniu detektora późniejsze wywołania metody addEventListener() z różnymi wartościami type albo useCapture powodują rejestrowanie odrębnych detektorów. Na przykład detektor zarejestrowany z parametrem useCapture ustawionym na true wykrywa tylko zdarzenia w fazie przechwytywania. Po ponownym wywołaniu metody addEventListener() z tym samym obiektem detektora, ale z parametrem useCapture ustawionym na false będą istniały dwa odrębne detektory: jeden wykrywający zdarzenia w fazie przechwytywania, a drugi wykrywający zdarzenia w fazach miejsca docelowego i propagacji.

Nie można zarejestrować detektora zdarzeń, który wykrywałby tylko zdarzenia w fazie miejsca docelowego lub tylko zdarzenia w fazie propagacji. Te fazy są sprzężone podczas rejestracji, ponieważ propagacja zachodzi tylko w przodkach węzła miejsca docelowego.

Gdy detektor zdarzeń przestanie być potrzebny, należy go usunąć, wywołując metodę removeEventListener(); w przeciwnym razie mogą wystąpić problemy w zarządzaniu pamięcią. Detektory zdarzeń nie są automatycznie usuwane z pamięci, ponieważ proces czyszczenia pamięci nie usuwa detektora, pod warunkiem że istnieje obiekt wywołujący (o ile dla parametru useWeakReference ustawiona jest wartość true).

Skopiowanie instancji klasy EventDispatcher nie powoduje skopiowania detektorów zdarzeń dołączonych do tej instancji. (Jeśli utworzono nowy węzeł, dla którego potrzebny jest detektor zdarzeń, należy dołączyć detektor po utworzeniu węzła). Jednak przeniesienie instancji klasy EventDispatcher powoduje również przeniesienia dołączonych do niej detektorów zdarzeń

Jeśli detektor zdarzeń jest rejestrowany w węźle w momencie, gdy ten węzeł przetwarza zdarzenie, detektor nie zostanie wywołany w bieżącej fazie, ale może być wywołany w późniejszej fazie przepływu zdarzeń, np. w fazie propagacji.

Jeśli detektor zdarzeń zostanie usunięty z węzła w momencie, gdy ten węzeł przetwarza zdarzenie, zostanie wywołany przez bieżące operacje. Raz usunięty detektor zdarzeń nie jest nigdy ponownie wywoływany (chyba że zostanie ponownie zarejestrowany na potrzeby dalszego etapu wykonania programu).

Parametry

function(evt:Event):void

Wywołuje zdarzenie, tj. kieruje je do przepływu zdarzeń. Miejscem docelowym zdarzenia jest obiekt EventDispatcher, względem którego wywołano metodę dispatchEvent().

Parametry

Sprawdza, czy obiekt EventDispatcher zawiera jakiekolwiek detektory zarejestrowane dla konkretnego typu zdarzeń. Umożliwia to określenie, w którym miejscu hierarchii przepływu zdarzeń w obiekcie EventDispatcher zmodyfikowana jest obsługa zdarzeń danego typu. Aby sprawdzić, czy zdarzenie określonego typu faktycznie wywoła detektor zdarzeń, należy użyć metody willTrigger().

Różnica między metodą hasEventListener() a metodą willTrigger() polega na tym, że metoda hasEventListener() sprawdza tylko obiekt, do którego należy, natomiast metoda willTrigger() sprawdza cały przepływ zdarzenia określonego parametrem type.

Gdy metoda hasEventListener() jest wywoływana z obiektu LoaderInfo, pod uwagę brane są tylko detektory, do których obiekt wywołujący może uzyskać dostęp.

Parametry

Powiązane elementy interfejsu API

Usuwa detektor z obiektu EventDispatcher. Jeśli w obiekcie EventDispatcher nie ma zarejestrowanego zgodnego detektora zdarzeń, wywołanie tej metody nie odnosi żadnego skutku.

Parametry

Sprawdza, czy detektor zdarzeń określonego typu jest zarejestrowany w tym obiekcie EventDispatcher lub jego przodkach. Ta metoda zwraca wartość true, jeśli detektor zdarzeń będzie wywoływany w dowolnej fazie przepływu zdarzeń, gdy zdarzenie określonego typu zostanie wywołane w obiekcie EventDispatcher lub dowolnym z jego przodków.

Różnica między metodą hasEventListener() a metodą willTrigger() polega na tym, że metoda hasEventListener() sprawdza tylko obiekt, do którego należy, natomiast metoda willTrigger() sprawdza cały przepływ zdarzenia określonego parametrem type.

Gdy metoda willTrigger() jest wywoływana z obiektu LoaderInfo, pod uwagę brane są tylko detektory, do których obiekt wywołujący może uzyskać dostęp.

Parametry

[zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja środowiska wykonawczego AIR uzyskuje fokus w systemie operacyjnym i przechodzi w stan aktywny. Jest to zdarzenie broadcast, co oznacza, że zostanie ono wywołane przez wszystkie obiekty EventDispatcher, których detektor jest zarejestrowany dla tego zdarzenia. Więcej informacji o zdarzeniach broadcast zawiera opis klasy DisplayObject.

Uwaga: to zdarzenie nie zawiera fazy „przechwytywania” ani „propagacji”, co oznacza, że detektory zdarzeń muszą być dodawane bezpośrednio do każdego potencjalnego obiektu docelowego — niezależnie od tego, czy obiekt znajduje się na liście wyświetlania.

To zdarzenie nie jest nigdy automatycznie wywoływane na urządzeniach telewizyjnych ze środowiskiem AIR. Można wywołać je ręcznie.

To zdarzenie ma następujące właściwości:

Powiązane elementy interfejsu API

[zdarzenie broadcast] Wywoływane, gdy program Flash Player lub aplikacja AIR traci fokus w systemie operacyjnym i przechodzi w stan nieaktywny. Jest to zdarzenie broadcast, co oznacza, że zostanie ono wywołane przez wszystkie obiekty EventDispatcher, których detektor jest zarejestrowany dla tego zdarzenia. Więcej informacji o zdarzeniach broadcast zawiera opis klasy DisplayObject.

Uwaga: to zdarzenie nie zawiera fazy „przechwytywania” ani „propagacji”, co oznacza, że detektory zdarzeń muszą być dodawane bezpośrednio do każdego potencjalnego obiektu docelowego — niezależnie od tego, czy obiekt znajduje się na liście wyświetlania.

To zdarzenie nie jest nigdy automatycznie wywoływane na urządzeniach telewizyjnych ze środowiskiem AIR. Można wywołać je ręcznie.

To zdarzenie ma następujące właściwości:

Powiązane elementy interfejsu API

1. Konstruktor obiektu EventDispatcherExample tworzy zmienną lokalną dispatcher i przypisuje jej nową instancję klasy CustomDispatcher.
2. W obiekcie CustomDispatcher konstruowany jest odpowiedni ciąg znaków, aby zdarzenie nosiło nazwę action, i deklarowana jest metoda doAction(). Ta metoda tworzy zdarzenie action i wywołuje je za pomocą metody EventDispatcher.dispatchEvent().
3. Następnie, przy użyciu właściwości dispatcher, dodawany jest detektor zdarzeń action oraz skojarzona z nim metoda będące subskrybentem, actionHandler(), która drukuje informacje o wywołanym zdarzeniu.
4. Wywołanie metody doAction() powoduje wywołanie zdarzenia action.

package {
    import flash.display.Sprite;
    import flash.events.Event;

    public class EventDispatcherExample extends Sprite {

        public function EventDispatcherExample() {
            var dispatcher:CustomDispatcher = new CustomDispatcher();
            dispatcher.addEventListener(CustomDispatcher.ACTION, actionHandler);
            dispatcher.doAction();
        }

        private function actionHandler(event:Event):void {
            trace("actionHandler: " + event);
        }
    }
}

import flash.events.EventDispatcher;
import flash.events.Event;

class CustomDispatcher extends EventDispatcher {
    public static var ACTION:String = "action";

    public function doAction():void {
        dispatchEvent(new Event(CustomDispatcher.ACTION));
    }
}