- java.lang.Object
-
- javafx.scene.input.KeyCombination
-
- 直系の既知のサブクラス:
KeyCharacterCombination
,KeyCodeCombination
public abstract class KeyCombination extends Object
キーボード・ショートカットに使用されるキーの組合せを表します。 キーの組合せは、主要なキーと一連の修飾子キーで構成されています。 主要なキーは、対応するキー・コード(KeyCodeCombination
)またはキー文字(KeyCharacterCombination
)で指定できます。 修飾子キーはshift
、control
、alt
、meta
またはshortcut
で、DOWN
、UP
またはANY
として定義できます。Shortcut
修飾子は、ホスト・プラットフォームでキーボード・ショートカットに一般に広く使用されている修飾子キーを表すために使用されます。 たとえば、WindowsではCtrl
、MacではMeta
(コマンド・キー)などです。Shortcut
修飾子キーを使用することで、開発者はプラットフォームから独立したショートカットを作成できます。 そのため、[Shortcut] + [C]のキーの組合せは内部でWindowsでは[Ctrl] + [C]として、Macでは[Meta] + [C]として処理されます。- 導入されたバージョン:
- JavaFX 2.0
-
-
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
KeyCombination.Modifier
このクラスは、修飾子キーとその値のペアを表します。static class
KeyCombination.ModifierValue
ModifierValue
は、修飾子キーの状態を表します。
-
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 static KeyCombination.Modifier
ALT_ANY
[Alt]
キーを上下いずれかにできることを指定する修飾子。static KeyCombination.Modifier
ALT_DOWN
[Alt]
キーを下にする必要があることを指定する修飾子。static KeyCombination.Modifier
CONTROL_ANY
[Ctrl]
キーを上下いずれかにできることを指定する修飾子。static KeyCombination.Modifier
CONTROL_DOWN
[Ctrl]
キーを下にする必要があることを指定する修飾子。static KeyCombination.Modifier
META_ANY
[Meta]
キーを上下いずれかにできることを指定する修飾子。static KeyCombination.Modifier
META_DOWN
[Meta]
キーを下にする必要があることを指定する修飾子。static KeyCombination
NO_MATCH
どのイベントにも一致しないKeyCombination。static KeyCombination.Modifier
SHIFT_ANY
[Shift]
キーを上下いずれかにできることを指定する修飾子。static KeyCombination.Modifier
SHIFT_DOWN
[Shift]
キーを下にする必要があることを指定する修飾子。static KeyCombination.Modifier
SHORTCUT_ANY
[Shortcut]
キーを上下いずれかにできることを指定する修飾子。static KeyCombination.Modifier
SHORTCUT_DOWN
[Shortcut]
キーを下にする必要があることを指定する修飾子。
-
コンストラクタのサマリー
コンストラクタ 修飾子 コンストラクタ 説明 protected
KeyCombination(KeyCombination.Modifier... modifiers)
指定された修飾子リストでKeyCombination
を構築します。protected
KeyCombination(KeyCombination.ModifierValue shift, KeyCombination.ModifierValue control, KeyCombination.ModifierValue alt, KeyCombination.ModifierValue meta, KeyCombination.ModifierValue shortcut)
すべての修飾子キーを明示的に指定してKeyCombination
を構築します。
-
メソッドのサマリー
すべてのメソッド 静的メソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 boolean
equals(Object obj)
このKeyCombination
が指定されたオブジェクトと同じであるかどうかをテストします。KeyCombination.ModifierValue
getAlt()
このキーの組合せの[Alt]
キーの状態。KeyCombination.ModifierValue
getControl()
このキーの組合せの[Ctrl]
キーの状態。String
getDisplayText()
ユーザー・インタフェースでの表示(たとえば、メニュー・アイテムの横)に適したこのKeyCombination
の文字列表現を返します。KeyCombination.ModifierValue
getMeta()
このキーの組合せの[Meta]
キーの状態。String
getName()
このKeyCombination
の文字列表現を返します。KeyCombination.ModifierValue
getShift()
このキーの組合せの[Shift]
キーの状態。KeyCombination.ModifierValue
getShortcut()
このキーの組合せの[Shortcut]
キーの状態。int
hashCode()
このKeyCombination
のハッシュ・コード値を返します。static KeyCombination
keyCombination(String name)
指定された文字列から新しいKeyCombination
を構築します。boolean
match(KeyEvent event)
このキーの組合せが、指定されたKeyEvent
での組合せに一致するかどうかをテストします。String
toString()
このオブジェクトの文字列表現を返します。static KeyCombination
valueOf(String value)
指定された文字列から新しいKeyCombination
を構築します。
-
-
-
フィールドの詳細
-
SHIFT_DOWN
public static final KeyCombination.Modifier SHIFT_DOWN
[Shift]
キーを下にする必要があることを指定する修飾子。
-
SHIFT_ANY
public static final KeyCombination.Modifier SHIFT_ANY
[Shift]
キーを上下いずれかにできることを指定する修飾子。
-
CONTROL_DOWN
public static final KeyCombination.Modifier CONTROL_DOWN
[Ctrl]
キーを下にする必要があることを指定する修飾子。
-
CONTROL_ANY
public static final KeyCombination.Modifier CONTROL_ANY
[Ctrl]
キーを上下いずれかにできることを指定する修飾子。
-
ALT_DOWN
public static final KeyCombination.Modifier ALT_DOWN
[Alt]
キーを下にする必要があることを指定する修飾子。
-
ALT_ANY
public static final KeyCombination.Modifier ALT_ANY
[Alt]
キーを上下いずれかにできることを指定する修飾子。
-
META_DOWN
public static final KeyCombination.Modifier META_DOWN
[Meta]
キーを下にする必要があることを指定する修飾子。
-
META_ANY
public static final KeyCombination.Modifier META_ANY
[Meta]
キーを上下いずれかにできることを指定する修飾子。
-
SHORTCUT_DOWN
public static final KeyCombination.Modifier SHORTCUT_DOWN
[Shortcut]
キーを下にする必要があることを指定する修飾子。
-
SHORTCUT_ANY
public static final KeyCombination.Modifier SHORTCUT_ANY
[Shortcut]
キーを上下いずれかにできることを指定する修飾子。
-
NO_MATCH
public static final KeyCombination NO_MATCH
どのイベントにも一致しないKeyCombination。
-
-
コンストラクタの詳細
-
KeyCombination
protected KeyCombination(KeyCombination.ModifierValue shift, KeyCombination.ModifierValue control, KeyCombination.ModifierValue alt, KeyCombination.ModifierValue meta, KeyCombination.ModifierValue shortcut)
すべての修飾子キーを明示的に指定してKeyCombination
を構築します。 各修飾子キーは、DOWN
、UP
またはANY
に設定できます。- パラメータ:
shift
-shift
修飾子キーの値control
-ctrl
修飾子キーの値alt
-alt
修飾子キーの値meta
-meta
修飾子キーの値shortcut
-shortcut
修飾子キーの値
-
KeyCombination
protected KeyCombination(KeyCombination.Modifier... modifiers)
指定された修飾子リストでKeyCombination
を構築します。 明示的にリストされていないすべての修飾子キーは、デフォルトのUP
値に設定されます。デフォルトの修飾子値を変更できる可能性があるすべての修飾子は、
KeyCombination
クラスに定数として定義されます。- パラメータ:
modifiers
- 修飾子キーとその対応する値のリスト
-
-
メソッドの詳細
-
getShift
public final KeyCombination.ModifierValue getShift()
このキーの組合せの[Shift]
キーの状態。- 戻り値:
- このキーの組合せの
[Shift]
キーの状態。
-
getControl
public final KeyCombination.ModifierValue getControl()
このキーの組合せの[Ctrl]
キーの状態。- 戻り値:
- このキーの組合せの
[Ctrl]
キーの状態。
-
getAlt
public final KeyCombination.ModifierValue getAlt()
このキーの組合せの[Alt]
キーの状態。- 戻り値:
- このキーの組合せの
[Alt]
キーの状態。
-
getMeta
public final KeyCombination.ModifierValue getMeta()
このキーの組合せの[Meta]
キーの状態。- 戻り値:
- このキーの組合せの
[Meta]
キーの状態。
-
getShortcut
public final KeyCombination.ModifierValue getShortcut()
このキーの組合せの[Shortcut]
キーの状態。- 戻り値:
- このキーの組合せの
[Shortcut]
キーの状態。
-
match
public boolean match(KeyEvent event)
このキーの組合せが、指定されたKeyEvent
での組合せに一致するかどうかをテストします。KeyCombination
クラスに実装されているこのメソッドは、修飾子キーに関するテストの一部のみを実行します。 テストに主要なキーを含めるには、このメソッドをサブクラスでオーバーライドします。- パラメータ:
event
- キー・イベント- 戻り値:
- キーの組合せが一致した場合は
true
、それ以外の場合はfalse
-
getName
public String getName()
このKeyCombination
の文字列表現を返します。文字列表現は、プラス文字で区切られたセクションで構成されています。 各セクションでは、修飾子キーまたは主要なキーを指定します。
修飾子キー・セクションには、修飾子キーの
KeyCode
名が含まれています。 接頭辞としてIgnored
キーワードを付けることができます。 接頭辞のない修飾子キーはDOWN
値を暗黙的に示し、接頭辞付きのバージョンはANY
(IGNORED)値を暗黙的に示します。 修飾子キーが文字列に1つも指定されていない場合は、デフォルトのUP
値が設定されます。キーの組合せ文字列の主要なキー・セクションの形式は、
KeyCombination
サブクラスによって異なります。KeyCodeCombination
のキー・コード名か、KeyCharacterCombination
の一重引用符で囲まれたキー文字のいずれかになります。KeyCombination
文字列表現の例:"Ctrl+Alt+Q" "Ignore Shift+Ctrl+A" "Alt+'w'"
- 戻り値:
- この
KeyCombination
の文字列表現
-
getDisplayText
public String getDisplayText()
ユーザー・インタフェースでの表示(たとえば、メニュー・アイテムの横)に適したこのKeyCombination
の文字列表現を返します。- 戻り値:
- ユーザー・インタフェースでの表示に適した、この
KeyCombination
の文字列表現 - 導入されたバージョン:
- JavaFX 8u20
-
equals
public boolean equals(Object obj)
このKeyCombination
が指定されたオブジェクトと同じであるかどうかをテストします。- オーバーライド:
equals
、クラス:Object
- パラメータ:
obj
- 比較対象のオブジェクト- 戻り値:
- オブジェクトが等しい場合は
true
、そうでない場合はfalse
- 関連項目:
Object.hashCode()
、HashMap
-
hashCode
public int hashCode()
このKeyCombination
のハッシュ・コード値を返します。- オーバーライド:
hashCode
、クラス:Object
- 戻り値:
- ハッシュ・コード値
- 関連項目:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
toString
public String toString()
このオブジェクトの文字列表現を返します。 実装は、getName()
呼出しの結果を返します。
-
valueOf
public static KeyCombination valueOf(String value)
指定された文字列から新しいKeyCombination
を構築します。 文字列は、getName
メソッドによって生成されたものと同じ形式である必要があります。主要なキー・セクション文字列が一重引用符で囲まれている場合、メソッドは引用符で囲まれていない部分文字列用に新しい
KeyCharacterCombination
を作成します。 それ以外の場合、名前が主要なキー・セクション文字列に対応しているキー・コードを探し、そのコード用にKeyCodeCombination
を作成します。 これが行えない場合は、かわりにKeyCharacterCombination
が使用されます。- パラメータ:
value
- 要求されたキーの組合せを表す文字列- 戻り値:
- 構築された
KeyCombination
- 導入されたバージョン:
- JavaFX 2.1
-
keyCombination
public static KeyCombination keyCombination(String name)
指定された文字列から新しいKeyCombination
を構築します。 このメソッドは単にvalueOf(String)
に委任されます。- パラメータ:
name
- 要求されたキーの組合せを表す文字列- 戻り値:
- 構築された
KeyCombination
- 関連項目:
valueOf(String)
-
-