概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
JavaTM 2
Platform
Std. Ed. v1.4.0
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド

java.awt
クラス AWTKeyStroke

java.lang.Object
  |
  +--java.awt.AWTKeyStroke
すべての実装インタフェース:
Serializable
直系の既知のサブクラス:
KeyStroke
public class AWTKeyStroke
extends Object
implements Serializable

AWTKeyStroke は、キーボード、または同等の入力デバイスのキーアクションを表現します。KEY_PRESSED や KEY_RELEASED KeyEvent のように、特定のキーを押したり離したりする動作にのみ対応し、KEY_TYPED KeyEvent のように、特定の Java 文字の入力を対応させることもできます。どのような場合でも、AWTKeyStroke では、アクションを正確に一致させるために必要な修飾子 (Alt、Shift、Control、Meta、の各キー、またはこれらのキーの組み合わせ) を指定できます。

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)
          指定された文字オブジェクトと修飾子のセットを持つ、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)
指定された文字オブジェクトと修飾子のセットを持つ、AWTKeyStroke の共有インスタンスを返します。最初のパラメータには char 型ではなく、文字型を使用します。getAWTKeyStroke(int keyCode, int modifiers) の呼び出しで、不注意で発生するクラッシュを避けることができます。修飾子としては、次に挙げるものを組み合わせて使用できます。 以前使われていた修飾子を次に挙げます。 これらも使用できますが、_DOWN_ 修飾子にマップされます。これらの数値はすべて 2 の累乗であり、組み合わせると各ビットが別々の修飾子キーを表す整数になります。修飾子を使用しない場合は 0 を指定します。

パラメータ:
keyChar - キーボード文字の文字オブジェクト
modifiers - 任意の修飾子のビット単位論理和の組み合わせ
戻り値:
上記キーの AWTKeyStroke オブジェクト
関連項目:
InputEvent

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(int keyCode,
                                           int modifiers,
                                           boolean onKeyRelease)
押されたとき、または解放されたときのどちらの場合にキーが有効になるかを指定して、指定された数値キーコードと修飾子のセットを持つ、AWTKeyStroke の共有インスタンスを返します。

java.awt.event.KeyEvent で定義される「仮想キー」定数は、キーコードを指定するために使用できます。次に例を示します。

次の修飾子を組み合わせて使用できます。 以前使われていた修飾子を次に挙げます。 これらも使用できますが、_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 で定義される「仮想キー」定数は、キーコードを指定するために使用できます。次に例を示します。

次の修飾子を組み合わせて使用できます。 以前使われていた修飾子を次に挙げます。 これらも使用できますが、_DOWN_ 修飾子にマップされます。これらの数値はすべて 2 の累乗であり、組み合わせると各ビットが別々の修飾子キーを表す整数になります。修飾子を使用しない場合は 0 を指定します。

パラメータ:
keyCode - キーボードのキーの数値コードを指定する int 値
modifiers - 任意の修飾子のビット単位論理和の組み合わせ
戻り値:
上記キーの AWTKeyStroke オブジェクト
関連項目:
KeyEvent, InputEvent

getAWTKeyStrokeForEvent

public static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent)
指定された KeyEvent を生成するストロークを表現する AWTKeyStroke を返します。

このメソッドは、KeyTyped イベントからキー文字を、KeyPressed または KeyReleased イベントからキーコードを取得します。KeyEvent 修飾子は、KeyEvent の 3 つのタイプすべてから取得されます。

パラメータ:
anEvent - AWTKeyStroke を取得する KeyEvent
戻り値:
イベントを発生させた AWTKeyStroke

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(String s)
文字列の構文を解析し、AWTKeyStroke を返します。次のような構文である必要があります。 
    <modifiers>* (<typedID> | <pressedReleasedID>)

    modifiers := shift | control | ctrl | meta | alt | button1 | button2 | button3
    typedID := typed <typedKey>
    typedKey := 長さ 1 の Unicode 文字列
    pressedReleasedID := (pressed | released) key
    key := KeyEvent キーコード名、つまり "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 - 上記のフォーマットを持つ文字列
戻り値:
上記文字列の AWTKeyStroke オブジェクト

getKeyChar

public final char getKeyChar()
この AWTKeyStroke の文字を返します。

戻り値:
char 値
関連項目:
getAWTKeyStroke(char)

getKeyCode

public final int getKeyCode()
この AWTKeyStroke の数値キーコードを返します。

戻り値:
キーコード値が格納されている int 値
関連項目:
getAWTKeyStroke(int,int)

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

オーバーライド:
クラス Object 内の toString
戻り値:
このオブジェクトの文字列表現

readResolve

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

戻り値:
このインスタンスと同じ、キャッシュされたインスタンス
ObjectStreamException
概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
JavaTM 2
Platform
Std. Ed. v1.4.0
 前のクラス   次のクラス フレームあり    フレームなし    
概要:  入れ子 | フィールド | コンストラクタ | メソッド 詳細:  フィールド | コンストラクタ | メソッド
バグの報告と機能のリクエスト
これ以外の API リファレンスおよび開発者用ドキュメントについては、 Java 2 SDK SE 開発者用ドキュメントを参照してください。 開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、 およびコード実例が含まれています。

Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.