UIEvent#
new UIEvent()#
Interfejs UIEvent może być wywoływany w roli konstruktora, dzięki czemu pozwala na bezpośrednie tworzenie nowych zdarzeń UI (syntetycznych) wprost z interfejsu. Przy tworzeniu nowego zdarzenia od razu ustalany jest jego typ (pierwszy argument) oraz specyficzne cechy ustawiane za pomocą opcjonalnego słownika UIEventInit (drugi argument).
Składnia#
Samo wywołanie i poszczególne jego części najlepiej objaśnić na zapisie składniowym:
var new_uiEvent = new UIEvent(type [, uiEventInitDict]);
gdzie poszczególne człony oznaczają:
new_uiEvent
- referencja do nowego zdarzenia.type
- typ zdarzenia w postaci łańcucha znakowego. Może to być dowolny łańcuch znakowy (nawet pusty).uiEventInitDict
- opcjonalny obiekt określający szczegółowe kryteria inicjalizacji zdarzenia. Oto dostępne właściwości dla obiektu:bubbles
- boolowskietrue
oznacza, że zdarzenie zezwala na obsługę fazy bąbelkowania. Domyślną wartością jest boolowskiefalse
(dziedziczone z EventInit).cancelable
- boolowskietrue
oznacza, że domyślne akcje dla zdarzenia mogą zostać anulowane. Domyślną wartością jest boolowskiefalse
(dziedziczone z EventInit).view
- obiekt okna lub wartośćnull
. Domyślną wartością jest wartośćnull
.detail
- szczegółowe informacje w postaci liczby całkowitej. Domyślną wartością jest0
.
Algorytm wywołania konstruktora new UIEvent(type, uiEventInitDict)
nie jest skomplikowany. Dla lepszego zrozumienia tematu prezentuję go w całości:
- Zwróć nowe zdarzenie UI za pomocą algorytmu tworzenia zdarzenia z typem
type
i słownikiemuiEventInitDict
(jeśli występuje).
Obiekt zwracany przez konstruktor new UIEvent()
implementuje interfejs UIEvent, dlatego ma dostęp do wszystkich poleceń z tego interfejsu (oraz z kolejnych interfejsów w łańcuchu dziedziczenia). Warto podkreślić, że i opcjonalny słownik UIEventInit dziedziczy ze słownika EventInit, dlatego ma dostęp do wszystkich jego członków w chwili przekazania do konstruktora.
Nowy obiekt zdarzenia będzie miał ustawiane domyślne wartości dla wszystkich swoich właściwości i dodatkowo zostanie automatycznie zainicjowany zgodnie z przekazanymi argumentami przy jego wywołaniu, w przeciwieństwie do polecenia Document.createEvent()
, dlatego może być od razu wysłany za pomocą metody EventTarget.dispatchEvent()
.
W ramach uzupełnienia warto przeanalizować wady i zalety poszczególnych poleceń odpowiedzialnych za tworzenie niezaufanych zdarzeń.
Ze względów bezpieczeństwa zdarzenia generowane przy użyciu konstruktora new UIEvent()
muszą ustawiać wartość właściwości Event.isTrusted
na boolowskie false
.
Prosty przykład:
<script>
// Tworzymy nowe zdarzenie
var uiEvent1 = new UIEvent("piesek");
document.write(uiEvent1); // [object UIEvent]
document.write("<br>");
document.write(uiEvent1.type); // piesek
document.write("<br>");
document.write(uiEvent1.bubbles); // false
document.write("<br>");
document.write(uiEvent1.cancelable); // false
document.write("<br>");
document.write(uiEvent1.view); // null
document.write("<br>");
document.write(uiEvent1.detail); // 0
document.write("<br>");
document.write(uiEvent1.defaultPrevented); // false
document.write("<br>");
document.write(uiEvent1.isTrusted); // false
document.write("<br>");
document.write(uiEvent1.eventPhase); // 0
document.write("<br>");
document.write(uiEvent1.timeStamp); // liczba całkowita z wartością zależną od chwili uruchomienia przykładu
document.write("<br>");
document.write(uiEvent1.currentTarget); // null
document.write("<br>");
document.write(uiEvent1.target); // null
document.write("<br><br>");
// Tworzymy kolejne zdarzenie
var uiEvent2 = new UIEvent("piesek", {
bubbles: true,
cancelable: true,
view: window,
detail: 69
});
document.write(uiEvent2); // [object UIEvent]
document.write("<br>");
document.write(uiEvent2.type); // piesek
document.write("<br>");
document.write(uiEvent2.bubbles); // true
document.write("<br>");
document.write(uiEvent2.cancelable); // true
document.write("<br>");
document.write(uiEvent2.view); // [object Window]
document.write("<br>");
document.write(uiEvent2.detail); // 69
document.write("<br>");
document.write(uiEvent2.defaultPrevented); // false
document.write("<br>");
document.write(uiEvent2.isTrusted); // false
document.write("<br>");
document.write(uiEvent2.eventPhase); // 0
document.write("<br>");
document.write(uiEvent2.timeStamp); // liczba całkowita z wartością zależną od chwili uruchomienia przykładu
document.write("<br>");
document.write(uiEvent2.currentTarget); // null
document.write("<br>");
document.write(uiEvent2.target); // null
</script>
Na chwilę obecną wszystkie aktualne przeglądarki pozwalają na wywoływanie interfejsu UIEvent w roli konstruktora, oczywiście z wyjątkiem IE11.
Interfejs Web IDL#
[Constructor(DOMString type, optional UIEventInit uiEventInitDict)] interface UIEvent : Event { }; dictionary UIEventInit : EventInit { Window? view = null; long detail = 0; };