Класс AWTKeyStroke

public class AWTKeyStroke
extends Object
implements Serializable

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

AWTKeyStrokes являются неизменяемыми и предназначены для уникальности. Код клиента не должен создавать AWTKeyStroke самостоятельно, но вместо этого должен использовать вариант getAWTKeyStroke. Использование клиентом этих фабричных методов позволяет реализации AWTKeyStroke эффективно кэшировать и использовать экземпляры.

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

AWTKeyStroke

protected AWTKeyStroke()

Создаёт AWTKeyStroke с значениями по умолчанию. Значения по умолчанию:

Свойство	Значение по умолчанию
Символ клавиши	KeyEvent.CHAR_UNDEFINED
Код клавиши	KeyEvent.VK_UNDEFINED
Модификаторы	нет
При нажатии клавиши?	false

AWTKeyStroke не следует создавать в клиентском коде. Используйте вариант getAWTKeyStroke вместо этого.

См. также:

getAWTKeyStroke(char)

AWTKeyStroke

protected AWTKeyStroke(char keyChar,
                       int keyCode,
                       int modifiers,
                       boolean onKeyRelease)

Создаёт AWTKeyStroke со значениями, заданными по параметрам. AWTKeyStroke не следует создавать в клиентском коде. Используйте вариант getAWTKeyStroke вместо этого.

Параметры:

keyChar - значение символа на клавиатуре

keyCode - код клавиши для данного AWTKeyStroke

modifiers - битовое ИЛИ-соединение любых модификаторов

onKeyRelease - true если данное AWTKeyStroke соответствует отпусканию клавиши; false в противном случае

См. также:

getAWTKeyStroke(char)

Методы

registerSubclass

protected static void registerSubclass(Class<?> subclass)

Регистрирует новый класс, который методы-фабрики в AWTKeyStroke будут использовать при создании новых экземпляров AWTKeyStroke. После вызова этого метода методы-фабрики будут возвращать экземпляры указанного класса. Указанный класс должен быть либо AWTKeyStroke, либо производным от AWTKeyStroke, и должен иметь конструктор без аргументов. Конструктор может иметь любую доступность, включая private. Эта операция очищает кэш текущего AWTKeyStroke.

Параметры:

subclass - новый класс, экземпляры которого должны создавать методы-фабрики

Исключения:

IllegalArgumentException - если подкласс является null, или если подкласс не имеет конструктора без аргументов

ClassCastException - если подкласс не является AWTKeyStroke, или классом, производным от AWTKeyStroke

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(char keyChar)

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

Параметры:

keyChar - значение символа на клавиатуре

Возвращает:

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

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(Character keyChar,
                                           int modifiers)

Возвращает общий экземпляр AWTKeyStroke, представляющий событие KEY_TYPED для указанного объекта Character и набора модификаторов. Обратите внимание, что первый параметр имеет тип Character, а не char. Это для предотвращения непреднамеренных коллизий с вызовами getAWTKeyStroke(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 - битовое ИЛИ-соединение любых модификаторов

Возвращает:

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

Исключения:

IllegalArgumentException - если keyChar является null

См. также:

InputEvent

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(int keyCode,
                                           int modifiers,
                                           boolean onKeyRelease)

Параметры:

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

modifiers - битовое ИЛИ-соединение любых модификаторов

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

Возвращает:

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

См. также:

KeyEvent, InputEvent

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(int keyCode,
                                           int modifiers)

Параметры:

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

modifiers - битовое ИЛИ-соединение любых модификаторов

Возвращает:

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

См. также:

KeyEvent, InputEvent

getAWTKeyStrokeForEvent

public static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent)

Параметры:

anEvent - KeyEvent для получения AWTKeyStroke

Возвращает:

AWTKeyStroke , который привёл к событию

Исключения:

NullPointerException - если anEvent равно null

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(String s)

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

<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" => getAWTKeyStroke(KeyEvent.VK_INSERT, 0);
     "control DELETE" => getAWTKeyStroke(KeyEvent.VK_DELETE, InputEvent.CTRL_MASK);
     "alt shift X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK);
     "alt shift released X" => getAWTKeyStroke(KeyEvent.VK_X, InputEvent.ALT_MASK | InputEvent.SHIFT_MASK, true);
     "typed a" => getAWTKeyStroke('a');

Параметры:

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

Возвращает:

объект AWTKeyStroke для этой строки

Исключения:

IllegalArgumentException - если s является null, или отформатирован неправильно

getKeyChar

public final char getKeyChar()

Возвращает символ для этого AWTKeyStroke.

Возвращает:

значение типа char

См. также:

getAWTKeyStroke(char), KeyEvent.getKeyChar()

getKeyCode

public final int getKeyCode()

Возвращает числовой код клавиши для этого AWTKeyStroke.

Возвращает:

целое число, содержащее значение кода клавиши

См. также:

getAWTKeyStroke(int,int), KeyEvent.getKeyCode()

getModifiers

public final int getModifiers()

Возвращает клавиши модификатора для этого AWTKeyStroke.

Возвращает:

целое число, содержащее модификаторы

См. также:

getAWTKeyStroke(int,int)

isOnKeyRelease

public final boolean isOnKeyRelease()

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

Возвращает:

true если это AWTKeyStroke представляет отпускание клавиши; false в противном случае

См. также:

getAWTKeyStroke(int,int,boolean)

getKeyEventType

public final int getKeyEventType()

Возвращает тип KeyEvent, соответствующий этому AWTKeyStroke.

Возвращает:

KeyEvent.KEY_PRESSED, KeyEvent.KEY_TYPED, или KeyEvent.KEY_RELEASED

См. также:

KeyEvent

hashCode

public int hashCode()

Возвращает числовое значение для этого объекта, которое, вероятно, будет уникальным, что делает его хорошим выбором в качестве значения индекса в хеш-таблице.

Переопределяет:

hashCode в классе Object

Возвращает:

целое число, представляющее этот объект

См. также:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public final boolean equals(Object anObject)

Возвращает true, если этот объект идентичен указанному объекту.

Переопределяет:

equals в классе Object

Параметры:

anObject - объект, с которым следует сравнить этот объект

Возвращает:

true, если объекты идентичны

См. также:

Object.hashCode(), HashMap

toString

public String toString()

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

Переопределяет:

toString в классе Object

Возвращает:

строковое представление этого объекта

См. также:

getAWTKeyStroke(String)

readResolve

protected Object readResolve()
                      throws ObjectStreamException

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

Возвращает:

кэшированный экземпляр, равный этому экземпляру

Исключение:

ObjectStreamException