org.w3c.dom.events
インタフェース MouseEvent

すべてのスーパーインタフェース:

Event, UIEvent

public interface MouseEvent
extends UIEvent

MouseEvent インタフェースは、マウスイベントに関連した具体的なコンテキスト情報を提供します。

UIEvent から継承された detail 属性は、ユーザアクションの間に、画面上の同じ位置でマウスボタンが押されて離された回数を示します。ユーザがこのアクションを開始した時点で属性値は 1 になり、ボタンの押しと離しが完全に繰り返されるたびに、値が 1 ずつ増えていきます。マウスボタンを押してから離すまでの間にユーザがマウスを移動した場合、この値は 0 に設定され、クリックされなかったことになります。

入れ子になった要素の場合、マウスイベントはいつも、入れ子のもっとも深い要素をターゲットにします。ターゲットにされた要素の先祖要素は、バブルを使用して、子孫要素内で発生したマウスイベントの通知を取得できます。

「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, 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,
                    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 をディスパッチする前にのみ呼び出すことができます。ただし、必要なら、初期化フェーズ中に 2 回以上呼び出すことができます。このメソッドを 2 回以上呼び出した場合、最後の呼び出しが優先されます。

パラメータ:

typeArgSpecifies - イベントの型を指定する

canBubbleArgSpecifies - イベントがバブルできるかどうかを指定する

cancelableArgSpecifies - デフォルトのアクションを阻止できるかどうかを指定する

viewArgSpecifies - Event の AbstractView を指定する

detailArgSpecifies - Event のマウスクリック回数を指定する

screenXArgSpecifies - Event の画面上での x 座標を指定する

screenYArgSpecifies - Event の画面上での y 座標を指定する

clientXArgSpecifies - Event のクライアントでの x 座標を指定する

clientYArgSpecifies - Event のクライアントでの y 座標を指定する

ctrlKeyArgSpecifies - Event の間 Ctrl キーが押されていたかどうかを指定する

altKeyArgSpecifies - Event の間 Alt キーが押されていたかどうかを指定する

shiftKeyArgSpecifies - Event の間 Shift キーが押されていたかどうかを指定する

metaKeyArgSpecifies - Event の間 Meta キーが押されていたかどうかを指定する

buttonArgSpecifies - Event のマウスボタンを指定する

relatedTargetArgSpecifies - Event に関連する EventTarget を指定する