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, MouseWheelEvent

public class MouseEvent
extends InputEvent

コンポーネント内でマウスアクションが発生したことを示すイベントです。マウスアクションは、アクション発生時にマウスカーソルが特定コンポーネントの境界の隠されていない部分上にあるときにのみ、そのコンポーネントで発生したと見なされます。Swing のコンポーネントのような軽量コンポーネントの場合は、そのマウスイベントタイプがコンポーネントで有効になっている場合のみ、マウスイベントがコンポーネントにディスパッチされます。マウスイベントタイプを有効にするには、対応するマウスベースの EventListener をコンポーネント (MouseListener または MouseMotionListener) に追加するか、対応するマスクパラメータ (AWTEvent.MOUSE_EVENT_MASK または AWTEvent.MOUSE_MOTION_EVENT_MASK) を指定して Component.enableEvents(long) を呼び出します。マウスイベントタイプがコンポーネントで有効になっていない場合、対応するマウスイベントは、そのマウスイベントタイプが有効になっている最初の祖先にディスパッチされます。

たとえば、MouseListener をコンポーネントに追加したか、enableEvents(AWTEvent.MOUSE_EVENT_MASK) を呼び出した場合は、MouseListener で定義されているすべてのイベントがコンポーネントにディスパッチされます。一方、MouseMotionListener が追加されておらず、AWTEvent.MOUSE_MOTION_EVENT_MASK を指定して enableEvents が呼び出されていない場合は、マウスモーションイベントはコンポーネントにディスパッチされません。マウスモーションイベントは代わりに、マウスモーションイベントが有効になっている最初の祖先にディスパッチされます。

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

• マウスイベント
  • マウスボタンを押す
  • マウスボタンを離す
  • マウスボタンをクリックする (押してから離す)
  • マウスカーソルがコンポーネントのジオメトリの隠されていない部分に入る
  • マウスカーソルがコンポーネントのジオメトリの隠されていない部分から出る
• マウスモーションイベント
  • マウスを移動する
  • マウスをドラッグする

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

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

マウスボタンをクリックするとイベントが生成され、登録されている MouseListener に送られます。モーダルキーの状態は、InputEvent.getModifiers() および InputEvent.getModifiersEx() を使って取得できます。InputEvent.getModifiers() によって返されたボタンマスクは、すべてのボタンの現在の状態ではなく、状態が変更されたボタンのみを反映します。(なお、ALT_MASK/BUTTON2_MASK および META_MASK/BUTTON3_MASK の値がオーバーラップするため、修飾キーが関連するマウスイベントの場合は、これが常にあてはまるわけではありません)。すべてのボタンおよび修飾キーの状態を取得するには、InputEvent.getModifiersEx() を使用します。状態が変更されたボタンは getButton() により返されます。

たとえば、マウスの第 1 ボタンを押すと、イベントは次の順序で送信されます。

    id              modifiers    button 
    MOUSE_PRESSED:  BUTTON1_MASK BUTTON1
    MOUSE_RELEASED: BUTTON1_MASK BUTTON1
    MOUSE_CLICKED:  BUTTON1_MASK BUTTON1
 

複数のマウスボタンを押した場合は、各ボタンのプレス、リリース、クリックに対して個別のイベントが生成されます。

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

    id              modifiers    button 
    MOUSE_PRESSED:  BUTTON1_MASK BUTTON1
    MOUSE_PRESSED:  BUTTON2_MASK BUTTON2
    MOUSE_RELEASED: BUTTON1_MASK BUTTON1
    MOUSE_CLICKED:  BUTTON1_MASK BUTTON1
    MOUSE_RELEASED: BUTTON2_MASK BUTTON2
    MOUSE_CLICKED:  BUTTON2_MASK BUTTON2
 

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

マウスボタンが追加され、BUTTON1、BUTTON2、および BUTTON3 の定数で表されるボタンの標準セットが拡張されます。追加のボタンには、割り当てられた BUTTONx 定数はなく、そのボタンマスクには、割り当てられた BUTTONx_DOWN_MASK 定数はありません。ただし、4 から始まる序数をボタン番号 (ボタン ID) として使用できます。getMaskForButton(button) メソッドによって取得される値は、ボタンマスクとして使用できます。

MOUSE_DRAGGED イベントは、マウスのボタンを離すまで、マウスのボタンが押された Component に (マウスの位置がその Component の境界内にあるかどうかに関係なく) 継続して送られます。ドラッグ&ドロップの実装はプラットフォームによって異なるため、ネイティブのドラッグ&ドロップの操作中に MOUSE_DRAGGED イベントは転送されません。 マルチスクリーン環境の場合には、マウスの位置がその Component に関連付けられた GraphicsConfiguration の境界の外側にある場合でも、マウスドラッグイベントは Component に送られます。ただし、この場合のマウスドラッグイベントで報告されるマウスの位置は、実際のマウスの位置と異なることがあります。

• 仮想デバイスのないマルチスクリーン環境の場合
  マウスドラッグイベントで報告された座標はクリッピングされ、Component に関連付けられた GraphicsConfiguration の境界内に収められる。
• 仮想デバイスを持つマルチスクリーン環境の場合
  マウスドラッグイベントで報告された座標はクリッピングされ、Component に関連付けられた仮想デバイスの境界内に収められる。

特定の MouseEvent インスタンスの id パラメータが MOUSE_FIRST から MOUSE_LAST までの範囲にない場合に、未指定の動作が発生します (MOUSE_WHEEL は受け入れられません)。

導入されたバージョン:

1.1

関連項目:

MouseAdapter, MouseListener, MouseMotionAdapter, MouseMotionListener, MouseWheelListener, Tutorial: Writing a Mouse Listener, Tutorial: Writing a Mouse Motion Listener, 直列化された形式

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static int	BUTTON1 マウスボタン 1 を示します。getButton() によって使用されます。
static int	BUTTON2 マウスボタン 2 を示します。getButton() によって使用されます。
static int	BUTTON3 マウスボタン 3 を示します。getButton() によって使用されます。
static int	MOUSE_CLICKED 「マウスクリック」イベントです。
static int	MOUSE_DRAGGED 「マウドラッグ」イベントです。
static int	MOUSE_ENTERED 「フォーカス取得」イベントです。
static int	MOUSE_EXITED 「フォーカス喪失」イベントです。
static int	MOUSE_FIRST マウスイベントに使用される ID の範囲内の最初の番号です。
static int	MOUSE_LAST マウスイベントに使用される ID の範囲内の最後の番号です。
static int	MOUSE_MOVED 「マウス移動」イベントです。
static int	MOUSE_PRESSED 「マウスプレス」イベントです。
static int	MOUSE_RELEASED 「マウスリリース」イベントです。
static int	MOUSE_WHEEL 「マウスホイール」イベントです。
static int	NOBUTTON マウスボタンなしを示します。getButton() によって使用されます。

クラス java.awt.event.InputEvent から継承されるフィールド

ALT_DOWN_MASK, ALT_GRAPH_DOWN_MASK, ALT_GRAPH_MASK, ALT_MASK, BUTTON1_DOWN_MASK, BUTTON1_MASK, BUTTON2_DOWN_MASK, BUTTON2_MASK, BUTTON3_DOWN_MASK, BUTTON3_MASK, CTRL_DOWN_MASK, CTRL_MASK, META_DOWN_MASK, META_MASK, SHIFT_DOWN_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, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

クラス java.util.EventObject から継承されたフィールド

source

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger) 指定されたソースコンポーネント、型、修飾子、座標、クリックカウント、popupTrigger フラグで、MouseEvent オブジェクトを構築します。
MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int clickCount, boolean popupTrigger, int button) 指定されたソースコンポーネント、型、時間、修飾子、座標、クリックカウント、popupTrigger フラグ、ボタン番号で、MouseEvent オブジェクトを構築します。
MouseEvent(Component source, int id, long when, int modifiers, int x, int y, int xAbs, int yAbs, int clickCount, boolean popupTrigger, int button) 指定されたソースコンポーネント、型、時間、修飾子、座標、絶対座標、クリックカウント、popupTrigger フラグ、ボタン番号で、MouseEvent オブジェクトを構築します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
int	getButton() 状態が変更されたマウスボタンがある場合、そのマウスボタンを返します。
int	getClickCount() このイベントに関連付けられたマウスクリック数を返します。
Point	getLocationOnScreen() イベントの絶対 x、y 座標を返します。
int	getModifiersEx() このイベントの拡張修飾子マスクを返します。
static String	getMouseModifiersText(int modifiers) イベントの発生時に押されていた「Shift」キーや「Ctrl+Shift」キーなどの修飾キーやマウスボタンを記述する String インスタンスを返します。
Point	getPoint() ソースコンポーネントを基準とする、イベントの相対 x、y 座標を返します。
int	getX() ソースコンポーネントを基準とする、イベントの相対 x 座標 (水平方向) を返します。
int	getXOnScreen() イベントの絶対 x 座標 (水平方向) を返します。
int	getY() ソースコンポーネントを基準とする、イベントの相対 y 座標 (垂直方向) を返します。
int	getYOnScreen() イベントの絶対 y 座標 (垂直方向) を返します。
boolean	isPopupTrigger() このマウスイベントが、そのプラットフォームのポップアップメニュートリガーイベントであるかどうかを返します。
String	paramString() このイベントを特定するパラメータ文字列を返します。
void	translatePoint(int x, int y) 指定された x (水平方向) および y (垂直方向) オフセットを加算することにより、イベントの座標を新しい位置に変換します。

クラス java.awt.event.InputEvent から継承されるメソッド

consume, getMaskForButton, getModifiers, getModifiersExText, getWhen, isAltDown, isAltGraphDown, isConsumed, isControlDown, isMetaDown, isShiftDown

クラス java.awt.event.ComponentEvent から継承されるメソッド

getComponent

クラス java.awt.AWTEvent から継承されるメソッド

getID, setSource, toString

クラス java.util.EventObject から継承されたメソッド

getSource

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

フィールドの詳細

MOUSE_FIRST

public static final int MOUSE_FIRST

マウスイベントに使用される ID の範囲内の最初の番号です。

関連項目:

定数フィールド値

MOUSE_LAST

public static final int MOUSE_LAST

マウスイベントに使用される ID の範囲内の最後の番号です。

関連項目:

定数フィールド値

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

「マウス移動」イベントです。この MouseEvent は、マウスの位置を変更すると発生します。

関連項目:

定数フィールド値

MOUSE_ENTERED

public static final int MOUSE_ENTERED

「フォーカス取得」イベントです。この MouseEvent は、マウスカーソルがコンポーネントのジオメトリの隠されていない部分に入ると発生します。

関連項目:

定数フィールド値

MOUSE_EXITED

public static final int MOUSE_EXITED

「フォーカス喪失」イベントです。この MouseEvent は、マウスカーソルがコンポーネントのジオメトリの隠されていない部分から出ると発生します。

関連項目:

定数フィールド値

MOUSE_DRAGGED

public static final int MOUSE_DRAGGED

「マウドラッグ」イベントです。この MouseEvent は、マウスボタンを押している間にマウスの位置が変更されると発生します。

関連項目:

定数フィールド値

MOUSE_WHEEL

public static final int MOUSE_WHEEL

「マウスホイール」イベントです。これは、MouseWheelEvent のみです。ホイール付きマウスのホイールを回転させると発生します。

導入されたバージョン:

1.4

関連項目:

定数フィールド値

NOBUTTON

public static final int NOBUTTON

マウスボタンなしを示します。getButton() によって使用されます。

導入されたバージョン:

1.4

関連項目:

定数フィールド値

BUTTON1

public static final int BUTTON1

マウスボタン 1 を示します。getButton() によって使用されます。

導入されたバージョン:

1.4

関連項目:

定数フィールド値

BUTTON2

public static final int BUTTON2

マウスボタン 2 を示します。getButton() によって使用されます。

導入されたバージョン:

1.4

関連項目:

定数フィールド値

BUTTON3

public static final int BUTTON3

マウスボタン 3 を示します。getButton() によって使用されます。

導入されたバージョン:

1.4

関連項目:

定数フィールド値

コンストラクタの詳細

MouseEvent

public MouseEvent(Component source,
          int id,
          long when,
          int modifiers,
          int x,
          int y,
          int clickCount,
          boolean popupTrigger,
          int button)

指定されたソースコンポーネント、型、時間、修飾子、座標、クリックカウント、popupTrigger フラグ、ボタン番号で、MouseEvent オブジェクトを構築します。

無効なイベントを作成すると (複数の old _MASK、または一致しない修飾子/ボタン値を使用するなどによって)、未指定の動作が発生します。MouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger, button) の形式で呼び出した場合、 MouseEvent(source, id, when, modifiers, x, y, xAbs, yAbs, clickCount, popupTrigger, button) の呼び出しとまったく同じように動作します。この xAbs と yAbs は、画面上のソースの位置に相対座標 x と y を加算した値として定義されます。ソースコンポーネントが表示されていない場合、xAbs と yAbs は 0 に設定されます。このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントを発生させた Component

id - イベントのタイプを示す整数。許容される値については、MouseEvent のクラスの説明を参照してください。

when - イベントが発生した時間を渡す long 整数。負またはゼロの値を渡すことはお勧めできません

modifiers - イベント発生時に押された修飾キー (Shift、Ctrl、Alt、Meta など)。負の値のパラメータを渡すことはお勧めできません。ゼロの値は修飾子が渡されなかったことを意味します。拡張された _DOWN_MASK 修飾子か古い _MASK 修飾子を使用しますが、1 つのイベントでモデルを混合しないでください。拡張修飾子の使用が推奨されます。

x - マウス位置の x 座標 (水平方向)。負の値を渡すことができます

y - マウス位置の y 座標 (垂直方向)。負の値を渡すことができます

clickCount - イベントに関連付けられたマウスクリックの回数。負の値を渡すことはお勧めできません

popupTrigger - boolean 型。このイベントがポップアップメニューのトリガーである場合は true

button - 状態が変更されたマウスボタンを示す整数。このパラメータには次の規則が適用されます。

• 拡張マウスボタンのサポートが Java で disabled にされている場合、NOBUTTON、BUTTON1、BUTTON2、BUTTON3 の標準ボタンによってのみ、MouseEvent オブジェクトを作成できます。
• 拡張マウスボタンのサポートが Java で enabled にされている場合、標準ボタンによって MouseEvent オブジェクトを作成できます。拡張マウスボタンのサポートが Java で enabled にされている場合、標準ボタンに加えて、マウスに 4 つ以上のボタンがある場合に、4 から MouseInfo.getNumberOfButtons() の範囲のボタンを使用して、MouseEvent オブジェクトを作成できます。

例外:

IllegalArgumentException - button がゼロより小さい場合

IllegalArgumentException - source が null である場合

IllegalArgumentException - button が BUTTON3 より大きく、拡張マウスボタンのサポートが Java で disabled にされている場合

IllegalArgumentException - button が current number of buttons より大きく、拡張マウスボタンのサポートが Java で enabled にされている場合

IllegalArgumentException - 無効な button 値が渡された場合

IllegalArgumentException - source が null である場合

導入されたバージョン:

1.4

関連項目:

EventObject.getSource(), AWTEvent.getID(), InputEvent.getWhen(), InputEvent.getModifiers(), getX(), getY(), getClickCount(), isPopupTrigger(), getButton()

MouseEvent

public MouseEvent(Component source,
          int id,
          long when,
          int modifiers,
          int x,
          int y,
          int clickCount,
          boolean popupTrigger)

指定されたソースコンポーネント、型、修飾子、座標、クリックカウント、popupTrigger フラグで、MouseEvent オブジェクトを構築します。MouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger, popupTrigger) の形式で呼び出した場合、 MouseEvent(source, id, when, modifiers, x, y, xAbs, yAbs, clickCount, popupTrigger, MouseEvent.NOBUTTON) の呼び出しとまったく同じように動作します。この xAbs と yAbs は、画面上のソースの位置に相対座標 x と y を加算した値として定義されます。ソースコンポーネントが表示されていない場合、xAbs と yAbs は 0 に設定されます。このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントを発生させた Component

id - イベントのタイプを示す整数。許容される値については、MouseEvent のクラスの説明を参照してください。

when - イベントが発生した時間を渡す long 整数。負またはゼロの値を渡すことはお勧めできません

modifiers - イベント発生時に押された修飾キー (Shift、Ctrl、Alt、Meta など)。負の値のパラメータを渡すことはお勧めできません。ゼロの値は修飾子が渡されなかったことを意味します。拡張された _DOWN_MASK 修飾子か古い _MASK 修飾子を使用しますが、1 つのイベントでモデルを混合しないでください。拡張修飾子の使用が推奨されます。

x - マウス位置の x 座標 (水平方向)。負の値を渡すことができます

y - マウス位置の y 座標 (垂直方向)。負の値を渡すことができます

clickCount - イベントに関連付けられたマウスクリックの回数。負の値を渡すことはお勧めできません

popupTrigger - boolean 型。このイベントがポップアップメニューのトリガーである場合は true

例外:

IllegalArgumentException - source が null である場合

関連項目:

EventObject.getSource(), AWTEvent.getID(), InputEvent.getWhen(), InputEvent.getModifiers(), getX(), getY(), getClickCount(), isPopupTrigger()

MouseEvent

public MouseEvent(Component source,
          int id,
          long when,
          int modifiers,
          int x,
          int y,
          int xAbs,
          int yAbs,
          int clickCount,
          boolean popupTrigger,
          int button)

指定されたソースコンポーネント、型、時間、修飾子、座標、絶対座標、クリックカウント、popupTrigger フラグ、ボタン番号で、MouseEvent オブジェクトを構築します。

無効なイベントを作成すると (複数の old _MASK、または一致しない修飾子/ボタン値を使用するなどによって)、未指定の動作が発生します。コンストラクタに渡された相対座標と絶対座標の値が矛盾している場合でも MouseEvent インスタンスは作成され、例外はスローされません。このメソッドは source が null の場合に IllegalArgumentException をスローします。

パラメータ:

source - イベントを発生させた Component

id - イベントのタイプを示す整数。許容される値については、MouseEvent のクラスの説明を参照してください。

when - イベントが発生した時間を渡す long 整数。負またはゼロの値を渡すことはお勧めできません

modifiers - イベント発生時に押された修飾キー (Shift、Ctrl、Alt、Meta など)。負の値のパラメータを渡すことはお勧めできません。ゼロの値は修飾子が渡されなかったことを意味します。拡張された _DOWN_MASK 修飾子か古い _MASK 修飾子を使用しますが、1 つのイベントでモデルを混合しないでください。拡張修飾子の使用が推奨されます。

x - マウス位置の x 座標 (水平方向)。負の値を渡すことができます

y - マウス位置の y 座標 (垂直方向)。負の値を渡すことができます

xAbs - マウス位置の絶対 x 座標 (水平方向)。負の値を渡すことができます

yAbs - マウス位置の絶対 y 座標 (垂直方向)。負の値を渡すことができます

clickCount - イベントに関連付けられたマウスクリックの回数。負の値を渡すことはお勧めできません

popupTrigger - boolean 型。このイベントがポップアップメニューのトリガーである場合は true

button - 状態が変更されたマウスボタンを示す整数。このパラメータには次の規則が適用されます。

• 拡張マウスボタンのサポートが Java で disabled にされている場合、NOBUTTON、BUTTON1、BUTTON2、BUTTON3 の標準ボタンによってのみ、MouseEvent オブジェクトを作成できます。
• 拡張マウスボタンのサポートが Java で enabled にされている場合、標準ボタンによって MouseEvent オブジェクトを作成できます。拡張マウスボタンのサポートが Java で enabled にされている場合、標準ボタンに加えて、マウスに 4 つ以上のボタンがある場合に、4 から MouseInfo.getNumberOfButtons() の範囲のボタンを使用して、MouseEvent オブジェクトを作成できます。

例外:

IllegalArgumentException - button がゼロより小さい場合

IllegalArgumentException - source が null である場合

IllegalArgumentException - button が BUTTON3 より大きく、拡張マウスボタンのサポートが Java で disabled にされている場合

IllegalArgumentException - button が current number of buttons より大きく、拡張マウスボタンのサポートが Java で enabled にされている場合

IllegalArgumentException - 無効な button 値が渡された場合

IllegalArgumentException - source が null である場合

導入されたバージョン:

1.6

関連項目:

EventObject.getSource(), AWTEvent.getID(), InputEvent.getWhen(), InputEvent.getModifiers(), getX(), getY(), getXOnScreen(), getYOnScreen(), getClickCount(), isPopupTrigger(), getButton(), button, Toolkit.areExtraMouseButtonsEnabled(), MouseInfo.getNumberOfButtons(), InputEvent.getMaskForButton(int)

メソッドの詳細

getLocationOnScreen

public Point getLocationOnScreen()

イベントの絶対 x、y 座標を返します。デスクトップ領域が複数の物理画面デバイスにまたがっている可能性のある仮想デバイスマルチスクリーン環境では、これらの座標は仮想の座標系を基準にしています。それ以外の場合、これらの座標は、コンポーネントの GraphicsConfiguration に関連付けられた座標系を基準にしています。

戻り値:

絶対 X 座標と絶対 Y 座標を含む Point オブジェクト。

導入されたバージョン:

1.6

関連項目:

GraphicsConfiguration

getXOnScreen

public int getXOnScreen()

イベントの絶対 x 座標 (水平方向) を返します。デスクトップ領域が複数の物理画面デバイスにまたがっている可能性のある仮想デバイスマルチスクリーン環境では、この座標は仮想の座標系を基準にしています。それ以外の場合、この座標は、コンポーネントの GraphicsConfiguration に関連付けられた座標系を基準にしています。

戻り値:

x 水平方向の絶対位置を示す整数

導入されたバージョン:

1.6

関連項目:

GraphicsConfiguration

getYOnScreen

public int getYOnScreen()

イベントの絶対 y 座標 (垂直方向) を返します。デスクトップ領域が複数の物理画面デバイスにまたがっている可能性のある仮想デバイスマルチスクリーン環境では、この座標は仮想の座標系を基準にしています。それ以外の場合、この座標は、コンポーネントの GraphicsConfiguration に関連付けられた座標系を基準にしています。

戻り値:

y 垂直方向の絶対位置を示す整数

導入されたバージョン:

1.6

関連項目:

GraphicsConfiguration

getModifiersEx

public int getModifiersEx()

このイベントの拡張修飾子マスクを返します。拡張修飾子は、イベントが発生した直後の Alt、Ctrl、Meta キーやマウスボタンなど、すべてのモーダルキーの状態を表します。

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

    MOUSE_PRESSED:  BUTTON1_DOWN_MASK
    MOUSE_PRESSED:  BUTTON1_DOWN_MASK | BUTTON2_DOWN_MASK
    MOUSE_RELEASED: BUTTON2_DOWN_MASK
    MOUSE_CLICKED:  BUTTON2_DOWN_MASK
    MOUSE_RELEASED:
    MOUSE_CLICKED:
 

今後、新しい修飾子が追加される可能性があるため、== を使用してこのメソッドの戻り値を比較することは推奨されません。たとえば、次のコードにより、Shift キーと Button 1 を押して Ctrl キーを離したことをチェックできます。

    int onmask = SHIFT_DOWN_MASK | BUTTON1_DOWN_MASK;
    int offmask = CTRL_DOWN_MASK;
    if ((event.getModifiersEx() & (onmask | offmask)) == onmask) {
        ...
    }
 

上記のコードは、新しい修飾子が追加されても動作します。

オーバーライド:

getModifiersEx、クラス: InputEvent

getX

public int getX()

ソースコンポーネントを基準とする、イベントの相対 x 座標 (水平方向) を返します。

戻り値:

x コンポーネントを基準とする水平位置を示す整数

getY

public int getY()

ソースコンポーネントを基準とする、イベントの相対 y 座標 (垂直方向) を返します。

戻り値:

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()

このイベントに関連付けられたマウスクリック数を返します。

戻り値:

クリック数を表す整数値

getButton

public int getButton()

状態が変更されたマウスボタンがある場合、そのマウスボタンを返します。戻り値の範囲は、0 から MouseInfo.getNumberOfButtons() 値です。戻り値には、少なくとも次の定数が含まれます。

• NOBUTTON
• BUTTON1
• BUTTON2
• BUTTON3

これらの定数を使用して、アプリケーションで返されたボタン番号と比較できます。例:

 if (anEvent.getButton() == MouseEvent.BUTTON1) {
 

特に、ボタンが 1、2、または 3 つのマウスの場合は、このメソッドによって次の値が返されます。

• 0 (NOBUTTON)
• 1 (BUTTON1)
• 2 (BUTTON2)
• 3 (BUTTON3)

BUTTON3 より大きいボタン番号には、定数識別子はありません。したがって、ボタンが 5 つのマウスがインストールされている場合は、このメソッドによって次の値が返されます。

• 0 (NOBUTTON)
• 1 (BUTTON1)
• 2 (BUTTON2)
• 3 (BUTTON3)
• 4
• 5

注:拡張マウスボタンのサポートが Java で disabled にされている場合、AWT イベントサブシステムでは拡張マウスボタンのマウスイベントは発生しません。したがって、このメソッドが NOBUTTON、BUTTON1、BUTTON2、BUTTON3 以外を返すことはありません。

戻り値:

拡張マウスボタンのサポートが Java で enabled にされている場合は、0 から MouseInfo.getNumberOfButtons() 値のいずれか。拡張マウスボタンのサポートが Java で disabled にされている場合は、この範囲には NOBUTTON、BUTTON1、BUTTON2、BUTTON3、
NOBUTTON、BUTTON1、BUTTON2、または BUTTON3 が含まれます。

導入されたバージョン:

1.4

関連項目:

Toolkit.areExtraMouseButtonsEnabled(), MouseInfo.getNumberOfButtons(), MouseEvent(Component, int, long, int, int, int, int, int, int, boolean, int), InputEvent.getMaskForButton(int)

isPopupTrigger

public boolean isPopupTrigger()

このマウスイベントが、そのプラットフォームのポップアップメニュートリガーイベントであるかどうかを返します。

注:ポップアップメニューのトリガーはシステムによって異なります。したがって、クロスプラットフォームを適切に機能させるために、mousePressed および mouseReleased の両方で isPopupTrigger をチェックすることをお勧めします。

戻り値:

boolean 型。このイベントがこのプラットフォームのポップアップメニュートリガーである場合は true

getMouseModifiersText

public static String getMouseModifiersText(int modifiers)

イベントの発生時に押されていた「Shift」キーや「Ctrl+Shift」キーなどの修飾キーやマウスボタンを記述する String インスタンスを返します。これらの文字列は awt.properties ファイルを変更することによりローカライズが可能です。

InputEvent.ALT_MASK と InputEvent.BUTTON2_MASK は同じ値になるため、どちらの修飾子に対しても文字列「Alt」が返されます。同様に、InputEvent.META_MASK と InputEvent.BUTTON3_MASK は同じ値になるため、どちらの修飾子に対しても文字列「Meta」が返されます。

負の値のパラメータを渡すことは誤りであり、未指定の文字列が返されます。ゼロのパラメータは修飾子が渡されていないことを示し、空の文字列が返されます。

パラメータ:

modifiers - イベントの発生時に押されていた修飾キーおよびマウスボタンを記述する修飾子マスク

戻り値:

文字列 イベント発生時に押されていた修飾キーおよびマウスボタンの組み合わせを記述するテキスト文字列

導入されたバージョン:

1.4

関連項目:

InputEvent.getModifiersExText(int)

paramString

public String paramString()

このイベントを特定するパラメータ文字列を返します。このメソッドは、イベントログの作成およびデバッグに便利です。

オーバーライド:

paramString、クラス: ComponentEvent

戻り値:

イベントを特定する文字列とその属性