Common DOM API

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

public int getScreenX()
画面の座標系の原点を基準とする、イベントが発生した位置の水平座標です。


getScreenY

public int getScreenY()
画面の座標系の原点を基準とする、イベントが発生した位置の垂直座標です。


getClientX

public int getClientX()
DOM 実装のクライアント領域を基準とする、イベントが発生した位置の水平座標です。


getClientY

public int getClientY()
DOM 実装のクライアント領域を基準とする、イベントが発生した位置の垂直座標です。


getCtrlKey

public boolean getCtrlKey()
イベントの発生時に Ctrl キーが押されていたかどうかを知らせるために使用します。


getShiftKey

public boolean getShiftKey()
イベントの発生時に Shift キーが押されていたかどうかを知らせるために使用します。


getAltKey

public boolean getAltKey()
イベントの発生時に Alt キーが押されていたかどうかを知らせるために使用します。 プラットフォームによっては、このキーは別のキー名に対応することがあります。


getMetaKey

public boolean getMetaKey()
イベントの発生時に Meta キーが押されていたかどうかを知らせるために使用します。 プラットフォームによっては、このキーは別のキー名に対応することがあります。


getButton

public short getButton()
マウスボタンを押すか離すことによって引き起こされたマウスイベントの際に、 button は、どのマウスボタンが状態を変化させたかを示すために 使用されます。button の値は、0 がマウスの左ボタン、1 が中央ボタン (存在する場合)、2 が右ボタンを示します。左手用にボタンのアクションが逆に構成 されたマウスでは、この値は右から左の順に番号が振られます。


getRelatedTarget

public EventTarget getRelatedTarget()
UI イベントに関連する二次 EventTarget を識別するために使用します。 現在のところ、この属性は、mouseover イベントでポインティングデバイスが外へ出た EventTarget を示すために使用され、mouseout イベントでポインティング デバイスが中へ入った EventTarget を示すために使用されます。


initMouseEvent

public 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 回以上呼び出した場合、最後の呼び出しが優先されます。

パラメータ:
typeArg - イベントの型を指定する
canBubbleArg - イベントがバブルできるかどうかを指定する
cancelableArg - デフォルトのアクションを阻止できるかどうかを指定する
viewArg - EventAbstractView を指定する
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 を指定する

Common DOM API

バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.