Класс 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, разработчики могут создавать независимые от платформы сочетания клавиш. Таким образом, сочетание "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` с явным указанием всех клавиш-модификаторов.

Краткое описание методов

...

Модификатор и тип	Метод	Описание

Методы, объявленные в классе 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

A KeyCombination, которая будет соответствовать без каких-либо событий.

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

KeyCombination

protected KeyCombination(KeyCombination.ModifierValue shift, KeyCombination.ModifierValue control, KeyCombination.ModifierValue alt, KeyCombination.ModifierValue meta, KeyCombination.ModifierValue shortcut)

Создаёт KeyCombination с явным указанием всех модификаторов. Каждый модификатор может быть установлен в значение DOWN, UP или ANY.

Parameters:: shift - значение модификатора shift; control - значение модификатора control; alt - значение модификатора alt; meta - значение модификатора meta; shortcut - значение модификатора shortcut

KeyCombination

protected KeyCombination(KeyCombination.Modifier... modifiers)

Создаёт KeyCombination со списком указанных модификаторов. Все модификаторы, которые не указаны явно, устанавливаются в значение по умолчанию UP.

Все возможные модификаторы, которые изменяют значение по умолчанию, определены как константы в классе KeyCombination.

Parameters:: modifiers - список модификаторов и их соответствующих значений

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

getShift

public final KeyCombination.ModifierValue getShift()

Состояние клавиши shift в этой комбинации клавиш.

Returns:: Состояние клавиши shift в этой комбинации клавиш

getControl

public final KeyCombination.ModifierValue getControl()

Состояние клавиши control в этой комбинации клавиш.

Returns:: Состояние клавиши control в этой комбинации клавиш

getAlt

public final KeyCombination.ModifierValue getAlt()

Состояние клавиши alt в этой комбинации клавиш.

Returns:: Состояние клавиши alt в этой комбинации клавиш.

getMeta

public final KeyCombination.ModifierValue getMeta()

Состояние клавиши meta в этой комбинации клавиш.

Returns:: Состояние клавиши meta в этой комбинации клавиш

getShortcut

public final KeyCombination.ModifierValue getShortcut()

Состояние клавиши shortcut в этой комбинации клавиш.

Returns:: Состояние клавиши shortcut в этой комбинации клавиш

match

public boolean match(KeyEvent event)

Проверяет, соответствует ли эта комбинация клавиш комбинации в данном KeyEvent.

Реализация этого метода в классе KeyCombination выполняет только частичную проверку с модификаторами. Этот метод переопределяется в подклассах для включения основной клавиши в проверку.

Parameters:: event - событие нажатия клавиши
Returns:: true, если комбинации клавиш совпадают, false в противном случае

getName

public String getName()

Возвращает строковое представление этой KeyCombination.

Строковое представление состоит из разделенных знаком «плюс» секций. Каждая секция указывает либо модификатор, либо основную клавишу.

Секция модификатора содержит имя модификатора. Она может быть префиксной с ключевым словом Ignored. Непрефиксный модификатор подразумевает его DOWN значение, в то время как префиксный подразумевает значение ANY (игнорируется). Если какой-либо модификатор не указан в строке, это означает, что он имеет значение по умолчанию UP.

Формат секции основной клавиши в строке комбинации клавиш зависит от подкласса KeyCombination. Это либо имя кода клавиши для KeyCodeCombination, либо символ клавиши в одинарных кавычках для KeyCharacterCombination.

Примеры строковых представлений KeyCombination:

"Ctrl+Alt+Q"
"Ignore Shift+Ctrl+A"
"Alt+'w'"

Returns:: строковое представление этой KeyCombination

getDisplayText

public String getDisplayText()

Возвращает строковое представление этой KeyCombination, подходящее для отображения в пользовательском интерфейсе (например, рядом с пунктом меню).

Returns:: Строковое представление этой KeyCombination, подходящее для отображения в пользовательском интерфейсе.
Since:: JavaFX 8u20

equals

public boolean equals(Object obj)

Проверяет, равна ли эта KeyCombination заданному объекту.

Overrides:: equals в классе Object
Parameters:: obj - объект для сравнения
Returns:: true, если объекты равны, false в противном случае

hashCode

public int hashCode()

Возвращает значение хэш-кода для этой KeyCombination.

Overrides:: hashCode в классе Object
Returns:: значение хэш-кода

toString

public String toString()

Возвращает строковое представление этого объекта. Реализация возвращает результат вызова getName().

Overrides:: toString в классе Object
Returns:: строковое представление этого KeyCombination

valueOf

public static KeyCombination valueOf(String value)

Создаёт новую KeyCombination из указанной строки. Строка должна иметь тот же формат, что и, производимый методом getName.

Если строка основной клавиши заключена в одинарные кавычки, метод создаёт новую KeyCharacterCombination для подстроки без кавычек. В противном случае он находит код клавиши, имя которой соответствует строке основной клавиши, и создаёт KeyCodeCombination для неё. Если это невозможно, он возвращается к значению по умолчанию KeyCharacterCombination.

Parameters:: value - строка, представляющая запрошенную комбинацию клавиш
Returns:: созданная KeyCombination
Since:: JavaFX 2.1

keyCombination

public static KeyCombination keyCombination(String name)

Создаёт новую KeyCombination из указанной строки. Этот метод просто делегирует вызову valueOf(String).

Parameters:: name - строка, представляющая запрошенную комбинацию клавиш
Returns:: созданная KeyCombination
See Also:: 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.