Класс AWTKeyStroke

Все реализованные интерфейсы:
Serializable
Непосредственные известные подклассы:
KeyStroke
public class AWTKeyStroke
extends Object
implements Serializable

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

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

C момента:
1.4
См. также:
getAWTKeyStroke(char), Сериализованная форма

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

Модификатор Конструктор Описание
protected AWTKeyStroke()

Создаёт AWTKeyStroke с значениями по умолчанию.
protected AWTKeyStroke​(char keyChar, int keyCode, int modifiers, boolean onKeyRelease)

Создаёт AWTKeyStroke со специфицированными значениями.

Методы

Модификатор и тип Метод Описание
boolean equals​(Object anObject)

Возвращает true, если этот объект идентичен указанному объекту.
static AWTKeyStroke getAWTKeyStroke​(char keyChar)

Возвращает общий экземпляр AWTKeyStroke, представляющий событие KEY_TYPED для указанного символа.
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, представляющий событие KEY_TYPED для указанного объекта Character и набора модификаторов.
static AWTKeyStroke getAWTKeyStroke​(String s)

Парсит строку и возвращает AWTKeyStroke.
static AWTKeyStroke getAWTKeyStrokeForEvent​(KeyEvent anEvent)

Возвращает AWTKeyStroke, который представляет нажатие клавиши, породившее данное KeyEvent.
char getKeyChar()

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

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

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

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

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

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

Возвращает кэшированный экземпляр AWTKeyStroke (или подкласса AWTKeyStroke) который равен этому экземпляру.
protected static void registerSubclass​(Class<?> subclass)

Устаревший.
String toString()

Возвращает строку, отображающую и идентифицирующую свойства этого объекта.

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

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

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

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

@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
См. также:
InputEvent

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 для этой клавиши
См. также:
KeyEvent, InputEvent

getAWTKeyStroke

public static AWTKeyStroke getAWTKeyStroke(int keyCode,
                                           int modifiers)

Возвращает общий экземпляр AWTKeyStroke, заданный числовым кодом клавиши и набором модификаторов. Возвращённый 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.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 - побитовое или комбинация любых модификаторов
Возвращает:
объект AWTKeyStroke для этой клавиши
См. также:
KeyEvent, InputEvent

getAWTKeyStrokeForEvent

public static AWTKeyStroke getAWTKeyStrokeForEvent(KeyEvent anEvent)

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

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

Параметры:
anEvent - событие KeyEvent, из которого извлекается 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 - если возникла проблема с сериализацией

© 1993, 2020, 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/11/docs/api/java.desktop/java/awt/AWTKeyStroke.html

Spec-Zone .ru
спецификации, руководства, описания, API