Класс AWTKeyStroke

java.lang.Object

java.awt.AWTKeyStroke

Все реализованные интерфейсы:: Serializable

Непосредственные известные подклассы:: KeyStroke

public class AWTKeyStroke extends Object implements Serializable

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

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

С момента:

1.4

См. также:

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

AWTKeyStroke()

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

Модификатор	Конструктор	Описание
`protected`	Создает объект AWTKeyStroke со значениями по умолчанию.
`protected`	Создает объект AWTKeyStroke со значениями, указанными в параметрах.

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

Модификатор и тип	Метод	Описание
`final boolean`	`equals(Object anObject)`	Возвращает true, если этот объект идентичен указанному объекту.
`static AWTKeyStroke`	`getAWTKeyStroke(char keyChar)`	Возвращает общий экземпляр AWTKeyStroke, представляющий событие ввода символа для указанного символа.
`static AWTKeyStroke`	`getAWTKeyStroke(int keyCode, int modifiers)`	Возвращает общий экземпляр AWTKeyStroke, заданный кодом числовой клавиши и набором модификаторов.
`static AWTKeyStroke`	`getAWTKeyStroke(int keyCode, int modifiers, boolean onKeyRelease)`	Возвращает общий экземпляр AWTKeyStroke, заданный кодом числовой клавиши и набором модификаторов, определяя активируется ли клавиша при нажатии или отпускании.
`static AWTKeyStroke`	`getAWTKeyStroke(Character keyChar, int modifiers)`	Возвращает общий экземпляр AWTKeyStroke, представляющий событие ввода символа для указанного объекта Character и набора модификаторов.
`static AWTKeyStroke`	`getAWTKeyStroke(String s)`	Парсит строку и возвращает AWTKeyStroke.
`static AWTKeyStroke`	`getAWTKeyStrokeForEvent(KeyEvent anEvent)`	Возвращает AWTKeyStroke, который представляет нажатие, породившее заданное событие.
`final char`	`getKeyChar()`	Возвращает символ для этого объекта AWTKeyStroke.
`final int`	`getKeyCode()`	Возвращает числовой код клавиши для этого объекта AWTKeyStroke.
`final int`	`getKeyEventType()`	Возвращает тип события, которому соответствует этот объект AWTKeyStroke.
`final int`	`getModifiers()`	Возвращает модификаторы клавиш для этого объекта AWTKeyStroke.
`int`	`hashCode()`	Возвращает числовое значение для этого объекта, которое, вероятно, будет уникальным, что делает его хорошим выбором для значения индекса в хеш-таблице.
`final boolean`	`isOnKeyRelease()`	Возвращает, представляет ли этот объект AWTKeyStroke отпускание клавиши.
`protected Object`	`readResolve()`	Возвращает кэшированный экземпляр AWTKeyStroke (или подкласс AWTKeyStroke), который равен этому экземпляру.
`protected static void`	`registerSubclass(Class<?> subclass)`	Deprecated.
`String`	`toString()`	Возвращает строку, отображающую и идентифицирующую свойства этого объекта.

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

AWTKeyStroke

protected AWTKeyStroke()

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

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

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

См. также:

AWTKeyStroke

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

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

Параметры:

keyChar - значение символа для клавиши

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

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

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

См. также:

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

registerSubclass

@Deprecated protected static void registerSubclass(Class<?> subclass)

Устаревшее.

Метод не оказывает эффекта и оставлен только для предотвращения бинарной несовместимости.

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

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

См. также:

getAWTKeyStroke

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

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

Константы «виртуальной клавиши», определённые в java.awt.event.KeyEvent, могут быть использованы для указания кода клавиши. Например:

java.awt.event.KeyEvent.VK_ENTER
java.awt.event.KeyEvent.VK_TAB
java.awt.event.KeyEvent.VK_SPACE

В качестве альтернативы, код клавиши может быть получен путём вызова java.awt.event.KeyEvent.getExtendedKeyCodeForChar. Модификаторы представляют собой любое сочетание:

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

Старые модификаторы

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 для указания отсутствия модификаторов.

Параметры:

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

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

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

Возвращает:

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

См. также:

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(int keyCode, int modifiers)

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

java.awt.event.KeyEvent.VK_ENTER
java.awt.event.KeyEvent.VK_TAB
java.awt.event.KeyEvent.VK_SPACE

Модификаторы представляют собой любое сочетание:

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

Старые модификаторы

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

Параметры:

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

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

Возвращает:

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

См. также:

getAWTKeyStrokeForEvent

public static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent)

Возвращает AWTKeyStroke, который представляет нажатие, сгенерированное заданным KeyEvent.

Этот метод получает keyChar из события KeyTyped и keyCode из события KeyPressed или KeyReleased. Модификаторы KeyEvent получаются для всех трёх типов KeyEvent.

Параметры:: anEvent - KeyEvent событие, из которого нужно получить нажатие
Возвращает:: нажатие, которое вызвало событие
Исключения:: 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

См. также:

getKeyCode

public final int getKeyCode()

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

Возвращает:

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

См. также:

getModifiers

public final int getModifiers()

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

Returns:

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

См. также:

isOnKeyRelease

public final boolean isOnKeyRelease()

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

Returns:

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

См. также:

getKeyEventType

public final int getKeyEventType()

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

Returns:

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

См. также:

hashCode

public int hashCode()

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

Overrides:

hashCode в классе Object

Returns:

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

См. также:

equals

public final boolean equals(Object anObject)

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

Overrides:

equals в классе Object

Parameters:

anObject - объект для сравнения с этим объектом

Returns:

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

См. также:

toString

public String toString()

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

Overrides:

toString в классе Object

Returns:

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

См. также:

readResolve

protected Object readResolve() throws ObjectStreamException

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

Returns:: кэшированный экземпляр, равный этому экземпляру
Throws:: ObjectStreamException - если возникла проблема с сериализацией

© 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/java/awt/AWTKeyStroke.html