InputEvent (Java Platform SE 7)

java.lang.Object
- java.util.EventObject
- - java.awt.AWTEvent
  - - java.awt.event.ComponentEvent
    - - java.awt.event.InputEvent

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

Serializable

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

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

導入されたバージョン:

1.1

関連項目:
KeyEvent, KeyAdapter, MouseEvent, MouseAdapter, MouseMotionAdapter, 直列化された形式

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static int`	`ALT_DOWN_MASK` Alt キーの拡張修飾子定数です。
`static int`	`ALT_GRAPH_DOWN_MASK` AltGraph キーの拡張修飾子定数です。
`static int`	`ALT_GRAPH_MASK` AltGraph キーの修飾子定数です。
`static int`	`ALT_MASK` Alt キーの修飾子定数です。
`static int`	`BUTTON1_DOWN_MASK` Mouse Button1 の拡張修飾子定数です。
`static int`	`BUTTON1_MASK` Mouse Button1 の修飾子定数です。
`static int`	`BUTTON2_DOWN_MASK` Mouse Button2 の拡張修飾子定数です。
`static int`	`BUTTON2_MASK` Mouse Button2 の修飾子定数です。
`static int`	`BUTTON3_DOWN_MASK` Mouse Button3 の拡張修飾子定数です。
`static int`	`BUTTON3_MASK` Mouse Button3 の修飾子定数です。
`static int`	`CTRL_DOWN_MASK` Ctrl キーの拡張修飾子定数です。
`static int`	`CTRL_MASK` Ctrl キーの修飾子定数です。
`static int`	`META_DOWN_MASK` Meta キーの拡張修飾子定数です。
`static int`	`META_MASK` Meta キーの修飾子定数です。
`static int`	`SHIFT_DOWN_MASK` Shift キーの拡張修飾子定数です。
`static int`	`SHIFT_MASK` Shift キーの修飾子定数です。

クラス 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()` このイベントの修飾子マスクを返します。
`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
```
public static final int SHIFT_MASK
```
    Shift キーの修飾子定数です。代わりに、SHIFT_DOWN_MASK を使用することをお勧めします。
    
    関連項目:
    定数フィールド値
  - CTRL_MASK
```
public static final int CTRL_MASK
```
    Ctrl キーの修飾子定数です。代わりに、CTRL_DOWN_MASK を使用することをお勧めします。
    
    関連項目:
    定数フィールド値
  - META_MASK
```
public static final int META_MASK
```
    Meta キーの修飾子定数です。代わりに、META_DOWN_MASK を使用することをお勧めします。
    
    関連項目:
    定数フィールド値
  - ALT_MASK
```
public static final int ALT_MASK
```
    Alt キーの修飾子定数です。代わりに、ALT_DOWN_MASK を使用することをお勧めします。
    
    関連項目:
    定数フィールド値
  - ALT_GRAPH_MASK
```
public static final int ALT_GRAPH_MASK
```
    AltGraph キーの修飾子定数です。
    
    関連項目:
    定数フィールド値
  - BUTTON1_MASK
```
public static final int BUTTON1_MASK
```
    Mouse Button1 の修飾子定数です。代わりに、BUTTON1_DOWN_MASK を使用することをお勧めします。
    
    関連項目:
    定数フィールド値
  - BUTTON2_MASK
```
public static final int BUTTON2_MASK
```
    Mouse Button2 の修飾子定数です。代わりに、BUTTON2_DOWN_MASK を使用することをお勧めします。BUTTON2_MASK の値は ALT_MASK と同じです。
    
    関連項目:
    定数フィールド値
  - BUTTON3_MASK
```
public static final int BUTTON3_MASK
```
    Mouse Button3 の修飾子定数です。代わりに、BUTTON3_DOWN_MASK を使用することをお勧めします。BUTTON3_MASK の値は META_MASK と同じです。
    
    関連項目:
    定数フィールド値
  - 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 未満、またはボタンに予約されているボタンマスクの数より大きい場合
    導入されたバージョン:
    
    7.0
    
    関連項目:
    MouseInfo.getNumberOfButtons(), Toolkit.areExtraMouseButtonsEnabled(), getModifiers(), MouseEvent.getModifiersEx()
  - isShiftDown
```
public boolean isShiftDown()
```
    このイベントで Shift 修飾子が押されたかどうかを返します。
  - isControlDown
```
public boolean isControlDown()
```
    このイベントで Ctrl 修飾子が押されたかどうかを返します。
  - isMetaDown
```
public boolean isMetaDown()
```
    このイベントで Meta 修飾子が押されたかどうかを返します。
  - isAltDown
```
public boolean isAltDown()
```
    このイベントで Alt 修飾子が押されたかどうかを返します。
  - isAltGraphDown
```
public boolean isAltGraphDown()
```
    このイベントで AltGraph 修飾子が押されたかどうかを返します。
  - getWhen
```
public long getWhen()
```
    このイベントが発生したタイムスタンプと協定世界時の UTC 1970 年 1 月 1 日深夜零時との差をミリ秒単位で返します。
  - getModifiers
```
public int getModifiers()
```
    このイベントの修飾子マスクを返します。
  - 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) {
        ...
    }
 
```
    上記のコードは、新しい修飾子が追加されても動作します。
    導入されたバージョン:
    
    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

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス InputEvent

フィールドのサマリー

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

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

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

メソッドのサマリー

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

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

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

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

フィールドの詳細

SHIFT_MASK

CTRL_MASK

META_MASK

ALT_MASK

ALT_GRAPH_MASK

BUTTON1_MASK

BUTTON2_MASK

BUTTON3_MASK

SHIFT_DOWN_MASK

CTRL_DOWN_MASK

META_DOWN_MASK

ALT_DOWN_MASK

BUTTON1_DOWN_MASK

BUTTON2_DOWN_MASK

BUTTON3_DOWN_MASK

ALT_GRAPH_DOWN_MASK

メソッドの詳細

getMaskForButton

isShiftDown

isControlDown

isMetaDown

isAltDown

isAltGraphDown

getWhen

getModifiers

getModifiersEx

consume

isConsumed

getModifiersExText