MouseEvent#

MouseEvent.initMouseEvent()#

Metoda initMouseEvent() 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:

mouseEvent.initMouseEvent(type, bubbles, cancelable, view,
			  detail, screenX, screenY, clientX,
			  clientY, ctrlKey, altKey, shiftKey,
			  metaKey, button, relatedTarget);

gdzie poszczególne człony oznaczają:

mouseEvent - 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 - boolowskie true oznacza, że zdarzenie zezwala na obsługę fazy bąbelkowania. Boolowskie false zabrania bąbelkowania.
cancelable - boolowskie true oznacza, że domyślne akcje dla zdarzenia mogą zostać anulowane. Boolowskie false nie zezwala na przerywanie domyślnych akcji.
view - obiekt okna lub wartość null.
detail - szczegółowe informacje w postaci liczby całkowitej.
screenX - współrzędna pozioma miejsca wystąpienia zdarzenia w stosunku do ekranu urządzenia.
screenY - współrzędna pionowa miejsca wystąpienia zdarzenia w stosunku do ekranu urządzenia.
clientX - współrzędna pozioma miejsca wystąpienia zdarzenia w stosunku do obszaru operacyjnego.
clientY - współrzędna pionowa miejsca wystąpienia zdarzenia w stosunku do obszaru operacyjnego.
ctrlKey - boolowskie true oznacza aktywność klawisza kontrolnego w chwili wysłania zdarzenia. Boolowskie false wskazuje na brak aktywności.
altKey - boolowskie true oznacza aktywność klawisza alternatywy w chwili wysłania zdarzenia. Boolowskie false wskazuje na brak aktywności.
shiftKey - boolowskie true oznacza aktywność klawisza zmiany w chwili wysłania zdarzenia. Boolowskie false wskazuje na brak aktywności.
metaKey - boolowskie true oznacza aktywność klawisza mety w chwili wysłania zdarzenia. Boolowskie false wskazuje na brak aktywności.
button - liczba całkowita reprezentującą aktywność konkretnego przycisku w chwili wysłania zdarzenia.
relatedTarget - dodatkowy obiekt, który jest powiązany z nowym zdarzeniem.

Na podstawie współrzędnych clientX i clientY implementacje mogą obliczać inne współrzędne, jak np. współrzędne celu lub inne rozszerzające właściwości zdarzeń myszy (np. pageX czy pageY).

Algorytm wywołania metody initMouseEvent(type, bubbles, cancelable, view, detail, screenX, screenY, clientX, clientY, ctrlKey, altKey, shiftKey, metaKey, button, relatedTarget) nie jest skomplikowany. Dla lepszego zrozumienia tematu prezentuję go w całości:

Wykonaj inicjowanie z typem type, bąbelkowaniem bubbles oraz anulowaniem cancelable na obiekcie kontekstu, a następnie ustaw kolejno jego właściwość view na view, detail na detail, screenX na screenX, screenY na screenY, clientX na clientX, clientY na clientY, ctrlKey na ctrlKey, altKey na altKey, shiftKey na shiftKey, metaKey na metaKey, button na button oraz relatedTarget na relatedTarget.

Inicjowanie zdarzeń metodą initMouseEvent() 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 MouseEvent(), 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 initMouseEvent() jest wielokrotnie wywoływana przed wysłaniem zdarzenia, to pod uwagę brane jest ostatnie takie wywołanie. Jeśli metoda initMouseEvent() 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 initMouseEvent() 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 mouseEvent = document.createEvent("MouseEvent");

	document.write(mouseEvent); // [object MouseEvent]
	document.write("<br>");
	document.write(mouseEvent.type); // "" - pusty łańcuch
	document.write("<br>");
	document.write(mouseEvent.bubbles); // false
	document.write("<br>");
	document.write(mouseEvent.cancelable); // false
	document.write("<br>");
	document.write(mouseEvent.view); // null
	document.write("<br>");
	document.write(mouseEvent.detail); // 0
	document.write("<br>");
	document.write(mouseEvent.screenX); // 0
	document.write("<br>");
	document.write(mouseEvent.screenY); // 0
	document.write("<br>");
	document.write(mouseEvent.clientX); // 0
	document.write("<br>");
	document.write(mouseEvent.clientY); // 0
	document.write("<br>");
	document.write(mouseEvent.altKey); // false
	document.write("<br>");
	document.write(mouseEvent.ctrlKey); // false
	document.write("<br>");
	document.write(mouseEvent.metaKey); // false
	document.write("<br>");
	document.write(mouseEvent.shiftKey); // false
	document.write("<br>");
	document.write(mouseEvent.button); // 0
	document.write("<br>");
	document.write(mouseEvent.buttons); // 0
	document.write("<br>");
	document.write(mouseEvent.relatedTarget); // null
	document.write("<br>");
	document.write(mouseEvent.defaultPrevented); // false
	document.write("<br>");
	document.write(mouseEvent.isTrusted); // false
	document.write("<br>");
	document.write(mouseEvent.eventPhase); // 0
	document.write("<br>");
	document.write(mouseEvent.timeStamp); // liczba całkowita z wartością zależną od chwili uruchomienia przykładu
	document.write("<br>");
	document.write(mouseEvent.currentTarget); // null
	document.write("<br>");
	document.write(mouseEvent.target); // null

	document.write("<br><br>");

	// Inicjujemy zdarzenie własnymi wartościami
	mouseEvent.initMouseEvent("piesek", true, true, window,
				   69, 50, 100, 150,
				   200, true, true, true,
				   true, 1, document.documentElement);

	document.write(mouseEvent); // [object MouseEvent]
	document.write("<br>");
	document.write(mouseEvent.type); // piesek
	document.write("<br>");
	document.write(mouseEvent.bubbles); // true
	document.write("<br>");
	document.write(mouseEvent.cancelable); // true
	document.write("<br>");
	document.write(mouseEvent.view); // [object Window]
	document.write("<br>");
	document.write(mouseEvent.detail); // 69
	document.write("<br>");
	document.write(mouseEvent.screenX); // 50
	document.write("<br>");
	document.write(mouseEvent.screenY); // 100
	document.write("<br>");
	document.write(mouseEvent.clientX); // 150
	document.write("<br>");
	document.write(mouseEvent.clientY); // 200
	document.write("<br>");
	document.write(mouseEvent.altKey); // true
	document.write("<br>");
	document.write(mouseEvent.ctrlKey); // true
	document.write("<br>");
	document.write(mouseEvent.metaKey); // true
	document.write("<br>");
	document.write(mouseEvent.shiftKey); // true
	document.write("<br>");
	document.write(mouseEvent.button); // 1
	document.write("<br>");
	document.write(mouseEvent.buttons); // 0
	document.write("<br>");
	document.write(mouseEvent.relatedTarget); // [object HTMLHtmlElement]
	document.write("<br>");
	document.write(mouseEvent.defaultPrevented); // false
	document.write("<br>");
	document.write(mouseEvent.isTrusted); // false
	document.write("<br>");
	document.write(mouseEvent.eventPhase); // 0
	document.write("<br>");
	document.write(mouseEvent.timeStamp); // liczba całkowita z wartością zależną od chwili uruchomienia przykładu
	document.write("<br>");
	document.write(mouseEvent.currentTarget); // null
	document.write("<br>");
	document.write(mouseEvent.target); // null

</script>

Metodę initMouseEvent() 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 initMouseEvent() można zmienić jego podstawowe parametry, co byłoby niemożliwe przy wykorzystaniu właściwości zdarzeń, ponieważ są one tylko do odczytu.

Interfejs Web IDL#

Pasek społecznościowy

WebRef - kursy webowe

MouseEvent#

MouseEvent.initMouseEvent()#

Składnia#

Interfejs Web IDL#