Event#
Event.initEvent()#
Metoda initEvent()
inicjuje dane zdarzenie wartościami przekazanymi do metody.
Składnia#
Samo wywołanie i poszczególne jego części najlepiej objaśnić na zapisie składniowym:
event.initEvent(type, bubbles, cancelable);
gdzie poszczególne człony oznaczają:
event
- zdarzenie będące obiektem kontekstu.type
- typ zdarzenia w postaci łańcucha znakowego. Może to być dowolny łańcuch znakowy (nawet pusty).bubbles
- boolowsketrue
oznacza, że zdarzenie zezwala na obsługę fazy bąbelkowania. Boolowskiefalse
zabrania bąbelkowania.cancelable
- boolowsketrue
oznacza, że domyślne akcje dla zdarzenia mogą zostać anulowane. Boolowskiefalse
nie zezwala na przerywanie domyślnych akcji.
Algorytm wywołania metody initEvent(type, bubbles, cancelable)
nie jest skomplikowany. Dla lepszego zrozumienia tematu prezentuję go w całości:
- Wykonaj inicjowanie z typem
type
, bąbelkowaniembubbles
oraz anulowaniemcancelable
na obiekcie kontekstu.
Inicjowanie zdarzeń metodą initEvent()
jest obowiązkowe w przypadku niezaufanych zdarzeń, przed ich wysłaniem za pomocą metody EventTarget.dispatchEvent()
, które utworzone zostały za pomocą polecenia Document.createEvent()
. Zdarzenia tworzone za pomocą konstruktora new Event()
, i pochodnych, są inicjowane automatycznie. Także zaufane zdarzenia są inicjowane automatycznie przez daną implementacje.
W ramach uzupełnienia warto przeanalizować wady i zalety poszczególnych poleceń odpowiedzialnych za tworzenie niezaufanych zdarzeń.
Jeśli metoda initEvent()
jest wielokrotnie wywoływana przed wysłaniem zdarzenia, to pod uwagę brane jest ostatnie takie wywołanie. Jeśli metoda initEvent()
zostanie wywołana w trakcie propagacji zdarzenia (np. przez jakiś uchwyt zdarzenia), to nie powoduje ona żadnego efektu i musi zostać natychmiastowo zakończona.
Ze względów bezpieczeństwa zdarzenia modyfikowane przy użyciu metody initEvent()
muszą ustawiać wartość właściwości Event.isTrusted
na boolowskie false
.
Prosty przykład:
<script>
// Tworzymy nowe zdarzenie z domyślnymi wartościami
var event = document.createEvent("Event");
document.write(event); // [object Event]
document.write("<br>");
document.write(event.type); // "" - pusty łańcuch
document.write("<br>");
document.write(event.bubbles); // false
document.write("<br>");
document.write(event.cancelable); // false
document.write("<br>");
document.write(event.defaultPrevented); // false
document.write("<br>");
document.write(event.isTrusted); // false
document.write("<br>");
document.write(event.eventPhase); // 0
document.write("<br>");
document.write(event.timeStamp); // liczba całkowita z wartością zależną od chwili uruchomienia przykładu
document.write("<br>");
document.write(event.currentTarget); // null
document.write("<br>");
document.write(event.target); // null
document.write("<br><br>");
event.initEvent("piesek", true, true); // inicjujemy zdarzenie własnymi wartościami
document.write(event); // [object Event]
document.write("<br>");
document.write(event.type); // piesek
document.write("<br>");
document.write(event.bubbles); // true
document.write("<br>");
document.write(event.cancelable); // true
document.write("<br>");
document.write(event.defaultPrevented); // false
document.write("<br>");
document.write(event.isTrusted); // false
document.write("<br>");
document.write(event.eventPhase); // 0
document.write("<br>");
document.write(event.timeStamp); // liczba całkowita z wartością zależną od chwili uruchomienia przykładu
document.write("<br>");
document.write(event.currentTarget); // null
document.write("<br>");
document.write(event.target); // null
</script>
Metodę initEvent()
pozostawiono ze względu na polecenie Document.createEvent()
. Warto nadmienić, że po zakończeniu obsługi wszystkich faz zdarzenia może ono zostać ponownie wysłane. Dzięki metodzie initEvent()
można zmienić jego podstawowe parametry (typ, bąbelkowanie i anulowanie), co byłoby niemożliwe przy wykorzystaniu podstawowych właściwości zdarzeń, ponieważ są one tylko do odczytu.
Interfejs Web IDL#
void initEvent(DOMString type, boolean bubbles, boolean cancelable);