Класс KeyStroke

public class KeyStroke
extends AWTKeyStroke

Класс KeyStroke представляет собой действие клавиши на клавиатуре или эквивалентном устройстве ввода. KeyStrokes могут соответствовать только нажатию или отпусканию определённой клавиши, так же, как и события KEY_PRESSED и KEY_RELEASED; альтернативно, они могут соответствовать вводу определённого символа Java, как и события KEY_TYPED. Во всех случаях, KeyStrokes могут указывать модификаторы (alt, shift, control, meta, altGraph или их комбинацию), которые должны быть присутствовать во время действия для точного соответствия.

KeyStrokes используются для определения событий действий высокого уровня (семантических). Вместо захвата каждого нажатия клавиши и отбрасывания ненужных, важные нажатия автоматически инициируют действия на компонентах, с которыми они зарегистрированы.

KeyStrokes неизменяемы и предполагаются уникальными. Код клиента не может создать KeyStroke; вместо этого необходимо использовать вариант getKeyStroke. Эти методы-фабрики позволяют реализации KeyStroke эффективно кэшировать и использовать экземпляры.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими выпусками Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. С версии 1.4 добавлена поддержка долгосрочного хранения всех JavaBeans™ в пакете java.beans. См. XMLEncoder.

Методы

getKeyStroke

public static KeyStroke getKeyStroke(char keyChar)

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

Параметры:

keyChar — значение символа для клавиши клавиатуры

Возвращает:

объект KeyStroke для этой клавиши

getKeyStroke

@Deprecated
public static KeyStroke getKeyStroke(char keyChar,
                                                 boolean onKeyRelease)

Устаревшее. Используйте getKeyStroke(char).

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

Параметры:

keyChar — значение символа для клавиши клавиатуры

onKeyRelease — true, если этот KeyStroke соответствует отпусканию клавиши; false в противном случае.

Возвращает:

объект KeyStroke для этой клавиши

getKeyStroke

public static KeyStroke getKeyStroke(Character keyChar,
                                     int modifiers)

Возвращает общий экземпляр KeyStroke, представляющий событие KEY_TYPED для указанного объекта Character и набора модификаторов. Обратите внимание, что первый параметр имеет тип Character, а не char. Это для предотвращения непреднамеренных конфликтов с вызовами getKeyStroke(int keyCode, int modifiers). Модификаторы состоят из любой комбинации следующих:

• java.awt.event.InputEvent.SHIFT_DOWN_MASK
• java.awt.event.InputEvent.CTRL_DOWN_MASK
• java.awt.event.InputEvent.META_DOWN_MASK
• java.awt.event.InputEvent.ALT_DOWN_MASK
• java.awt.event.InputEvent.ALT_GRAPH_DOWN_MASK

Старые модификаторы, перечисленные ниже, также могут быть использованы, но они отображаются на модификаторы _DOWN_.

• java.awt.event.InputEvent.SHIFT_MASK
• java.awt.event.InputEvent.CTRL_MASK
• java.awt.event.InputEvent.META_MASK
• java.awt.event.InputEvent.ALT_MASK
• java.awt.event.InputEvent.ALT_GRAPH_MASK

также могут быть использованы, но они отображаются на модификаторы _DOWN_. Поскольку эти числа — все разные степени двойки, любая комбинация из них является целым числом, в котором каждый бит представляет собой отдельную клавишу модификатора. Используйте 0 для указания отсутствия модификаторов.

Параметры:

keyChar — объект Character для символа клавиатуры

modifiers — комбинация модификаторов, объединённых побитовым ИЛИ

Возвращает:

объект KeyStroke для этой клавиши

Исключения:

IllegalArgumentException — если keyChar равен null

С:

1.3

См. также:

InputEvent

getKeyStroke

public static KeyStroke getKeyStroke(int keyCode,
                                     int modifiers,
                                     boolean onKeyRelease)

Параметры:

keyCode — целое число, определяющее числовой код клавиши клавиатуры

modifiers — комбинация модификаторов, объединённых побитовым ИЛИ

onKeyRelease — true если KeyStroke должен представлять отпускание клавиши; false в противном случае.

Возвращает:

объект KeyStroke для этой клавиши

См. также:

KeyEvent, InputEvent

getKeyStroke

public static KeyStroke getKeyStroke(int keyCode,
                                     int modifiers)

Параметры:

keyCode — целое число, определяющее числовой код клавиши клавиатуры

modifiers — комбинация модификаторов, объединённых побитовым ИЛИ

Возвращает:

объект KeyStroke для этой клавиши

См. также:

KeyEvent, InputEvent

getKeyStrokeForEvent

public static KeyStroke getKeyStrokeForEvent(KeyEvent anEvent)

Параметры:

anEvent — KeyEvent, из которого необходимо получить KeyStroke

Возвращает:

KeyStroke, который спровоцировал событие

Исключения:

NullPointerException — если anEvent равен null

getKeyStroke

public static KeyStroke getKeyStroke(String s)

Парсит строку и возвращает KeyStroke. Строка должна иметь следующий синтаксис:

<modifiers>* (<typedID> | <pressedReleasedID>)

    modifiers := shift | control | ctrl | meta | alt | altGraph
    typedID := typed <typedKey>
    typedKey := string of length 1 giving Unicode character.
    pressedReleasedID := (pressed | released) key
    key := KeyEvent key code name, i.e. the name following "VK_".

Если нажатие, нажатие или отпускание не указаны, предполагается нажатие. Вот некоторые примеры:

"INSERT" => getKeyStroke(KeyEvent.VK_INSERT, 0);
     "control DELETE" => getKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK);
     "alt shift X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK);
     "alt shift released X" => getKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true);
     "typed a" => getKeyStroke('a');

Для поддержания обратной совместимости указание null-строки или строки с неправильным форматом возвращает null.

Параметры:

s — строка, отформатированная как описано выше

Возвращает:

объект KeyStroke для этой строки или null, если указанная строка равна null или отформатирована неправильно

См. также:

KeyEvent