Интерфейс Keymap

public interface Keymap

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

Методы

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

Методы

getName

String getName()

Получает имя набора привязок клавиш.

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

getDefaultAction

Action getDefaultAction()

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

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

setDefaultAction

void setDefaultAction(Action a)

Устанавливает стандартное действие при нажатии клавиши.

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

getAction

Action getAction(KeyStroke key)

Получает действие, соответствующее заданной последовательности символьных событий. Это используется JTextController для определения того, как интерпретировать последовательности нажатий клавиш. Если привязка не разрешается локально, делается попытка разрешения через родительский keymap, если он установлен.

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

getBoundKeyStrokes

KeyStroke[] getBoundKeyStrokes()

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

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

getBoundActions

Action[] getBoundActions()

Получает все действия, определённые в этом keymap.

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

getKeyStrokesForAction

KeyStroke[] getKeyStrokesForAction(Action a)

Получает последовательности нажатий клавиш, которые приведут к заданному действию.

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

isLocallyDefined

boolean isLocallyDefined(KeyStroke key)

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

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

addActionForKeyStroke

void addActionForKeyStroke(KeyStroke key,
                           Action a)

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

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

removeKeyStrokeBinding

void removeKeyStrokeBinding(KeyStroke keys)

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

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

removeBindings

void removeBindings()

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

getResolveParent

Keymap getResolveParent()

Получает родительский keymap, используемый для разрешения привязок клавиш.

Возвращает:: keymap

setResolveParent

void setResolveParent(Keymap parent)

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

Параметры:: parent - родительский keymap