Класс 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 final class`	`KeyCombination.Modifier`	Этот класс представляет пару клавиши-модификатора и её значения.
`static enum`	`KeyCombination.ModifierValue`	`ModifierValue` указывает состояние клавиш-модификаторов.

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final KeyCombination.Modifier`	`ALT_ANY`	Модификатор, указывающий, что клавиша `alt` может быть нажатой или отжатой.
`static final KeyCombination.Modifier`	`ALT_DOWN`	Модификатор, указывающий, что клавиша `alt` должна быть нажатой.
`static final KeyCombination.Modifier`	`CONTROL_ANY`	Модификатор, указывающий, что клавиша `control` может быть нажатой или отжатой.
`static final KeyCombination.Modifier`	`CONTROL_DOWN`	Модификатор, указывающий, что клавиша `control` должна быть нажатой.
`static final KeyCombination.Modifier`	`META_ANY`	Модификатор, указывающий, что клавиша `meta` может быть нажатой или отжатой.
`static final KeyCombination.Modifier`	`META_DOWN`	Модификатор, указывающий, что клавиша `meta` должна быть нажатой.
`static final KeyCombination`	`NO_MATCH`	Сочетание клавиш, которое не будет соответствовать никаким событиям.
`static final KeyCombination.Modifier`	`SHIFT_ANY`	Модификатор, указывающий, что клавиша `shift` может быть нажатой или отжатой.
`static final KeyCombination.Modifier`	`SHIFT_DOWN`	Модификатор, указывающий, что клавиша `shift` должна быть нажатой.
`static final KeyCombination.Modifier`	`SHORTCUT_ANY`	Модификатор, указывающий, что клавиша `shortcut` может быть нажатой или отжатой.
`static final KeyCombination.Modifier`	`SHORTCUT_DOWN`	Модификатор, указывающий, что клавиша `shortcut` должна быть нажатой.

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

KeyCombination(KeyCombination.Modifier... modifiers)

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

Модификатор	Конструктор	Описание
`protected`	Создаёт `KeyCombination` со списком указанных модификаторов.
`protected`	Создаёт `KeyCombination` с явным указанием всех клавиш-модификаторов.

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

Модификатор и тип	Метод	Описание
`boolean`	`equals(Object obj)`	Проверяет, равен ли этот `KeyCombination` заданному объекту.
`final KeyCombination.ModifierValue`	`getAlt()`	Состояние клавиши `alt` в этом сочетании клавиш.
`final KeyCombination.ModifierValue`	`getControl()`	Состояние клавиши `control` в этом сочетании клавиш.
`String`	`getDisplayText()`	Возвращает строковое представление этого `KeyCombination`, подходящее для отображения в пользовательском интерфейсе (например, рядом с пунктом меню).
`final KeyCombination.ModifierValue`	`getMeta()`	Состояние клавиши `meta` в этом сочетании клавиш.
`String`	`getName()`	Возвращает строковое представление этого `KeyCombination`.
`final KeyCombination.ModifierValue`	`getShift()`	Состояние клавиши `shift` в этом сочетании клавиш.
`final 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

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

Сочетание клавиш

public static KeyCombination keyCombination(String name)

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

Параметры:

name - строка, представляющая запрашиваемое сочетание клавиш

Возвращает:

созданный KeyCombination

См. также:

© 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.