Класс InputMap

java.lang.Object

jfx.incubator.scene.control.input.InputMap

public final class InputMap extends Object

InputMap — свойство класса Control, которое позволяет настраивать его, создавая пользовательские сопоставления клавиш и обработчики событий.

Он служит мостом между элементом управления (Control) и его оформлением (Skin). InputMap предоставляет упорядоченный репозиторий обработчиков событий, взаимодействуя с картой ввода, управляемой оформлением, гарантируя порядок вызова обработчиков. Он также хранит сопоставления клавиш с аналогичной гарантией: сопоставления, заданные приложением, всегда имеют приоритет над сопоставлениями, созданными оформлением, независимо от времени создания или замены оформления.

Класс поддерживает следующие сценарии:

Сопоставление сочетания клавиш с функцией
Удаление сочетания клавиш
Сопоставление новой функции с существующим сочетанием клавиш
Получение функции по умолчанию
Обеспечение приоритета сопоставлений клавиш приложения над сопоставлениями, созданными оформлением

Для сопоставления клавиш используется двухступенчатый поиск. Сначала событие нажатия клавиши сопоставляется с FunctionTag, определяющим функцию, предоставленную либо оформлением, либо связанным поведением (функция «по умолчанию»), либо приложением. Если такое сопоставление найдено, найденный тег функции сопоставляется с функцией, зарегистрированной приложением или оформлением.

Кроме того, метод register(KeyBinding, Runnable) позволяет напрямую сопоставить сочетание клавиш с функцией, минуя тег функции.

Этот механизм позволяет настраивать сопоставления клавиш и подлежащие функции независимо и раздельно.

Since:: 24

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

Конструктор	Описание
`InputMap(Control control)`	Конструктор.

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

Модификатор и тип	Метод	Описание
`<T extends Event> void`	`addHandler(EventType<T> type, EventHandler<T> handler)`	Добавляет обработчик события для указанного типа события.
`void`	`disableKeyBinding(KeyBinding k)`	Отключает указанное сочетание клавиш.
`Set<KeyBinding>`	`getKeyBindings()`	Собраны все сопоставленные сочетания клавиш.
`Set<KeyBinding>`	`getKeyBindingsFor(FunctionTag tag)`	Возвращает набор сочетаний клавиш, сопоставленных с указанным тегом функции.
`void`	`register(KeyBinding k, Runnable function)`	Регистрирует функцию для данного сочетания клавиш.
`void`	`registerFunction(FunctionTag tag, Runnable function)`	Добавляет (или перезаписывает) пользовательскую функцию под данным тегом функции.
`void`	`registerKey(KeyBinding k, FunctionTag tag)`	Связывает сочетание клавиш с указанным тегом функции.
`<T extends Event> void`	`removeHandler(EventType<T> type, EventHandler<T> handler)`	Удаляет указанный обработчик.
`void`	`removeKeyBindingsFor(FunctionTag tag)`	Удаляет все сочетания клавиш, сопоставленные с указанным тегом функции, как приложением, так и оформлением.
`void`	`resetKeyBindings()`	Отменяет все сочетания клавиш, заданные пользователем.
`void`	`restoreDefaultFunction(FunctionTag tag)`	Восстанавливает указанный тег функции до значения, установленного оформлением, если таковое есть.
`void`	`restoreDefaultKeyBinding(KeyBinding k)`	Восстанавливает указанное сочетание клавиш до значения, установленного оформлением, если таковое есть.

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

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

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

InputMap

public InputMap(Control control)

Конструктор.

Параметры:: control - управляющий элемент

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

addHandler

public <T extends Event> void addHandler(EventType<T> type, EventHandler<T> handler)

Добавляет обработчик события для указанного типа события. Обработчики событий, добавленные с помощью этого метода, всегда будут вызываться перед любыми обработчиками, зарегистрированными кожей.

Параметры типа:: T - фактический тип события
Параметры:: type - тип события; handler - обработчик события

removeHandler

public <T extends Event> void removeHandler(EventType<T> type, EventHandler<T> handler)

Удаляет указанный обработчик.

Параметры типа:: T - класс события
Параметры:: type - тип события; handler - обработчик для удаления

register

public void register(KeyBinding k, Runnable function)

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

Параметры:: k - сочетание клавиш; function - функция

registerFunction

public void registerFunction(FunctionTag tag, Runnable function)

Добавляет (или перезаписывает) пользовательскую функцию под заданной меткой функции. Эта функция будет иметь приоритет над любой функцией по умолчанию, заданной кожей.

Параметры:: tag - метка функции; function - функция

registerKey

public void registerKey(KeyBinding k, FunctionTag tag)

Связывает сочетание клавиш со заданной меткой функции. Когда сочетание клавиш совпадает с событием ввода, функция выполняется, событие потребляется, и процесс диспетчеризации останавливается.

Этот метод будет иметь приоритет над любой функцией по умолчанию, заданной кожей.

Параметры:: k - сочетание клавиш; tag - метка функции

disableKeyBinding

public void disableKeyBinding(KeyBinding k)

Отключает указанное сочетание клавиш. Вызов этого метода отключит все отображения, созданные с помощью register(KeyBinding, Runnable), registerKey(KeyBinding, FunctionTag), или зарегистрированные кожей.

Параметры:: k - сочетание клавиш

resetKeyBindings

public void resetKeyBindings()

Возвращает все сочетания клавиш, установленные пользователем. Этот метод восстанавливает сочетания клавиш, установленные кожей, которые были перезаписаны пользователем.

restoreDefaultKeyBinding

public void restoreDefaultKeyBinding(KeyBinding k)

Восстанавливает указанное сочетание клавиш до значения, установленного кожей, если таковое имеется.

Параметры:: k - сочетание клавиш

restoreDefaultFunction

public void restoreDefaultFunction(FunctionTag tag)

Восстанавливает указанную метку функции до значения, установленного кожей, если таковое имеется.

Параметры:: tag - метка функции

getKeyBindings

public Set<KeyBinding> getKeyBindings()

Собирает все сопоставленные сочетания клавиш.

Возвращает:: набор сочетаний клавиш

getKeyBindingsFor

public Set<KeyBinding> getKeyBindingsFor(FunctionTag tag)

Возвращает набор сочетаний клавиш, сопоставленных с указанной меткой функции.

Параметры:: tag - метка функции
Возвращает:: набор KeyBindings, не null

removeKeyBindingsFor

public void removeKeyBindingsFor(FunctionTag tag)

Удаляет все сочетания клавиш, сопоставленные с указанной меткой функции, как приложением, так и кожей. Это необратимая операция.

Параметры:: tag - метка функции

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