インタフェースMouseEvent

すべてのスーパー・インタフェース:
Event, UIEvent
public interface MouseEvent extends UIEvent
MouseEventインタフェースは、マウス・イベントに関連する固有のコンテキスト情報を提供します。

UIEventから継承されたdetail属性は、ユーザー・アクション中に画面の同じ位置でマウス・ボタンを押して離す回数を示します。 このアクションを開始するときの属性値は1で、押して離す一連の動作が完全に行われるたびに値が1増加します。 マウスダウンしてマウス・アップする間にマウスを動かすと値は0に設定され、クリックされていないことが示されます。

入れ子にされた要素の場合、マウス・イベントは常に、いちばん深く入れ子にされた要素をターゲットにします。 ターゲットにされた要素の上位要素は、バブリングを使用してその下位要素内で発生するマウス・イベントの通知を取得します。

「Document Object Model (DOM) Level 2 Events Specification」も参照してください。

導入されたバージョン:
1.5、DOMレベル2

  • フィールドのサマリー

    インタフェースEventで宣言されたフィールド

    AT_TARGET, BUBBLING_PHASE, CAPTURING_PHASE
    修飾子と型
    フィールド
    説明
    static final short
    AT_TARGET
    イベントは現在、ターゲットEventTargetで評価されています。
    static final short
    BUBBLING_PHASE
    現在のイベント・フェーズはバブリング・フェーズです。
    static final short
    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, 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の値を初期化する場合に使用します。

    インタフェースEventで宣言されたメソッド

    getBubbles, getCancelable, getCurrentTarget, getEventPhase, getTarget, getTimeStamp, getType, initEvent, preventDefault, stopPropagation
    修飾子と型
    メソッド
    説明
    boolean
    getBubbles()
    イベントがバブルするイベントであるかどうかを示す場合に使用します。
    boolean
    getCancelable()
    イベントがデフォルト・アクションを抑制できるかどうかを示す場合に使用します。
    EventTarget
    getCurrentTarget()
    現在EventListenersを処理しているEventTargetを示す場合に使用します。
    short
    getEventPhase()
    現在、どのイベント・フローのフェーズが評価されているかを示す場合に使用します。
    EventTarget
    getTarget()
    イベントが最初にディスパッチされたEventTargetを示す場合に使用します。
    long
    getTimeStamp()
    イベントを作成した時間(元期に関してはミリ秒)を指定する場合に使用します。
    String
    getType()
    大文字と小文字を区別しないイベント名。
    void
    initEvent(String eventTypeArg, boolean canBubbleArg, boolean cancelableArg)
    initEventメソッドは、DocumentEventインタフェースによって作成されるEventの値を初期化する場合に使用します。
    void
    preventDefault()
    イベントが取消し可能である場合、preventDefaultメソッドを使用してイベントが取り消されることを示します。つまり、イベントの結果として実装によって通常実行されるデフォルト・アクションは発生しません。
    void
    stopPropagation()
    stopPropagationメソッドは、イベント・フロー中にこれ以上イベントが伝播しないようにするときに使用します。

    インタフェースで宣言されたメソッド UIEvent

    getDetail, getView, initUIEvent
    修飾子と型
    メソッド
    説明
    int
    getDetail()
    Eventに関する何らかの詳細情報をイベントの型に応じて指定します。
    AbstractView
    getView()
    view属性は、イベントが生成されたAbstractViewを識別します。
    void
    initUIEvent(String typeArg, boolean canBubbleArg, boolean cancelableArg, AbstractView viewArg, int detailArg)
    initUIEventメソッドは、DocumentEventインタフェースによって作成されるUIEventの値を初期化する場合に使用します。

  • メソッドの詳細

    • 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, 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を指定します。