JavaTM 2 Platform
Std. Ed. v1.3

java.awt.event
クラス MouseEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--java.awt.AWTEvent
              |
              +--java.awt.event.ComponentEvent
                    |
                    +--java.awt.event.InputEvent
                          |
                          +--java.awt.event.MouseEvent
すべての実装インタフェース:
Serializable
直系の既知のサブクラス:
MenuDragMouseEvent

public class MouseEvent
extends InputEvent

コンポーネント内でマウスアクションが発生したことを示すイベントです。このイベントは、マウスイベント (クリックおよびコンポーネントへの出入り) とマウスモーションイベント (移動とドラッグ) の両方に使用されます。

このイベントはコンポーネントオブジェクトによって生成される低レベルイベントであり、次の場合に生成されます。

MouseEvent オブジェクトは、コンポーネントの addMouseListner メソッドを使って、関連するマウスイベントを受け取るように登録されているすべての MouseListener オブジェクトまたは MouseAdapter オブジェクトに渡されます。MouseAdapter オブジェクトは、MouseListener インタフェースを実装しています。各リスナーオブジェクトは、マウスイベントが入っている MouseEvent を取得します。

また、MouseEvent オブジェクトは、コンポーネントの addMouseMotionListner メソッドを使って、マウスモーションイベントを受け取るように登録されているすべての MouseMotionListener オブジェクトまたは MouseMotionAdapter オブジェクトに渡されます。MouseMotionAdapter オブジェクトは、MouseMotionListener インタフェースを実装しています。各リスナーオブジェクトは、マウスモーションイベントが入っている MouseEvent を取得します。

マウスボタンがクリックされるとイベントが生成され、修飾子フィールドに設定されたボタンマスクとともに、登録されている MouseListener に送られます。たとえば、マウスボタン 1 が押されると、イベントが次の順序で送られます。

    MOUSE_PRESSED:  BUTTON1_MASK
    MOUSE_RELEASED: BUTTON1_MASK
    MOUSE_CLICKED:  BUTTON1_MASK
 
複数のマウスボタンが押された場合は、それぞれのプレス、リリース、クリックに対して個別のイベントが生成されます。修飾子フィールドのボタンマスクは、すべてのボタンの現在の状態ではなく、状態が変更されたボタンのみを反映します。

たとえば、ユーザがボタン 1 に続いてボタン 2 を押し、同じ順序でボタンを離した場合、次の一連のイベントが生成されます。

    MOUSE_PRESSED:  BUTTON1_MASK
    MOUSE_PRESSED:  BUTTON2_MASK
    MOUSE_RELEASED: BUTTON1_MASK
    MOUSE_CLICKED:  BUTTON1_MASK
    MOUSE_RELEASED: BUTTON2_MASK
    MOUSE_CLICKED:  BUTTON2_MASK
 
ボタン 2 が先に離された場合には、BUTTON2_MASK の MOUSE_RELEASED/MOUSE_CLICKED のペアが先に生成され、そのあとに BUTTON1_MASK の MOUSE_RELEASED/MOUSE_CLICKED のペアが生成されます。

導入されたバージョン:
1.1
関連項目:
MouseAdapter, MouseListener, MouseMotionAdapter, MouseMotionListener, 「Tutorial: Writing a Mouse Listener」, 「Tutorial: Writing a Mouse Motion Listener」, 「参照: Java クラスライブラリ (更新ファイル)」, 直列化された形式

フィールドの概要
static int MOUSE_CLICKED
          「マウスクリック」イベントです。
static int MOUSE_DRAGGED
          「マウスドラッグ」イベントです。
static int MOUSE_ENTERED
          「マウスエンター」イベントです。
static int MOUSE_EXITED
          「マウスイグジット」イベントです。
static int MOUSE_FIRST
          マウスイベント識別子に使う整数の範囲にある、最初の番号です。
static int MOUSE_LAST
          マウスイベント識別子に使う整数の範囲にある、最後の番号です。
static int MOUSE_MOVED
          「マウスムーブ」イベントです。
static int MOUSE_PRESSED
          「マウスプレス」イベントです。
static int MOUSE_RELEASED
          「マウスリリース」イベントです。
 
クラス java.awt.event.InputEvent から継承したフィールド
ALT_GRAPH_MASK, ALT_MASK, BUTTON1_MASK, BUTTON2_MASK, BUTTON3_MASK, CTRL_MASK, META_MASK, SHIFT_MASK
 
クラス java.awt.event.ComponentEvent から継承したフィールド
COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN
 
クラス java.awt.AWTEvent から継承したフィールド
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK
 
クラス java.util.EventObject から継承したフィールド
source
 
コンストラクタの概要
MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger)
          指定された発生元のコンポーネント、タイプ、修飾子、座標、クリックカウントで、MouseEvent オブジェクトを構築します。
 
メソッドの概要
 int getClickCount()
          このイベントに関連したマウスクリック数を返します。
 Point getPoint()
          イベントの、発生元のコンポーネントに相対的な x、y 座標値を返します。
 int getX()
          イベントが発生した位置の X 座標を発生元のコンポーネントに対する相対位置で返します。
 int getY()
          イベントが発生した位置の Y 座標を発生元のコンポーネントに対する相対位置で返します。
 boolean isPopupTrigger()
          このマウスイベントが、そのプラットフォームのポップアップメニュートリガーイベントであるかどうかを返します。
 String paramString()
          このイベントを特定するパラメータの文字列を返します。
 void translatePoint(int x, int y)
          指定されたオフセットの x (水平方向) および y (垂直方向) を加算することにより、イベントの座標を新しい位置に移動します。
 
クラス java.awt.event.InputEvent から継承したメソッド
consume, getModifiers, getWhen, isAltDown, isAltGraphDown, isConsumed, isControlDown, isMetaDown, isShiftDown
 
クラス java.awt.event.ComponentEvent から継承したメソッド
getComponent
 
クラス java.awt.AWTEvent から継承したメソッド
finalize, getID, toString
 
クラス java.util.EventObject から継承したメソッド
getSource
 
クラス java.lang.Object から継承したメソッド
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

MOUSE_FIRST

public static final int MOUSE_FIRST
マウスイベント識別子に使う整数の範囲にある、最初の番号です。

MOUSE_LAST

public static final int MOUSE_LAST
マウスイベント識別子に使う整数の範囲にある、最後の番号です。

MOUSE_CLICKED

public static final int MOUSE_CLICKED
「マウスクリック」イベントです。この MouseEvent は、マウスボタンが押されてから離されると発生します。

MOUSE_PRESSED

public static final int MOUSE_PRESSED
「マウスプレス」イベントです。この MouseEvent は、マウスボタンが押されると発生します。

MOUSE_RELEASED

public static final int MOUSE_RELEASED
「マウスリリース」イベントです。この MouseEvent は、マウスボタンが離されると発生します。

MOUSE_MOVED

public static final int MOUSE_MOVED
「マウスムーブ」イベントです。この MouseMotionEvent は、マウスの位置が変更されると発生します。

MOUSE_ENTERED

public static final int MOUSE_ENTERED
「マウスエンター」イベントです。この MouseMotionEvent は、マウスがコンポーネント領域に入ると発生します。

MOUSE_EXITED

public static final int MOUSE_EXITED
「マウスイグジット」イベントです。この MouseMotionEvent は、マウスがコンポーネント領域から出ると発生します。

MOUSE_DRAGGED

public static final int MOUSE_DRAGGED
「マウスドラッグ」イベントです。この MouseMotionEvent は、「ドラッグ」修飾子 (Shift キーなど) がアクティブなときに、マウスの位置が変更されると発生します。
コンストラクタの詳細

MouseEvent

public MouseEvent(Component source,
                  int id,
                  long when,
                  int modifiers,
                  int x,
                  int y,
                  int clickCount,
                  boolean popupTrigger)
指定された発生元のコンポーネント、タイプ、修飾子、座標、クリックカウントで、MouseEvent オブジェクトを構築します。
パラメータ:
source - イベントの発生元のコンポーネント
id - イベントを特定する整数型
when - イベントが発生した時刻を指定する long int 値
modifiers - イベント発生時に押された修飾キー (Shift、Ctrl、Alt、メタ)
x - マウス位置の X 座標 (水平方向)
y - マウス位置の Y 座標 (垂直方向)
clickCount - イベントに関連したマウスクリックの回数
popupTrigger - boolean 型。ポップアップメニューに対するイベントの場合は true
メソッドの詳細

getX

public int getX()
イベントが発生した位置の X 座標を発生元のコンポーネントに対する相対位置で返します。
戻り値:
x コンポーネントを基準とする水平位置を示す整数型

getY

public int getY()
イベントが発生した位置の Y 座標を発生元のコンポーネントに対する相対位置で返します。
戻り値:
コンポーネントを基準とする垂直位置を示す整数

getPoint

public Point getPoint()
イベントの、発生元のコンポーネントに相対的な x、y 座標値を返します。
戻り値:
発生元のコンポーネントを基準とする X 座標および Y 座標を持つ Point オブジェクト

translatePoint

public void translatePoint(int x,
                           int y)
指定されたオフセットの x (水平方向) および y (垂直方向) を加算することにより、イベントの座標を新しい位置に移動します。
パラメータ:
x - 現在の X 座標に加算される x (水平方向) の値
y - 現在の Y 座標に加算される y (垂直方向) の値

getClickCount

public int getClickCount()
このイベントに関連したマウスクリック数を返します。
戻り値:
クリック数を表す整数型の値

isPopupTrigger

public boolean isPopupTrigger()
このマウスイベントが、そのプラットフォームのポップアップメニュートリガーイベントであるかどうかを返します。
戻り値:
boolean 型。イベントがこのプラットフォームのポップアップメニュートリガーイベントである場合は true

paramString

public String paramString()
このイベントを特定するパラメータの文字列を返します。このメソッドは、イベントログの作成およびデバッグに使用します。
オーバーライド:
クラス ComponentEvent 内の paramString
戻り値:
イベントを特定する文字列とその属性

JavaTM 2 Platform
Std. Ed. v1.3

バグや機能要求の報告
さらに詳しい API リファレンスおよび開発者ドキュメントについては、 Java 2 SDK SE Developer Documentation を参照してください。このドキュメントには、概念、用語の定義、回避策、 実用的なコード例など、開発者を対象にした詳細な解説が掲載されています。

Java、Java 2D、JDBC は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.