AWTKeyStroke (Java Platform SE 6)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM Platform
Standard Ed. 6

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

java.awt
クラス AWTKeyStroke

java.lang.Object
  java.awt.AWTKeyStroke

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

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

public class AWTKeyStroke
extends Object
implements Serializable
extends Object
implements Serializable

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
 
 
修飾子
none
 
 
キーを離すとき
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 - ファクトリメソッドがインスタンスを生成する新しい Class
例外:
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.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 を取得します。KeyEvent 修飾子は、KeyEvent の 3 つの型すべてから取得されます。





パラメータ:
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()

一意であると考えられるこのオブジェクトの数値を返します。この値は、ハッシュテーブルでインデックス値として使用できます。


オーバーライド:
クラス Object 内の hashCode



戻り値:
このオブジェクトを表す int 値
関連項目:
Object.equals(java.lang.Object), 
Hashtable





equals
public final boolean equals(Object anObject)

このオブジェクトが指定されたオブジェクトと同じ場合に true を返します。


オーバーライド:
クラス Object 内の equals


パラメータ:
anObject - このオブジェクトと比較する Object
戻り値:
オブジェクトが同じ場合は true
関連項目:
Object.hashCode(), 
Hashtable





toString
public String toString()

このオブジェクトのプロパティーを表示および識別する文字列を返します。このメソッドから返された String をパラメータとして getAWTKeyStroke(String) に渡して、このキーストロークに等しいキーストロークを生成します。


オーバーライド:
クラス Object 内の toString



戻り値:
このオブジェクトの文字列表現
関連項目:
getAWTKeyStroke(String)





readResolve
protected Object readResolve()
                      throws ObjectStreamException

このインスタンスと同じ、AWTKeyStroke のキャッシュされたインスタンス、または AWTKeyStroke のサブクラスを返します。






戻り値:
このインスタンスと同じ、キャッシュされたインスタンス
例外:
ObjectStreamException














  
      概要 
      パッケージ 
    クラス 
      使用 
      階層ツリー 
      非推奨 API 
      索引 
      ヘルプ 
  



Java^TM Platform
Standard Ed. 6





 前のクラス 
 次のクラス

  フレームあり   
 フレームなし   
 







  概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド






バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。

コンストラクタの概要
`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()` このオブジェクトのプロパティーを表示および識別する文字列を返します。

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

java.awt クラス AWTKeyStroke

AWTKeyStroke

AWTKeyStroke

registerSubclass

getAWTKeyStroke

getAWTKeyStroke

getAWTKeyStroke

getAWTKeyStroke

getAWTKeyStrokeForEvent

getAWTKeyStroke

getKeyChar

getKeyCode

getModifiers

isOnKeyRelease

getKeyEventType

hashCode

equals

toString

readResolve

java.awt
クラス AWTKeyStroke