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 (клавиша команды) в Mac. Используя модификатор клавиши shortcut, разработчики могут создавать сочетания клавиш, независимые от платформы. Таким образом, сочетание клавиш "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`	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()`	Состояние клавиши `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
  
  control - значение модификаторной клавиши control
  
  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()
```
  Состояние клавиши 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.
  Строковое представление состоит из разделов, разделенных символами «плюс». Каждый раздел указывает либо модификаторную клавишу, либо основную клавишу.
  
  Раздел модификаторной клавиши содержит имя модификаторной клавиши. Он может быть префиксам словом KeyCode. Непрефиксная модификаторная клавиша подразумевает значение DOWN, тогда как префиксная версия подразумевает значение ANY (игнорируется). Если какая-либо модификаторная клавиша вообще не указана в строке, это означает, что она имеет значение по умолчанию UP.
  
  Формат раздела основной клавиши в строке сочетания клавиш зависит от подкласса KeyCombination. Это либо имя кода клавиши для KeyCodeCombination, либо символ клавиши в одинарных кавычках для KeyCharacterCombination.
  
  Примеры строковых представлений KeyCombination:
```
"Ctrl+Alt+Q"
"Ignore Shift+Ctrl+A"
"Alt+'w'"
```
  Возвращает:
  
  строковое представление этого KeyCombination
- getDisplayText
```
public String getDisplayText()
```
  Возвращает строковое представление этого KeyCombination, подходящее для отображения в пользовательском интерфейсе (например, рядом с пунктом меню).
  
  Возвращает:
  
  Строковое представление этого KeyCombination, подходящее для отображения в пользовательском интерфейсе.
  
  Since:
  
  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
  
  Since:
  
  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

Подробное описание методов

getShift

getControl

getAlt

getMeta

getShortcut

match

getName

getDisplayText

equals

hashCode

toString

valueOf

keyCombination