org.w3c.dom.events
介面 MouseEvent

所有父級介面：

Event, UIEvent

public interface MouseEvent
extends UIEvent

MouseEvent 介面提供與鼠標事件相關聯的特定上下文資訊。

從 UIEvent 繼承的 detail 屬性指示在使用者操作期間同一螢幕位置上鼠標按鍵被按下和釋放的次數。使用者開始此操作時屬性值為 1，對每個完整的按下和釋放序列增加 1。如果使用者在 mousedown 和 mouseup 之間移動鼠標，則將值設置為 0，指示沒有進行單擊操作。

就巢狀元素來說，鼠標事件的目標始終是最裡層的巢狀元素。目標元素的祖先可以使用 bubbling 來獲得在其後代元素內發生的鼠標事件的通知。

另請參見 Document Object Model (DOM) Level 2 Events Specification。

從以下版本開始：

DOM Level 2

欄位摘要

從介面 org.w3c.dom.events.Event 繼承的欄位

AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE

方法摘要

boolean	getAltKey() 用於指示在觸發事件期間是否按下 'alt' 鍵。
short	getButton() 在由按下或釋放鼠標的按鍵引起的鼠標事件期間，button 用於指示哪一個鼠標按鍵改變了狀態。
int	getClientX() 相對於 DOM 實作的客戶區域的水平坐標(事件發生在此處)。
int	getClientY() 相對於 DOM 實作的客戶區域的垂直坐標(事件發生在此處)。
boolean	getCtrlKey() 用於指示在觸發事件事件期間是否按下 'ctrl' 鍵。
boolean	getMetaKey() 用於指示在觸發事件期間是否按下 'meta' 鍵。
EventTarget	getRelatedTarget() 用於識別與 UI 事件相關的輔助 EventTarget。
int	getScreenX() 相對於螢幕坐標系統原點的水平坐標(事件發生在此處)。
int	getScreenY() 相對於螢幕坐標系統原點的垂直坐標(事件發生在此處)。
boolean	getShiftKey() 用於指示在觸發事件期間是否按下 'shift' 鍵。
void	initMouseEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, org.w3c.dom.views.AbstractView viewArg, int detailArg, int screenXArg, int screenYArg, int clientXArg, int clientYArg, boolean ctrlKeyArg, boolean altKeyArg, boolean shiftKeyArg, boolean metaKeyArg, short buttonArg, EventTarget relatedTargetArg) initMouseEvent 方法用於初始化通過 DocumentEvent 介面創建的 MouseEvent 的值。

從介面 org.w3c.dom.events.UIEvent 繼承的方法

getDetail, getView, initUIEvent

從介面 org.w3c.dom.events.Event 繼承的方法

getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation

方法詳細資訊

getScreenX

int getScreenX()

相對於螢幕坐標系統原點的水平坐標(事件發生在此處)。

getScreenY

int getScreenY()

相對於螢幕坐標系統原點的垂直坐標(事件發生在此處)。

getClientX

int getClientX()

相對於 DOM 實作的客戶區域的水平坐標(事件發生在此處)。

getClientY

int getClientY()

相對於 DOM 實作的客戶區域的垂直坐標(事件發生在此處)。

getCtrlKey

boolean getCtrlKey()

用於指示在觸發事件事件期間是否按下 'ctrl' 鍵。

getShiftKey

boolean getShiftKey()

用於指示在觸發事件期間是否按下 'shift' 鍵。

getAltKey

boolean getAltKey()

用於指示在觸發事件期間是否按下 'alt' 鍵。在有些平臺上，此鍵可能映射為一個替代鍵名。

getMetaKey

boolean getMetaKey()

用於指示在觸發事件期間是否按下 'meta' 鍵。在有些平臺上，此鍵可能映射為一個替代鍵名。

getButton

short getButton()

在由按下或釋放鼠標的按鍵引起的鼠標事件期間，button 用於指示哪一個鼠標按鍵改變了狀態。button 值的範圍為 0 （指示鼠標的左鍵）、1（指示中間鍵（如果有））和 2（指示右鍵）。對於為左手使用而配置的鼠標，鼠標按鍵操作正好相反，值改為從右向左讀取。

getRelatedTarget

EventTarget getRelatedTarget()

用於識別與 UI 事件相關的輔助 EventTarget。目前此屬性和 mouseover 事件一起使用來指示指點設備退出的 EventTarget，和 mouseout 事件一起使用指示指點設備進入的 EventTarget。

initMouseEvent

void initMouseEvent(String typeArg,
                    boolean canBubbleArg,
                    boolean cancelableArg,
                    org.w3c.dom.views.AbstractView viewArg,
                    int detailArg,
                    int screenXArg,
                    int screenYArg,
                    int clientXArg,
                    int clientYArg,
                    boolean ctrlKeyArg,
                    boolean altKeyArg,
                    boolean shiftKeyArg,
                    boolean metaKeyArg,
                    short buttonArg,
                    EventTarget relatedTargetArg)

initMouseEvent 方法用於初始化通過 DocumentEvent 介面創建的 MouseEvent 的值。此方法只能在通過 dispatchEvent 方法指派 MouseEvent 之前調用，儘管在該階段可以多次調用它（如有必要）。如果被多次調用，則最後一次調用優先。

參數：

typeArg - 指定事件型別。

canBubbleArg - 指定該事件是否可以 bubble。

cancelableArg - 指定是否可以阻止事件的預設操作。

viewArg - 指定 Event 的 AbstractView。

detailArg - 指定 Event 的鼠標單擊量。

screenXArg - 指定 Event 的螢幕 x 坐標

screenYArg - 指定 Event 的螢幕 y 坐標

clientXArg - 指定 Event 的客戶機 x 坐標

clientYArg - 指定 Event 的客戶機 y 坐標

ctrlKeyArg - 指定是否在 Event 期間按下 control 鍵。

altKeyArg - 指定是否在 Event 期間按下 alt 鍵。

shiftKeyArg - 指定是否在 Event 期間按下 shift 鍵。

metaKeyArg - 指定是否在 Event 期間按下 meta 鍵。

buttonArg - 指定 Event 的鼠標按鍵。

relatedTargetArg - 指定 Event 的相關 EventTarget。