AWTKeyStroke (Java Platform SE 7)

java.lang.Object
- java.awt.AWTKeyStroke

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

Serializable

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

KeyStroke
```
public class AWTKeyStroke
extends Object
implements Serializable
```
AWTKeyStroke は、キーボード、または同等の入力デバイスのキーアクションを表します。AWTKeyStroke は、KEY_PRESSED や KEY_RELEASED KeyEvent のように、特定のキーを押したり離したりする動作にのみ対応し、KEY_TYPED KeyEvent のように、特定の Java 文字の入力を対応させることもできます。どのような場合でも、AWTKeyStroke では、アクションを正確に一致させるために必要な修飾子 (Alt、Shift、Control、Meta、AltGraph の各キー、またはこれらのキーの組み合わせ) を指定できます。
AWTKeyStrokes は不変であり、重複しないことを想定しています。このため、クライアントコードで独自の AWTKeyStroke を定義しないで、getAWTKeyStroke のバリアントを使います。このようなファクトリメソッドをクライアントで使用すると、AWTKeyStroke の実装で、インスタンスの効率的なキャッシュと共有が可能です。

導入されたバージョン:

1.4

関連項目:
getAWTKeyStroke(char), 直列化された形式

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

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`AWTKeyStroke()` デフォルト値を使用して `AWTKeyStroke` を構築します。
`protected`	`AWTKeyStroke(char keyChar, int keyCode, int modifiers, boolean onKeyRelease)` 指定された値を持つ `AWTKeyStroke` を構築します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`boolean`	`equals(Object anObject)` このオブジェクトが指定されたオブジェクトと同じ場合に true を返します。
`static AWTKeyStroke`	`getAWTKeyStroke(char keyChar)` 指定された文字の `KEY_TYPED` イベントを表す `AWTKeyStroke` の共有インスタンスを返します。
`static AWTKeyStroke`	`getAWTKeyStroke(Character keyChar, int modifiers)` 指定された Character オブジェクトと修飾子のセットの `KEY_TYPED` イベントを表す `AWTKeyStroke` の共有インスタンスを返します。
`static AWTKeyStroke`	`getAWTKeyStroke(int keyCode, int modifiers)` 数値キーコードと修飾子のセットを使用して、`AWTKeyStroke` の共有インスタンスを返します。
`static AWTKeyStroke`	`getAWTKeyStroke(int keyCode, int modifiers, boolean onKeyRelease)` キーが押されたときと解放されたときのどちらでアクティブになるかを指定して、数値キーコードと修飾子のセットを使用して、`AWTKeyStroke` の共有インスタンスを返します。
`static AWTKeyStroke`	`getAWTKeyStroke(String s)` 文字列を解析し、`AWTKeyStroke` を返します。
`static AWTKeyStroke`	`getAWTKeyStrokeForEvent(KeyEvent anEvent)` 特定の `KeyEvent` を生成したストロークを表す `AWTKeyStroke` を返します。
`char`	`getKeyChar()` この `AWTKeyStroke` の文字を返します。
`int`	`getKeyCode()` この `AWTKeyStroke` の数値キーコードを返します。
`int`	`getKeyEventType()` この `AWTKeyStroke` に対応する `KeyEvent` のタイプを返します。
`int`	`getModifiers()` この `AWTKeyStroke` の修飾キーを返します。
`int`	`hashCode()` 一意であると考えられるこのオブジェクトの数値を返します。この値は、ハッシュテーブルでインデックス値として使用できます。
`boolean`	`isOnKeyRelease()` この `AWTKeyStroke` がキー解放を表すかどうかを返します。
`protected Object`	`readResolve()` このインスタンスに等しい、`AWTKeyStroke` のキャッシュされたインスタンス (または `AWTKeyStroke` のサブクラス) を返します。
`protected static void`	`registerSubclass(Class<?> subclass)` `AWTKeyStroke` の新しいインスタンスを生成するときに、`AWTKeyStroke` のファクトリメソッドが使用する新しいクラスを登録します。
`String`	`toString()` このオブジェクトのプロパティーを表示および識別する文字列を返します。

クラス java.lang.Object から継承されたメソッド
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- コンストラクタの詳細
  - AWTKeyStroke
```
protected AWTKeyStroke()
```
    デフォルト値を使用して AWTKeyStroke を構築します。次のデフォルト値を使用します。
    
    プロパティーデフォルト値
    
    キー文字 KeyEvent.CHAR_UNDEFINED
    
    キーコード KeyEvent.VK_UNDEFINED
    
    修飾子なし
    
    キーを離すとき false
    
    AWTKeyStroke はクライアントコードで構築するべきではありません。代わりに、getAWTKeyStroke のバリアントを使用します。
    
    関連項目:
    getAWTKeyStroke(char)
  - AWTKeyStroke
```
protected AWTKeyStroke(char keyChar,
            int keyCode,
            int modifiers,
            boolean onKeyRelease)
```
    指定された値で AWTKeyStroke を構築します。AWTKeyStroke はクライアントコードで構築するべきではありません。代わりに、getAWTKeyStroke のバリアントを使用します。
    
    パラメータ:
    keyChar - キーボードキーの文字値
    keyCode - この AWTKeyStroke のキーコード
    modifiers - 任意の修飾子のビット単位の論理和の組み合わせ
    onKeyRelease - この AWTKeyStroke がキーを離す動作に対応する場合は true、そうでない場合は false
    関連項目:
    getAWTKeyStroke(char)
- メソッドの詳細
  - registerSubclass
```
protected static void registerSubclass(Class<?> subclass)
```
    AWTKeyStroke の新しいインスタンスを生成するときに、AWTKeyStroke のファクトリメソッドが使用する新しいクラスを登録します。このメソッドを呼び出したあと、ファクトリメソッドは指定されたクラスのインスタンスを返します。指定するクラスは AWTKeyStroke か AWTKeyStroke から派生したもののどちらかで、引数なしのコンストラクタを持たなければいけません。コンストラクタのアクセス可能性は任意であり、private でも構いません。この操作は現在の AWTKeyStroke キャッシュをフラッシュします。
    
    パラメータ:
    subclass - ファクトリメソッドがインスタンスを生成する新しいクラス
    
    例外:
    
    IllegalArgumentException - サブクラスが null であるか、または引数なしのコンストラクタを持たない場合
    
    ClassCastException - サブクラスが AWTKeyStroke でない場合、または AWTKeyStroke から派生したクラスでない場合
  - getAWTKeyStroke
```
public static AWTKeyStroke getAWTKeyStroke(char keyChar)
```
    指定された文字の KEY_TYPED イベントを表す AWTKeyStroke の共有インスタンスを返します。
    
    パラメータ:
    keyChar - キーボードキーの文字値
    
    戻り値:
    そのキーの AWTKeyStroke オブジェクト
  - getAWTKeyStroke
```
public static AWTKeyStroke getAWTKeyStroke(Character keyChar,
                           int modifiers)
```
    指定された Character オブジェクトと修飾子のセットの KEY_TYPED イベントを表す AWTKeyStroke の共有インスタンスを返します。最初のパラメータは char 型ではなく Character 型のパラメータです。これは、getAWTKeyStroke(int keyCode, int modifiers) 呼び出しによる予期しないクラッシュを避けるためです。修飾子は、次の組み合わせで構成されます。
    - java.awt.event.InputEvent.SHIFT_DOWN_MASK
    - java.awt.event.InputEvent.CTRL_DOWN_MASK
    - java.awt.event.InputEvent.META_DOWN_MASK
    - java.awt.event.InputEvent.ALT_DOWN_MASK
    - java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK
    次に示す古い修飾子も使用できますが、これらは _DOWN_ 修飾子にマッピングされます。
    - java.awt.event.InputEvent.SHIFT_MASK
    - java.awt.event.InputEvent.CTRL_MASK
    - java.awt.event.InputEvent.META_MASK
    - java.awt.event.InputEvent.ALT_MASK
    - java.awt.event.InputEvent.ALT_GRAPH_MASK
    これらも使用できますが、これらは _DOWN_ 修飾子にマッピングされます。これらの数字はすべて異なる 2 の累乗であるため、それらの組み合わせは各ビットが別々の修飾キーを表す整数です。修飾子を指定しない場合は、0 を使います。
    パラメータ:
    keyChar - キーボード文字の Character オブジェクト
    modifiers - 任意の修飾子のビット単位の論理和の組み合わせ
    
    戻り値:
    そのキーの AWTKeyStroke オブジェクト
    
    例外:
    
    IllegalArgumentException - keyChar が null の場合
    関連項目:
    InputEvent
  - getAWTKeyStroke
```
public static AWTKeyStroke getAWTKeyStroke(int keyCode,
                           int modifiers,
                           boolean onKeyRelease)
```
    キーが押されたときと解放されたときのどちらでアクティブになるかを指定して、数値キーコードと修飾子のセットを使用して、AWTKeyStroke の共有インスタンスを返します。
    java.awt.event.KeyEvent で定義された「仮想キー」定数を使用すると、キーコードを指定できます。例を示します。
    - java.awt.event.KeyEvent.VK_ENTER
    - java.awt.event.KeyEvent.VK_TAB
    - java.awt.event.KeyEvent.VK_SPACE
    代わりに、java.awt.event.KeyEvent.getExtendedKeyCodeForChar を呼び出すことでキーコードを取得することもできます。修飾子は、次の組み合わせで構成されます。
    - java.awt.event.InputEvent.SHIFT_DOWN_MASK
    - java.awt.event.InputEvent.CTRL_DOWN_MASK
    - java.awt.event.InputEvent.META_DOWN_MASK
    - java.awt.event.InputEvent.ALT_DOWN_MASK
    - java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK
    以前使われていた修飾子を次に挙げます。
    - java.awt.event.InputEvent.SHIFT_MASK
    - java.awt.event.InputEvent.CTRL_MASK
    - java.awt.event.InputEvent.META_MASK
    - java.awt.event.InputEvent.ALT_MASK
    - java.awt.event.InputEvent.ALT_GRAPH_MASK
    これらも使用できますが、これらは _DOWN_ 修飾子にマッピングされます。これらの数字はすべて異なる 2 の累乗であるため、それらの組み合わせは各ビットが別々の修飾キーを表す整数です。修飾子を指定しない場合は、0 を使います。
    パラメータ:
    keyCode - キーボードキーの数値コードを指定する int
    modifiers - 任意の修飾子のビット単位の論理和の組み合わせ
    onKeyRelease - この AWTKeyStroke がキーを離す動作を表現する場合は true、そうでない場合は false
    
    戻り値:
    上記キーの AWTKeyStroke オブジェクト
    関連項目:
    KeyEvent, InputEvent
  - getAWTKeyStroke
```
public static AWTKeyStroke getAWTKeyStroke(int keyCode,
                           int modifiers)
```
    数値キーコードと修飾子のセットを使用して、AWTKeyStroke の共有インスタンスを返します。返される AWTKeyStroke は、キーを押す動作に対応します。
    java.awt.event.KeyEvent で定義された「仮想キー」定数を使用すると、キーコードを指定できます。例を示します。
    - java.awt.event.KeyEvent.VK_ENTER
    - java.awt.event.KeyEvent.VK_TAB
    - java.awt.event.KeyEvent.VK_SPACE
    修飾子は、次の組み合わせで構成されます。
    - java.awt.event.InputEvent.SHIFT_DOWN_MASK
    - java.awt.event.InputEvent.CTRL_DOWN_MASK
    - java.awt.event.InputEvent.META_DOWN_MASK
    - java.awt.event.InputEvent.ALT_DOWN_MASK
    - java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK
    以前使われていた修飾子を次に挙げます。
    - java.awt.event.InputEvent.SHIFT_MASK
    - java.awt.event.InputEvent.CTRL_MASK
    - java.awt.event.InputEvent.META_MASK
    - java.awt.event.InputEvent.ALT_MASK
    - java.awt.event.InputEvent.ALT_GRAPH_MASK
    これらも使用できますが、これらは _DOWN_ 修飾子にマッピングされます。これらの数字はすべて異なる 2 の累乗であるため、それらの組み合わせは各ビットが別々の修飾キーを表す整数です。修飾子を指定しない場合は、0 を使います。
    パラメータ:
    keyCode - キーボードキーの数値コードを指定する int
    modifiers - 任意の修飾子のビット単位の論理和の組み合わせ
    
    戻り値:
    そのキーの AWTKeyStroke オブジェクト
    関連項目:
    KeyEvent, InputEvent
  - getAWTKeyStrokeForEvent
```
public static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent)
```
    特定の KeyEvent を生成したストロークを表す AWTKeyStroke を返します。
    このメソッドは、KeyTyped イベントから keyChar を取得し、KeyPressed または KeyReleased イベントから keyCode を取得します。また、3 つの KeyEvent 型のすべてから KeyEvent 修飾子を取得します。
    
    パラメータ:
    anEvent - AWTKeyStroke を取得する KeyEvent
    
    戻り値:
    イベントを発生させた AWTKeyStroke
    
    例外:
    
    NullPointerException - anEvent が null の場合
  - getAWTKeyStroke
```
public static AWTKeyStroke getAWTKeyStroke(String s)
```
    文字列を解析し、AWTKeyStroke を返します。文字列は次の構文を持つ必要があります。
```
    <modifiers>* (<typedID> | <pressedReleasedID>)

    modifiers := shift | control | ctrl | meta | alt | altGraph
    typedID := typed <typedKey>
    typedKey := string of length 1 giving Unicode character.
    pressedReleasedID := (pressed | released) key
    key := KeyEvent key code name, i.e. the name following "VK_".
 
```
    タイプするのか、押すのか、離すのかが指定されない場合、押すと見なされます。いくつか例を挙げます。
```
     "INSERT" => getAWTKeyStroke(KeyEvent.VK_INSERT, 0);
     "control DELETE" => getAWTKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK);
     "alt shift X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK);
     "alt shift released X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true);
     "typed a" => getAWTKeyStroke('a');
 
```
    パラメータ:
    s - 上記の構文に従って指定した String
    
    戻り値:
    上記文字列の AWTKeyStroke オブジェクト
    
    例外:
    
    IllegalArgumentException - s が null であるか、フォーマットが正しくない場合
  - getKeyChar
```
public final char getKeyChar()
```
    この AWTKeyStroke の文字を返します。
    
    戻り値:
    char 値
    関連項目:
    getAWTKeyStroke(char), KeyEvent.getKeyChar()
  - getKeyCode
```
public final int getKeyCode()
```
    この AWTKeyStroke の数値キーコードを返します。
    
    戻り値:
    キーコード値が格納されている int 値
    関連項目:
    getAWTKeyStroke(int,int), KeyEvent.getKeyCode()
  - getModifiers
```
public final int getModifiers()
```
    この AWTKeyStroke の修飾キーを返します。
    
    戻り値:
    修飾子が格納されている int 値
    関連項目:
    getAWTKeyStroke(int,int)
  - isOnKeyRelease
```
public final boolean isOnKeyRelease()
```
    この AWTKeyStroke がキー解放を表すかどうかを返します。
    
    戻り値:
    この AWTKeyStroke がキーを離す動作を表現する場合は true、そうでない場合は false
    関連項目:
    getAWTKeyStroke(int,int,boolean)
  - getKeyEventType
```
public final int getKeyEventType()
```
    この AWTKeyStroke に対応する KeyEvent のタイプを返します。
    
    戻り値:
    KeyEvent.KEY_PRESSED、KeyEvent.KEY_TYPED、または KeyEvent.KEY_RELEASED
    関連項目:
    KeyEvent
  - hashCode
```
public int hashCode()
```
    一意であると考えられるこのオブジェクトの数値を返します。この値は、ハッシュテーブルでインデックス値として使用できます。
    
    オーバーライド:
    
    hashCode、クラス: Object
    
    戻り値:
    このオブジェクトを表す int 値
    関連項目:
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - equals
```
public final boolean equals(Object anObject)
```
    このオブジェクトが指定されたオブジェクトと同じ場合に true を返します。
    
    オーバーライド:
    
    equals、クラス: Object
    
    パラメータ:
    anObject - このオブジェクトと比較するオブジェクト
    
    戻り値:
    オブジェクトが同じ場合は true
    関連項目:
    Object.hashCode(), HashMap
  - toString
```
public String toString()
```
    このオブジェクトのプロパティーを表示および識別する文字列を返します。このメソッドから返された String をパラメータとして getAWTKeyStroke(String) に渡して、このキーストロークに等しいキーストロークを生成します。
    
    オーバーライド:
    
    toString、クラス: Object
    
    戻り値:
    このオブジェクトの文字列表現
    関連項目:
    getAWTKeyStroke(String)
  - readResolve
```
protected Object readResolve()
                      throws ObjectStreamException
```
    このインスタンスに等しい、AWTKeyStroke のキャッシュされたインスタンス (または AWTKeyStroke のサブクラス) を返します。
    
    戻り値:
    このインスタンスと同じ、キャッシュされたインスタンス
    
    例外:
    
    ObjectStreamException

プロパティー	デフォルト値
キー文字	`KeyEvent.CHAR_UNDEFINED`
キーコード	`KeyEvent.VK_UNDEFINED`
修飾子	なし
キーを離すとき	`false`

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

クラス AWTKeyStroke

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

メソッドのサマリー

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

コンストラクタの詳細

AWTKeyStroke

AWTKeyStroke

メソッドの詳細

registerSubclass

getAWTKeyStroke

getAWTKeyStroke

getAWTKeyStroke

getAWTKeyStroke

getAWTKeyStrokeForEvent

getAWTKeyStroke

getKeyChar

getKeyCode

getModifiers

isOnKeyRelease

getKeyEventType

hashCode

equals

toString

readResolve