Интерфейс Keymap

public interface Keymap

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

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

Модификатор и тип	Метод	Описание
`void`	`addActionForKeyStroke(KeyStroke key, Action a)`	Добавляет связь в карту клавиш.
`Action`	`getAction(KeyStroke key)`	Возвращает действие, соответствующее заданной последовательности символьных событий.
`Action[]`	`getBoundActions()`	Возвращает все действия, определённые в этой карте клавиш.
`KeyStroke[]`	`getBoundKeyStrokes()`	Возвращает все нажатия клавиш в этой карте, привязанные к какому-либо действию.
`Action`	`getDefaultAction()`	Возвращает стандартное действие, которое выполняется при нажатии клавиши (т.е. при получении события KEY_TYPED KeyEvent), если для неё нет привязки. Как правило, это действие вставки текста, чтобы карта клавиш не требовала действия для каждой возможной клавиши.
`KeyStroke[]`	`getKeyStrokesForAction(Action a)`	Возвращает нажатия клавиш, которые приводят к данному действию.
`String`	`getName()`	Возвращает имя набора привязок клавиш.
`Keymap`	`getResolveParent()`	Возвращает родительскую карту клавиш, используемую для разрешения привязок клавиш.
`boolean`	`isLocallyDefined(KeyStroke key)`	Определяет, определена ли данная последовательность нажатий клавиш локально.
`void`	`removeBindings()`	Удаляет все привязки из карты клавиш.
`void`	`removeKeyStrokeBinding(KeyStroke keys)`	Удаляет привязку из карты клавиш.
`void`	`setDefaultAction(Action a)`	Устанавливает действие по умолчанию для выполнения при нажатии клавиши.
`void`	`setResolveParent(Keymap parent)`	Устанавливает родительскую карту клавиш, которая будет использоваться для разрешения привязок клавиш.

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

getName

String getName()

Возвращает имя набора привязок клавиш.

Возвращает:: имя

getDefaultAction

Action getDefaultAction()

Возвращает стандартное действие, которое выполняется при нажатии клавиши (т.е. при получении события KEY_TYPED KeyEvent), если для неё нет привязки. Как правило, это действие вставки текста, чтобы карта клавиш не требовала действия для каждой возможной клавиши.

Возвращает:: стандартное действие

setDefaultAction

void setDefaultAction(Action a)

Устанавливает действие по умолчанию для выполнения при нажатии клавиши.

Параметры:: a - действие

getAction

Action getAction(KeyStroke key)

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

Параметры:: key - последовательность нажатий клавиш
Возвращает:: действие, связанное с последовательностью нажатий клавиш, если оно определено, в противном случае null

getBoundKeyStrokes

KeyStroke[] getBoundKeyStrokes()

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

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

getBoundActions

Action[] getBoundActions()

Возвращает все действия, определённые в этой карте клавиш.

Возвращает:: список действий

getKeyStrokesForAction

KeyStroke[] getKeyStrokesForAction(Action a)

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

Параметры:: a - действие
Возвращает:: список нажатий клавиш

isLocallyDefined

boolean isLocallyDefined(KeyStroke key)

Определяет, определена ли данная последовательность нажатий клавиш локально.

Параметры:: key - последовательность нажатий клавиш
Возвращает:: true, если последовательность нажатий клавиш определена локально, иначе false

addActionForKeyStroke

void addActionForKeyStroke(KeyStroke key, Action a)

Добавляет привязку к карте клавиш.

Параметры:: key - последовательность нажатий клавиш; a - действие

removeKeyStrokeBinding

void removeKeyStrokeBinding(KeyStroke keys)

Удаляет привязку из карты клавиш.

Параметры:: keys - последовательность нажатий клавиш

removeBindings

void removeBindings()

Удаляет все привязки из карты клавиш.

getResolveParent

Keymap getResolveParent()

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

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

setResolveParent

void setResolveParent(Keymap parent)

Устанавливает родительскую карту клавиш, которая будет использоваться для разрешения привязок клавиш. Поведение не определено, если карта Keymap имеет себя в качестве одного из родительских элементов разрешения.

Параметры:: parent - родительская карта клавиш

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/Keymap.html