Класс KeyCombination

java.lang.Object

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

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.

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

Часть клавиши-модификатора содержит имя клавиши-модификатора. Она может быть префиксна словом KeyCode. Непрефиксная клавиша-модификатор подразумевает ее значение 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.