Класс KeyBinding

java.lang.Object

jfx.incubator.scene.control.input.KeyBinding

public class KeyBinding extends Object

Этот неизменяемый класс представляет собой комбинацию клавиш, используемых в сопоставлениях клавиш. Комбинация клавиш состоит из основной клавиши и набора модификаторов. Основную клавишу можно указать по её key code или символу клавиши, последний должен соответствовать значениям, возвращаемым KeyEvent.getCharacter(). Модификатор клавиши — это shift, control, alt, meta или shortcut.

Этот класс также предоставляет набор удобных методов для указания клавиш, встречающихся на платформах macOS.

С:: 24

Краткое описание вложенных классов

Модификатор и тип	Класс	Описание
`static class`	`KeyBinding.Builder`	Построитель объектов `KeyBinding`.

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

Модификатор и тип	Метод	Описание
`static KeyBinding`	`alt(KeyCode code)`	Создаёт KeyBinding, соответствующий нажатию клавиши с указанным `KeyCode` и модификатором клавиши `alt` (`option` на macOS).
`static KeyBinding.Builder`	`builder(String character)`	Создаёт `KeyBinding.Builder` с указанным символом.
`static KeyBinding.Builder`	`builder(KeyCode code)`	Создаёт `KeyBinding.Builder` с указанным `KeyCode`.
`static KeyBinding`	`command(KeyCode code)`	Этот вспомогательный метод создаёт `KeyBinding`, соответствующий нажатию клавиши с указанным `KeyCode` и модификатором клавиши macOS `⌘ command`.
`static KeyBinding`	`control(KeyCode code)`	Создаёт KeyBinding, соответствующий нажатию клавиши с указанным `KeyCode` и модификатором клавиши `ctrl` (`control` на macOS).
`static KeyBinding`	`controlShift(KeyCode code)`	Создаёт KeyBinding, соответствующий нажатию клавиши с указанным `KeyCode` и модификатором клавиш `shift` + `ctrl` (`control` на macOS).
`KeyCode`	`getKeyCode()`	Возвращает `KeyCode` или null, если привязка клавиш не для кода клавиши.
`boolean`	`isKeyPressed()`	Определяет, соответствует ли эта привязка клавиш событию нажатия клавиши.
`boolean`	`isKeyReleased()`	Определяет, соответствует ли эта привязка клавиш событию отпускания клавиши.
`boolean`	`isKeyTyped()`	Определяет, соответствует ли эта привязка клавиш событию набора текста с клавиши.
`static KeyBinding`	`of(KeyCode code)`	Создаёт `KeyBinding`, соответствующий нажатию клавиши с указанным `KeyCode`.
`static KeyBinding`	`option(KeyCode code)`	Создаёт KeyBinding, соответствующий нажатию клавиши с указанным `KeyCode` и модификатором клавиши `option` на macOS.
`static KeyBinding`	`shift(KeyCode code)`	Создаёт KeyBinding, соответствующий нажатию клавиши с указанным `KeyCode` и модификатором клавиши `shift`.
`static KeyBinding`	`shiftOption(KeyCode code)`	Создаёт KeyBinding, соответствующий нажатию клавиши с указанным `KeyCode` и модификаторами клавиш `shift` + `option` на macOS.
`static KeyBinding`	`shiftShortcut(KeyCode code)`	Создаёт KeyBinding, соответствующий нажатию клавиши с указанным `KeyCode` и модификатором клавиши `shift` + модификатор быстрой клавиши (`⌘ command` на macOS, `ctrl` в остальных случаях).
`static KeyBinding`	`shortcut(KeyCode code)`	Создаёт KeyBinding, соответствующий нажатию клавиши с указанным `KeyCode` и модификатором быстрой клавиши (`⌘ command` на macOS, `ctrl` в остальных случаях).
`KeyBinding`	`withNewKeyCode(KeyCode newCode)`	Создаёт новый экземпляр `KeyBinding` с новым `KeyCode` и тем же набором модификаторов.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

of

public static KeyBinding of(KeyCode code)

Создаёт KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode.

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding

command

public static KeyBinding command(KeyCode code)

Этот вспомогательный метод создаёт объект KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode и модификатора клавиши Command на macOS.

На платформах, отличных от macOS, этот метод возвращает null.

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding или null

alt

public static KeyBinding alt(KeyCode code)

Создаёт объект KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode и модификатора клавиши Alt (Option на macOS).

Этот метод эквивалентен методу option(KeyCode) на macOS.

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding

control

public static KeyBinding control(KeyCode code)

Создаёт объект KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode и модификатора клавиши Ctrl (Control на macOS).

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding

controlShift

public static KeyBinding controlShift(KeyCode code)

Создаёт объект KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode и модификаторов клавиш Ctrl + Shift (Control + Shift на macOS).

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding

option

public static KeyBinding option(KeyCode code)

Создаёт объект KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode и модификатора клавиши Option на macOS.

На платформах, отличных от macOS, этот метод возвращает null. На macOS он эквивалентен вызову alt(KeyCode).

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding или null

shift

public static KeyBinding shift(KeyCode code)

Создаёт объект KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode и модификатора клавиши Shift.

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding

shortcut

public static KeyBinding shortcut(KeyCode code)

Создаёт объект KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode и модификатора клавиши Shortcut (Command на macOS, иначе).

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding

shiftOption

public static KeyBinding shiftOption(KeyCode code)

Создаёт объект KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode и модификаторов клавиш Shift + Option на macOS.

На платформах, отличных от macOS, этот метод возвращает null.

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding или null

shiftShortcut

public static KeyBinding shiftShortcut(KeyCode code)

Создаёт объект KeyBinding, соответствующий нажатию клавиши со значением указанного KeyCode и модификаторов клавиш Shift + Shortcut (Command на macOS, иначе).

Параметры:: code - код клавиши
Возвращает:: объект KeyBinding или null

withNewKeyCode

public KeyBinding withNewKeyCode(KeyCode newCode)

Создаёт новый экземпляр KeyBinding с новым KeyCode и теми же модификаторами.

Параметры:: newCode - код клавиши
Возвращает:: объект KeyBinding

isKeyPressed

public boolean isKeyPressed()

Определяет, относится ли эта привязка клавиш к событию нажатия клавиши.

Возвращает:: true, если эта привязка клавиш относится к событию нажатия клавиши

isKeyReleased

public boolean isKeyReleased()

Определяет, относится ли эта привязка клавиш к событию отпускания клавиши.

Возвращает:: true, если эта привязка клавиш относится к событию отпускания клавиши

isKeyTyped

public boolean isKeyTyped()

Определяет, относится ли эта привязка клавиш к событию ввода символа с клавиши.

Возвращает:: true, если эта привязка клавиш относится к событию ввода символа с клавиши

getKeyCode

public KeyCode getKeyCode()

Возвращает KeyCode или null, если привязка клавиш не связана с кодом клавиши.

Возвращает:: код клавиши или null

builder

public static KeyBinding.Builder builder(KeyCode code)

Создаёт объект KeyBinding.Builder с указанным KeyCode.

Параметры:: code - код клавиши
Возвращает:: экземпляр билдера

builder

public static KeyBinding.Builder builder(String character)

Создаёт объект KeyBinding.Builder с указанным символом. Строка должна соответствовать значению, возвращаемому методом KeyEvent.getCharacter().

Параметры:: character - символ
Возвращает:: экземпляр билдера

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