public final class KeyEvent extends InputEvent
Node
内でキー・ストロークが発生したことを示すイベント。
このイベントは、キーが押されるか、放されるか、またはタイプされると生成されます。イベントのタイプに応じて、イベントはonKeyPressed
、onKeyTyped
またはonKeyReleased
関数に渡されます。
「キー・タイプ」イベントは、ほかの2つのイベントと比べてレベルの高いイベントであり、プラットフォームやキーボードの配置には依存しません。これらはUnicode文字が入力されたときに生成され、文字入力の検出で推奨される方法です。もっとも単純な例としては、「a」などの一度のキー・プレスでキー・タイプ・イベントが発生します。ただし、一連のキー・プレス([Shift] + [A]など)で文字を作ることがよくあります。また、キー・プレス・イベントからキー・タイプ・イベントへのマッピングは、多対1または多対多になる場合があります。キー・リリースは通常キー・タイプ・イベントを生成する必要はありませんが、キーがリリースされるまでキー・タイプ・イベントが生成されないケースがあります(WindowsでASCIIシーケンスをAlt-テンキー方式で入力するなど)。アクション・キー、修飾キーなどUnicode文字を生成しないキーでは、キー・タイプ・イベントは発生しません。
character
変数には常に、有効なUnicode文字またはCHAR_UNDEFINEDが含まれています。文字入力はキー・タイプ・イベントによって報告されます。キー・プレス・イベントおよびキー・リリース・イベントは必ずしも文字入力に関連付けられていません。このため、character
変数はキー・タイプ・イベントに対してのみ意味のあるものになります。
キー・プレス・イベントおよびキー・リリース・イベントの場合、code
変数にはイベントのキー・コードが含まれています。キー・タイプ・イベントの場合、code
変数には常にKeyCode.UNDEFINED
が含まれています。
「キー・プレス」および「キー・リリース」イベントは、「キー・タイプ」イベントより低レベルのイベントであり、プラットフォームおよびキーボードの配置によって異なります。これらのイベントは、キーを押したとき、または離したときに発生します。文字入力が発生しないキー(アクション・キー、修飾キーなど)についての状態を知るには、これらのイベントに依存するしか方法はありません。押下または解放されるキーは、仮想キー・コードが含まれているcode変数で示されます。
コンテキスト・メニューのトリガーについては、ContextMenuEvent
を参照してください。
修飾子と型 | フィールドと説明 |
---|---|
static EventType<KeyEvent> |
ANY
すべてのキー・イベント・タイプに共通のスーパータイプ。
|
static String |
CHAR_UNDEFINED
有効なUnicode文字にマッピングしないKEY_PRESSEDイベントおよびKEY_RELEASEDイベントは、keyChar値にこれを使用します。
|
static EventType<KeyEvent> |
KEY_PRESSED
このイベントは、キーが押されたときに発生します。
|
static EventType<KeyEvent> |
KEY_RELEASED
このイベントは、キーが放されたときに発生します。
|
static EventType<KeyEvent> |
KEY_TYPED
このイベントは、文字生成キーが入力される(押されてリリースされる)と発生します。
|
consumed、eventType、NULL_SOURCE_TARGET、target
source
コンストラクタと説明 |
---|
KeyEvent(EventType<KeyEvent> eventType, String character, String text, KeyCode code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)
nullのソースとターゲットおよび直接指定されたKeyCodeオブジェクトを使用した新しいKeyEventイベントを構築します。
|
KeyEvent(Object source, EventTarget target, EventType<KeyEvent> eventType, String character, String text, KeyCode code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)
nullのソースとターゲットおよび直接指定されたKeyCodeオブジェクトを使用した新しいKeyEventイベントを構築します。
|
修飾子と型 | メソッドと説明 |
---|---|
KeyEvent |
copyFor(Object newSource, EventTarget newTarget)
指定したイベント・ソースとターゲットを持つこのイベントのコピーを作成して返します。
|
KeyEvent |
copyFor(Object source, EventTarget target, EventType<KeyEvent> type)
指定のフィールドが置換された特定のイベントのコピーを作成します。
|
String |
getCharacter()
キー・タイプ・イベントに関連付けられたUnicode文字または文字シーケンス。
|
KeyCode |
getCode()
このキー・プレスおよびキー・リリース・イベントのキーに関連付けられているキー・コード。
|
EventType<KeyEvent> |
getEventType()
このイベントのイベント・タイプを取得します。
|
String |
getText()
キー・プレス・イベントおよびキー・リリース・イベントのキー・コードについて説明する文字列(HOME、F1、Aなど)。
|
boolean |
isAltDown()
このイベントでAlt修飾子が押されたかどうかを返します。
|
boolean |
isControlDown()
このイベントでCtrl修飾子が押されたかどうかを返します。
|
boolean |
isMetaDown()
このイベントでMeta修飾子が押されたかどうかを返します。
|
boolean |
isShiftDown()
このイベントでShift修飾子が押されたかどうかを返します。
|
boolean |
isShortcutDown()
このイベントでホスト・プラットフォームの一般的なShortcut修飾子が押されたかどうかを返します。
|
String |
toString()
この
KeyEvent オブジェクトの文字列表現を返します。 |
getSource
public static final EventType<KeyEvent> KEY_TYPED
character
フィールドが含まれ、code
フィールドとtext
フィールドは使用されません。public static final String CHAR_UNDEFINED
public KeyEvent(Object source, EventTarget target, EventType<KeyEvent> eventType, String character, String text, KeyCode code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)
source
- イベントのソース。nullに設定できます。target
- イベントのターゲット。nullに設定できます。eventType
- イベントのタイプ。character
- イベントに関連付けられた文字または文字シーケンスtext
- キー・コードについて説明する文字列code
- 整数キー・コードshiftDown
- Shift修飾子が押された場合はtrueです。controlDown
- Ctrl修飾子が押された場合はtrueです。altDown
- Alt修飾子が押された場合はtrueです。metaDown
- Meta修飾子が押された場合はtrueです。public KeyEvent(EventType<KeyEvent> eventType, String character, String text, KeyCode code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)
eventType
- イベントのタイプ。character
- イベントに関連付けられた文字または文字シーケンスtext
- キー・コードについて説明する文字列code
- 整数キー・コードshiftDown
- Shift修飾子が押された場合はtrueです。controlDown
- Ctrl修飾子が押された場合はtrueです。altDown
- Alt修飾子が押された場合はtrueです。metaDown
- Meta修飾子が押された場合はtrueです。public final String getCharacter()
character
では[Shift] + [A]を押すと生成されるキー・タイプ・イベントの値がAになります。キー・プレス・イベントおよびキー・リリース・イベントの場合、character
は常にCHAR_UNDEFINED
です。public final String getText()
text
は常に空の文字列です。public final KeyCode getCode()
code
は常にKeyCode.UNDEFINED
です。KeyCode.UNDEFINED
)public final boolean isShiftDown()
public final boolean isControlDown()
public final boolean isAltDown()
public final boolean isMetaDown()
public final boolean isShortcutDown()
Ctrl
、MacではMeta
(コマンド・キー)です。true
、それ以外の場合はfalse
です。public String toString()
KeyEvent
オブジェクトの文字列表現を返します。toString
、クラス: EventObject
KeyEvent
オブジェクトの文字列表現public KeyEvent copyFor(Object newSource, EventTarget newTarget)
Event
null
に設定されている場合は、NULL_SOURCE_TARGET
値によって置換されます。public KeyEvent copyFor(Object source, EventTarget target, EventType<KeyEvent> type)
source
- コピーされたイベントの新しいソースtarget
- コピーされたイベントの新しいターゲットtype
- 新しいイベント・タイプ。public EventType<KeyEvent> getEventType()
Event
Event
クラスの複数のオブジェクトは、異なるイベント・タイプを持つことができます。これらのイベント・タイプでは、発生するイベントの種類をさらに指定します。getEventType
、クラス: InputEvent
Copyright (c) 2008, 2015, Oracle and/or its affiliates. All rights reserved.