KeyCombination (JavaFX 8)

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`を構築します。

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

- フィールドの詳細
  - 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
  - hashCode
```
public int hashCode()
```
    このKeyCombinationのハッシュ・コード値を返します。
    
    オーバーライド:
    
    hashCode、クラスObject
    
    戻り値:
    
    ハッシュ・コード値
  - toString
```
public String toString()
```
    このオブジェクトの文字列表現を返します。実装は、getName()呼出しの結果を返します。
    
    オーバーライド:
    
    toString、クラスObject
    
    戻り値:
    
    このKeyCombinationの文字列表現
  - 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)

クラスKeyCombination

ネストされたクラスのサマリー

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

SHIFT_DOWN

SHIFT_ANY

CONTROL_DOWN

CONTROL_ANY

ALT_DOWN

ALT_ANY

META_DOWN

META_ANY

SHORTCUT_DOWN

SHORTCUT_ANY

NO_MATCH

コンストラクタの詳細

KeyCombination

KeyCombination

メソッドの詳細

getShift

getControl

getAlt

getMeta

getShortcut

match

getName

getDisplayText

equals

hashCode

toString

valueOf

keyCombination