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 イベントに関連する 2 次の 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 イベントに関連する 2 次の EventTarget を識別するときに使用します。現在、この属性はマウスオーバーイベントとともにポインティングデバイスがはずれた EventTarget を示したり、マウスアウトイベントと共にポインティングデバイスが入った 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 の値を初期化するときに使用します。このメソッドは、MouseEvent が dispatchEvent メソッドを介してディスパッチされる前にかぎり呼び出されますが、必要な場合は初期化する段階で複数回呼び出されることもあります。複数回呼び出された場合は、最後の呼び出しが優先されます。

パラメータ:

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

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

cancelableArg - イベントのデフォルトアクションを抑制できるかどうかを 指定する

viewArg - Event の AbstractView を指定する

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

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

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

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

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

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

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

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

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

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

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