javafx.scene.input

Класс KeyEvent

java.lang.Object

java.util.EventObject
- javafx.event.Event
- - javafx.scene.input.InputEvent
  - - javafx.scene.input.KeyEvent

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

public final class KeyEvent
extends InputEvent

Событие, указывающее на нажатие клавиши в Node.

Это событие генерируется при нажатии, отпускании или вводе клавиши. В зависимости от типа события оно передаётся в функцию onKeyPressed, onKeyTyped или onKeyReleased.

События "ввода символа" имеют более высокий уровень и, как правило, не зависят от платформы или раскладки клавиатуры. Они генерируются при вводе символа Юникода и являются предпочтительным способом получения информации о вводе символов. В простом случае событие ввода символа генерируется одним нажатием клавиши (например, 'a'). Однако часто символы генерируются серией нажатий клавиш (например, SHIFT + 'a'), и отображение событий нажатия клавиш на события ввода символов может быть много-к-одному или много-к-многому. Отпускание клавиши обычно не требуется для генерации события ввода символа, но есть случаи, когда событие ввода символа не генерируется до отпускания клавиши (например, ввод ASCII-последовательностей через метод Alt-Numpad в Windows). События ввода символа не генерируются для клавиш, не генерирующих символы Юникода (например, управляющие клавиши, модификаторы и т. д.).

Переменная character всегда содержит допустимый(ые) символ(ы) Юникода или CHAR_UNDEFINED. Ввод символов отслеживается событиями ввода символов; события нажатия и отпускания клавиш не обязательно связаны с вводом символов. Поэтому переменная character гарантированно имеет смысл только для событий ввода символов.

Для событий нажатия и отпускания клавиш переменная code содержит код клавиши события. Для событий ввода символов переменная code всегда содержит KeyCode.UNDEFINED.

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

Для запуска контекстных меню см. ContextMenuEvent.

С тех пор:

JavaFX 2.0

См. также:

Форматированный вывод сериализованных данных

Краткое описание полей

Поля
Модификатор и тип	Поле и описание
`static EventType<KeyEvent>`	`ANY` Общий супертип для всех типов событий клавиш.
`static String`	`CHAR_UNDEFINED` События KEY_PRESSED и KEY_RELEASED, которые не отображаются в допустимый символ Юникода, используют его для значения keyChar.
`static EventType<KeyEvent>`	`KEY_PRESSED` Это событие возникает, когда клавиша была нажата.
`static EventType<KeyEvent>`	`KEY_RELEASED` Это событие возникает, когда клавиша была отпущена.
`static EventType<KeyEvent>`	`KEY_TYPED` Это событие возникает, когда нажата и отпущена клавиша, генерирующая символ.

Поля, унаследованные от класса javafx.event.Event
consumed, eventType, NULL_SOURCE_TARGET, target

Поля, унаследованные от класса java.util.EventObject
source

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

Конструкторы
Конструктор и описание
`KeyEvent(EventType<KeyEvent> eventType, String character, String text, KeyCode code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)` Создаёт новое событие KeyEvent с нулевым источником и целевым объектом и непосредственно указанным объектом KeyCode.
`KeyEvent(Object source, EventTarget target, EventType<KeyEvent> eventType, String character, String text, KeyCode code, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown)` Создаёт новое событие KeyEvent с нулевым источником и целевым объектом и непосредственно указанным объектом KeyCode.

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

Все методыМетоды экземпляровКонкретные методы
Модификатор и тип	Метод и описание
`KeyEvent`	`copyFor(Object newSource, EventTarget newTarget)` Создаёт и возвращает копию этого события с указанным источником и целевым объектом события.
`KeyEvent`	`copyFor(Object source, EventTarget target, EventType<KeyEvent> type)` Создаёт копию данного события с подставленными данными.
`String`	`getCharacter()` Символ или последовательность символов Юникода, связанные с событием ввода символа.
`KeyCode`	`getCode()` Код клавиши, связанный с клавишей в этом событии нажатия или отпускания клавиши.
`EventType<KeyEvent>`	`getEventType()` Возвращает тип события этого события.
`String`	`getText()` Строка, описывающая код клавиши, например, "HOME", "F1" или "A", для событий нажатия и отпускания клавиш.
`boolean`	`isAltDown()` Возвращает значение, указывающее, нажата ли клавиша Alt в этом событии.
`boolean`	`isControlDown()` Возвращает значение, указывающее, нажата ли клавиша Ctrl в этом событии.
`boolean`	`isMetaDown()` Возвращает значение, указывающее, нажата ли клавиша Meta в этом событии.
`boolean`	`isShiftDown()` Возвращает значение, указывающее, нажата ли клавиша Shift в этом событии.
`boolean`	`isShortcutDown()` Возвращает значение, указывающее, нажата ли клавиша-модификатор хост-платформы в этом событии.
`String`	`toString()` Возвращает строковое представление этого объекта `KeyEvent`.

Методы, унаследованные от класса javafx.event.Event
clone, consume, fireEvent, getTarget, isConsumed

Методы, унаследованные от класса java.util.EventObject
getSource

Методы, унаследованные от класса java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание поля
- ANY
```
public static final EventType<KeyEvent> ANY
```
  Общий супертип для всех типов событий клавиш.
- KEY_PRESSED
```
public static final EventType<KeyEvent> KEY_PRESSED
```
  Это событие возникает при нажатии клавиши.
- KEY_RELEASED
```
public static final EventType<KeyEvent> KEY_RELEASED
```
  Это событие возникает при отпускании клавиши.
- KEY_TYPED
```
public static final EventType<KeyEvent> KEY_TYPED
```
  Это событие возникает, когда нажата и отпущена клавиша, генерирующая символ. Событие содержит поле character, содержащее набранную строку; поля code и text не используются.
- CHAR_UNDEFINED
```
public static final String CHAR_UNDEFINED
```
  Для событий KEY_PRESSED и KEY_RELEASED, которые не соответствуют допустимому символу Юникода, используется значение keyChar.

Подробное описание конструкторов
- KeyEvent
```
public KeyEvent(Object source,
                EventTarget target,
                EventType<KeyEvent> eventType,
                String character,
                String text,
                KeyCode code,
                boolean shiftDown,
                boolean controlDown,
                boolean altDown,
                boolean metaDown)
```
  Создаёт новое событие KeyEvent с нулевым источником и целевым объектом и напрямую заданным объектом KeyCode.
  
  Параметры:
  
  source — источник события. Может быть null.
  
  С тех пор:
  
  JavaFX 8.0
- KeyEvent
```
public KeyEvent(EventType<KeyEvent> eventType,
                String character,
                String text,
                KeyCode code,
                boolean shiftDown,
                boolean controlDown,
                boolean altDown,
                boolean metaDown)
```
  Создаёт новое событие KeyEvent с нулевым источником и целевым объектом и напрямую заданным объектом KeyCode.
  
  Параметры:
  
  eventType — тип события.
  
  С тех пор:
  
  JavaFX 8.0

Подробное описание методов
- getCharacter
```
public final String getCharacter()
```
  Символ Юникода или последовательность символов, связанная со событием ввода с клавиатуры. Содержит несколько элементов, если клавиша произвела один символ Юникода вне Основной многоязычной плоскости, который должен быть закодирован соответствующей парой суррогатов в Java, или если клавиша сама произвела несколько символов Юникода. Например, character будет иметь значение "A" для события ввода с клавиатуры, сгенерированного нажатием SHIFT + 'a'. Для событий нажатия и отпускания клавиш, character всегда равняется CHAR_UNDEFINED.
  
  Возвращает:
  
  Символ(ы) Юникода, связанные со событием ввода с клавиатуры
- getText
```
public final String getText()
```
  Строка, описывающая код клавиши, например, "HOME", "F1" или "A", для событий нажатия и отпускания клавиш. Для событий ввода с клавиатуры, text всегда является пустой строкой.
  
  Возвращает:
  
  Строка, описывающая код клавиши
- getCode
```
public final KeyCode getCode()
```
  Код клавиши, связанный с клавишей в этом событии нажатия или отпускания клавиши. Для событий ввода с клавиатуры, code всегда равняется KeyCode.UNDEFINED.
  
  Возвращает:
  
  Код клавиши, связанный с клавишей в этом событии; KeyCode.UNDEFINED для события ввода с клавиатуры.
- isShiftDown
```
public final boolean isShiftDown()
```
  Возвращает значение true, если клавиша Shift нажата в этом событии, и false в противном случае.
  
  Возвращает:
  
  значение true, если клавиша Shift нажата в этом событии, и false в противном случае.
- isControlDown
```
public final boolean isControlDown()
```
  Возвращает значение true, если клавиша Control нажата в этом событии, и false в противном случае.
  
  Возвращает:
  
  значение true, если клавиша Control нажата в этом событии, и false в противном случае.
- isAltDown
```
public final boolean isAltDown()
```
  Возвращает значение true, если клавиша Alt нажата в этом событии, и false в противном случае.
  
  Возвращает:
  
  значение true, если клавиша Alt нажата в этом событии, и false в противном случае.
- isMetaDown
```
public final boolean isMetaDown()
```
  Возвращает значение true, если клавиша Meta нажата в этом событии, и false в противном случае.
  
  Возвращает:
  
  значение true, если клавиша Meta нажата в этом событии, и false в противном случае.
- isShortcutDown
```
public final boolean isShortcutDown()
```
  Возвращает значение true, если клавиша-модификатор сокращения, общая для платформы, нажата в этом событии. Эта клавиша-модификатор обычно используется в сокращениях на платформе. Например, control в Windows и meta (клавиша Command) в macOS.
  
  Возвращает:
  
  true, если клавиша-модификатор сокращения нажата, false в противном случае
- toString
```
public String toString()
```
  Возвращает строковое представление этого объекта KeyEvent.
  
  Переопределяет:
  
  toString в классе EventObject
  
  Возвращает:
  
  строковое представление этого объекта KeyEvent.
- copyFor
```
public KeyEvent copyFor(Object newSource,
                        EventTarget newTarget)
```
  Описание скопировано из класса: Event
  
  Создаёт и возвращает копию этого события с указанным источником и целевым объектом события. Если источник или целевой объект установлен в null, он заменяется значением NULL_SOURCE_TARGET.
  
  Переопределяет:
  
  copyFor в классе Event
  
  Параметры:
  
  newSource — новый источник скопированного события
  
  Возвращает:
  
  копию события с новым источником и целевым объектом
- copyFor
```
public KeyEvent copyFor(Object source,
                        EventTarget target,
                        EventType<KeyEvent> type)
```
  Создаёт копию данного события с подставленными полями.
  
  Параметры:
  
  source — новый источник скопированного события
  
  Возвращает:
  
  копию события с подставленными полями
  
  С тех пор:
  
  JavaFX 8.0
- getEventType
```
public EventType<KeyEvent> getEventType()
```
  Описание скопировано из класса: Event
  
  Получает тип события этого события. Объекты одного и того же класса Event могут иметь разные типы событий. Эти типы событий дополнительно указывают, какой тип события произошел.
  
  Переопределяет:
  
  getEventType в классе InputEvent
  
  Возвращает:
  
  тип события

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Класс KeyEvent

Краткое описание полей

Поля, унаследованные от класса javafx.event.Event

Поля, унаследованные от класса java.util.EventObject

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

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

Методы, унаследованные от класса javafx.event.Event

Методы, унаследованные от класса java.util.EventObject

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

Подробное описание поля

ANY

KEY_PRESSED

KEY_RELEASED

KEY_TYPED

CHAR_UNDEFINED

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

KeyEvent

KeyEvent

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

getCharacter

getText

getCode

isShiftDown

isControlDown

isAltDown

isMetaDown

isShortcutDown

toString

copyFor

copyFor

getEventType