javafx.scene.input

Класс KeyCombination

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 используется для представления клавиши-модификатора, которая обычно используется в сочетаниях клавиш на платформе хоста. Например, это control на Windows и meta (клавиша Command) на Mac. Используя модификатор клавиши shortcut, разработчики могут создавать независимые от платформы сочетания клавиш. Так, сочетание клавиш «Сочетание клавиш+C» обрабатывается внутри как «Ctrl+C» на Windows и «Meta+C» на Mac.

С тех пор:

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` Модификатор, указывающий, что клавиша `control` может быть как нажатой, так и отпущенной.
`static KeyCombination.Modifier`	`CONTROL_DOWN` Модификатор, указывающий, что клавиша `control` должна быть нажатой.
`static KeyCombination.Modifier`	`META_ANY` Модификатор, указывающий, что клавиша `meta` может быть как нажатой, так и отпущенной.
`static KeyCombination.Modifier`	`META_DOWN` Модификатор, указывающий, что клавиша `meta` должна быть нажатой.
`static KeyCombination`	`NO_MATCH` Сочетание клавиш, которое не будет соответствовать никаким событиям.
`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()` Состояние клавиши `control` в этом сочетании клавиш.
`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
```
  Модификатор, указывающий, что клавиша control должна быть нажата.
- CONTROL_ANY
```
public static final KeyCombination.Modifier CONTROL_ANY
```
  Модификатор, указывающий, что клавиша control может быть как нажата, так и отпущена.
- 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
```
protected KeyCombination(KeyCombination.ModifierValue shift,
                         KeyCombination.ModifierValue control,
                         KeyCombination.ModifierValue alt,
                         KeyCombination.ModifierValue meta,
                         KeyCombination.ModifierValue shortcut)
```
  Создаёт экземпляр KeyCombination с явным указанием всех модификаторов клавиш. Каждый модификатор может быть установлен в значение DOWN, UP или ANY.
  
  Параметры:
  
  shift - значение модификатора клавиши shift
- KeyCombination
```
protected KeyCombination(KeyCombination.Modifier... modifiers)
```
  Создаёт экземпляр KeyCombination со списком указанных модификаторов. Все модификаторы, не указанные явно, устанавливаются в значение по умолчанию UP.
  Все возможные модификаторы, изменяющие значение по умолчанию, определены как константы в классе KeyCombination.
  
  Параметры:
  
  modifiers - список модификаторов клавиш и их соответствующих значений

Подробное описание метода
- getShift
```
public final KeyCombination.ModifierValue getShift()
```
  Состояние клавиши shift в этом сочетании клавиш.
  
  Возвращает:
  
  Состояние клавиши shift в этом сочетании клавиш
- getControl
```
public final KeyCombination.ModifierValue getControl()
```
  Состояние клавиши control в этом сочетании клавиш.
  
  Возвращает:
  
  Состояние клавиши control в этом сочетании клавиш
- 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.
  Строковое представление состоит из разделенных символами '+' секций. Каждая секция указывает либо на модификатор клавиши, либо на основную клавишу.
  
  Секция модификатора содержит имя модификатора клавиши. Она может быть префиксной с использованием слова Ignored. Непрефиксный модификатор означает его значение по DOWN, в то время как префиксный означает значение ANY (игнорируется). Если какой-либо модификатор клавиши вообще не указан в строке, это означает, что он имеет значение по умолчанию 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)

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Класс 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