モジュール java.desktop

パッケージ java.awt.event

クラスInputEvent

java.lang.Object

java.util.EventObject

java.awt.AWTEvent

java.awt.event.ComponentEvent

java.awt.event.InputEvent

すべての実装されたインタフェース:

Serializable

直系の既知のサブクラス:

KeyEvent, MouseEvent

public abstract sealed class InputEvent extends ComponentEvent permits KeyEvent, MouseEvent

すべてのコンポーネント・レベル入力イベントのルート・イベント・クラスです。 入力イベントは、発生したソースによって正常に処理される前にリスナーに送られます。 このことによって、リスナーとコンポーネント・サブクラスはイベントを「消費」し、ソースがデフォルトの方法でイベントを処理しないようにできます。 たとえば、ButtonコンポーネントのmousePressedイベントを消費することによって、Buttonが起動されないようにします。

シール済クラス階層グラフ:

導入されたバージョン:

1.1

関連項目:

• KeyEvent
• KeyAdapter
• MouseEvent
• MouseAdapter
• MouseMotionAdapter
• 直列化された形式

フィールドのサマリー

フィールド

修飾子と型	フィールド	説明
static final int	ALT_DOWN_MASK	Altキーの拡張修飾子定数です。
static final int	ALT_GRAPH_DOWN_MASK	AltGraphキーの拡張修飾子定数です。
static final int	ALT_GRAPH_MASK	非推奨。 代わりにALT_GRAPH_DOWN_MASKとgetModifiersEx()を使用することをお勧めします
static final int	ALT_MASK	非推奨。 代わりにALT_DOWN_MASKとgetModifiersEx()を使用することをお勧めします
static final int	BUTTON1_DOWN_MASK	Mouse Button1の拡張修飾子定数です。
static final int	BUTTON1_MASK	非推奨。 代わりにBUTTON1_DOWN_MASKとgetModifiersEx()を使用することをお勧めします
static final int	BUTTON2_DOWN_MASK	Mouse Button2の拡張修飾子定数です。
static final int	BUTTON2_MASK	非推奨。 代わりにBUTTON2_DOWN_MASKとgetModifiersEx()を使用することをお勧めします。
static final int	BUTTON3_DOWN_MASK	Mouse Button3の拡張修飾子定数です。
static final int	BUTTON3_MASK	非推奨。 代わりにBUTTON3_DOWN_MASKとgetModifiersEx()を使用することをお勧めします。
static final int	CTRL_DOWN_MASK	Ctrlキーの拡張修飾子定数です。
static final int	CTRL_MASK	非推奨。 代わりにCTRL_DOWN_MASKとgetModifiersEx()を使用することをお勧めします
static final int	META_DOWN_MASK	Metaキーの拡張修飾子定数です。
static final int	META_MASK	非推奨。 代わりにMETA_DOWN_MASKとgetModifiersEx()を使用することをお勧めします
static final int	SHIFT_DOWN_MASK	Shiftキーの拡張修飾子定数です。
static final int	SHIFT_MASK	非推奨。 代わりにSHIFT_DOWN_MASKとgetModifiersEx()を使用することをお勧めします

クラス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

メソッドのサマリー

修飾子と型	メソッド	説明
void	consume()	このイベントを消費して、発生させたソースによりデフォルトの方法で処理されないようにします。
static int	getMaskForButton(int button)	既存のマウス・ボタンのマスクを取得するメソッド。
int	getModifiers()	非推奨。 代わりに拡張修飾キーとgetModifiersEx()を使用することをお勧めします
int	getModifiersEx()	このイベントの拡張修飾子マスクを返します。
static String	getModifiersExText(int modifiers)	「Shift」、「Button1」、または「Ctrl+Shift」などの拡張修飾子キーおよびマウス・ボタンを記述するStringを返します。
long	getWhen()	このイベントが発生したタイムスタンプと協定世界時のUTC 1970年1月1日深夜零時との差をミリ秒単位で返します。
boolean	isAltDown()	このイベントでAlt修飾子が押されたかどうかを返します。
boolean	isAltGraphDown()	このイベントでAltGraph修飾子が押されたかどうかを返します。
boolean	isConsumed()	このイベントが消費されたかどうかを返します。
boolean	isControlDown()	このイベントでCtrl修飾子が押されたかどうかを返します。
boolean	isMetaDown()	このイベントでMeta修飾子が押されたかどうかを返します。
boolean	isShiftDown()	このイベントでShift修飾子が押されたかどうかを返します。

クラスjava.awt.event.ComponentEventで宣言されたメソッド

getComponent, paramString

クラスjava.awt.AWTEventで宣言されたメソッド

getID, setSource, toString

クラスjava.util.EventObjectで宣言されたメソッド

getSource

クラスjava.lang.Objectで宣言されたメソッド

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

フィールド詳細

SHIFT_MASK

@Deprecated(since="9") public static final int SHIFT_MASK

非推奨。

代わりにSHIFT_DOWN_MASKとgetModifiersEx()を使用することをお勧めします

Shiftキーの修飾子定数です。

関連項目:

• 定数フィールド値

CTRL_MASK

@Deprecated(since="9") public static final int CTRL_MASK

非推奨。

代わりにCTRL_DOWN_MASKとgetModifiersEx()を使用することをお勧めします

Ctrlキーの修飾子定数です。

関連項目:

• 定数フィールド値

META_MASK

@Deprecated(since="9") public static final int META_MASK

非推奨。

代わりにMETA_DOWN_MASKとgetModifiersEx()を使用することをお勧めします

Metaキーの修飾子定数です。

関連項目:

• 定数フィールド値

ALT_MASK

@Deprecated(since="9") public static final int ALT_MASK

非推奨。

代わりにALT_DOWN_MASKとgetModifiersEx()を使用することをお勧めします

Altキーの修飾子定数です。

関連項目:

• 定数フィールド値

ALT_GRAPH_MASK

@Deprecated(since="9") public static final int ALT_GRAPH_MASK

非推奨。

代わりにALT_GRAPH_DOWN_MASKとgetModifiersEx()を使用することをお勧めします

AltGraphキーの修飾子定数です。

関連項目:

• 定数フィールド値

BUTTON1_MASK

@Deprecated(since="9") public static final int BUTTON1_MASK

非推奨。

代わりにBUTTON1_DOWN_MASKとgetModifiersEx()を使用することをお勧めします

Mouse Button1の修飾子定数です。

関連項目:

• 定数フィールド値

BUTTON2_MASK

@Deprecated(since="9") public static final int BUTTON2_MASK

非推奨。

代わりにBUTTON2_DOWN_MASKとgetModifiersEx()を使用することをお勧めします。 BUTTON2_MASKの値はALT_MASKと同じです。

Mouse Button2の修飾子定数です。

関連項目:

• 定数フィールド値

BUTTON3_MASK

@Deprecated(since="9") public static final int BUTTON3_MASK

非推奨。

代わりにBUTTON3_DOWN_MASKとgetModifiersEx()を使用することをお勧めします。 BUTTON3_MASKの値はMETA_MASKと同じです。

Mouse Button3の修飾子定数です。

関連項目:

• 定数フィールド値

SHIFT_DOWN_MASK

public static final int SHIFT_DOWN_MASK

Shiftキーの拡張修飾子定数です。

導入されたバージョン:

1.4

関連項目:

• 定数フィールド値

CTRL_DOWN_MASK

public static final int CTRL_DOWN_MASK

Ctrlキーの拡張修飾子定数です。

導入されたバージョン:

1.4

関連項目:

• 定数フィールド値

META_DOWN_MASK

public static final int META_DOWN_MASK

Metaキーの拡張修飾子定数です。

導入されたバージョン:

1.4

関連項目:

• 定数フィールド値

ALT_DOWN_MASK

public static final int ALT_DOWN_MASK

Altキーの拡張修飾子定数です。

導入されたバージョン:

1.4

関連項目:

• 定数フィールド値

BUTTON1_DOWN_MASK

public static final int BUTTON1_DOWN_MASK

Mouse Button1の拡張修飾子定数です。

導入されたバージョン:

1.4

関連項目:

• 定数フィールド値

BUTTON2_DOWN_MASK

public static final int BUTTON2_DOWN_MASK

Mouse Button2の拡張修飾子定数です。

導入されたバージョン:

1.4

関連項目:

• 定数フィールド値

BUTTON3_DOWN_MASK

public static final int BUTTON3_DOWN_MASK

Mouse Button3の拡張修飾子定数です。

導入されたバージョン:

1.4

関連項目:

• 定数フィールド値

ALT_GRAPH_DOWN_MASK

public static final int ALT_GRAPH_DOWN_MASK

AltGraphキーの拡張修飾子定数です。

導入されたバージョン:

1.4

関連項目:

• 定数フィールド値

メソッドの詳細

getMaskForButton

public static int getMaskForButton(int button)

既存のマウス・ボタンのマスクを取得するメソッド。 返されるマスクは異なる用途に使用できます。 それらの一部を次に示します。

• mousePress(buttons)およびmouseRelease(buttons)
• 新しいMouseEventインスタンスの作成時のmodifiersパラメータとして
• 既存のMouseEventのmodifiersExをチェックするため

パラメータ:

button - 1から始まるボタンを表す数値。 たとえば、

 int button = InputEvent.getMaskForButton(1);
 

次と同じ意味になります

 int button = InputEvent.getMaskForButton(MouseEvent.BUTTON1);
 

理由は、MouseEvent.BUTTON1が1に等しいからです。 使用可能なボタンがマウスに3つある場合(MouseInfo.getNumberOfButtons()を参照)、左の列からメソッドに渡される値によって、対応する値が右の列から返されます。

    button    returned mask
    BUTTON1  BUTTON1_DOWN_MASK
    BUTTON2  BUTTON2_DOWN_MASK
    BUTTON3  BUTTON3_DOWN_MASK
 

使用可能なボタンがマウスに4つ以上ある場合は、それ以上の値が可能です(4、5など)。 拡張されたこれらのボタンには、割り当てられた定数はありません。 このメソッドによって返される追加のボタンのボタン・マスクには、最初の3つのボタン・マスクと同様、割り当てられた名前はありません。

このメソッドには、次の実装の制限があります。 ボタンの数に制限のあるマスクのみが返されます。 最大数は実装によって異なる場合があります。 この制限は、マウスに備わっていると仮定される関連するボタンの数によって定義されますが、MouseInfo.getNumberOfButtons()より大きくなります。

戻り値:

既存のマウス・ボタンのマスク。

例外:

IllegalArgumentException - buttonが0未満、またはボタンに予約されているボタン・マスクの数より大きい場合

導入されたバージョン:

1.7

関連項目:

• MouseInfo.getNumberOfButtons()
• Toolkit.areExtraMouseButtonsEnabled()
• getModifiers()
• getModifiersEx()

isShiftDown

public boolean isShiftDown()

このイベントでShift修飾子が押されたかどうかを返します。

戻り値:

このイベントでShift修飾子が押されたかどうか

isControlDown

public boolean isControlDown()

このイベントでCtrl修飾子が押されたかどうかを返します。

戻り値:

このイベントでCtrl修飾子が押されたかどうか

isMetaDown

public boolean isMetaDown()

このイベントでMeta修飾子が押されたかどうかを返します。

戻り値:

このイベントでMeta修飾子が押されたかどうか

isAltDown

public boolean isAltDown()

このイベントでAlt修飾子が押されたかどうかを返します。

戻り値:

このイベントでAlt修飾子が押されたかどうか

isAltGraphDown

public boolean isAltGraphDown()

このイベントでAltGraph修飾子が押されたかどうかを返します。

戻り値:

このイベントでAltGraphモディファイアがダウンしているかどうか

getWhen

public long getWhen()

このイベントが発生したタイムスタンプと協定世界時のUTC 1970年1月1日深夜零時との差をミリ秒単位で返します。

戻り値:

タイムスタンプと午前0時(1970年1月1日UTC)の差(ミリ秒)

getModifiers

@Deprecated(since="9") public int getModifiers()

非推奨。

代わりに拡張修飾キーとgetModifiersEx()を使用することをお勧めします

このイベントの修飾子マスクを返します。

戻り値:

このイベントの修飾子マスク

getModifiersEx

public int getModifiersEx()

このイベントの拡張修飾子マスクを返します。

拡張修飾子は、ALT_DOWN_MASK、BUTTON1_DOWN_MASKなどのように、_DOWN_MASK接尾辞で終わる修飾子です。

拡張修飾子は、イベントが発生した直後の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) {
        ...
    }
 

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

戻り値:

このイベントの拡張モディファイア・マスク

導入されたバージョン:

1.4

consume

public void consume()

このイベントを消費して、発生させたソースによりデフォルトの方法で処理されないようにします。

オーバーライド:

consume、クラスAWTEvent

isConsumed

public boolean isConsumed()

このイベントが消費されたかどうかを返します。

オーバーライド:

isConsumed、クラスAWTEvent

戻り値:

このイベントが消費されたかどうか

関連項目:

• consume()

getModifiersExText

public static String getModifiersExText(int modifiers)

「Shift」、「Button1」、または「Ctrl+Shift」などの拡張修飾子キーおよびマウス・ボタンを記述するStringを返します。 これらの文字列はawt.propertiesファイルを変更することによりローカライズが可能です。

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

パラメータ:

modifiers - イベントの拡張修飾子キーおよびマウス・ボタンを記述する修飾子マスク

戻り値:

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

導入されたバージョン:

1.4