Spec-Zone.ru › OpenJDK 17

Класс AWTKeyStroke

java.lang.Object
java.awt.AWTKeyStroke
Все реализуемые интерфейсы:
Serializable
Прямые известные подклассы:
KeyStroke
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 эффективно кэшировать и разделять экземпляры.

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

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

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, который представляет событие 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.
final char getKeyChar()
Возвращает символ для данного объекта AWTKeyStroke.
final int getKeyCode()
Возвращает числовой код клавиши для данного объекта AWTKeyStroke.
final int getKeyEventType()
Возвращает тип события KeyEvent, соответствующий данному объекту AWTKeyStroke.
final int getModifiers()
Возвращает модификаторы клавиш для данного объекта AWTKeyStroke.
int hashCode()
Возвращает числовое значение для этого объекта, которое, скорее всего, будет уникальным, что делает его хорошим выбором в качестве значения индекса в хеш-таблице.
final 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 с значениями по умолчанию. Значения по умолчанию:
Значения по умолчанию 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()
Возвращает числовое значение для этого объекта, которое, скорее всего, будет уникальным, что делает его хорошим выбором в качестве значения индекса в хеш-таблице.
Overrides:
hashCode в классе Object
Возвращает:
целое число, представляющее этот объект
См. также:
  • Object.equals(java.lang.Object)
  • System.identityHashCode(java.lang.Object)

equals

public final boolean equals(Object anObject)
Возвращает true, если этот объект идентичен указанному объекту.
Overrides:
equals в классе Object
Параметры:
anObject - Объект для сравнения с этим объектом
Возвращает:
true, если объекты идентичны
См. также:
  • Object.hashCode()
  • HashMap

toString

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

readResolve

protected Object readResolve() throws ObjectStreamException
Возвращает кэшированный экземпляр AWTKeyStroke (или подкласс AWTKeyStroke), который равен этому экземпляру.
Возвращает:
кэшированный экземпляр, равный этому экземпляру
Исключения:
ObjectStreamException - если возникла проблема с сериализацией

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API