Spec-Zone.ru › OpenJDK 27

Класс InputEvent

java.lang.Object
java.util.EventObject
java.awt.AWTEvent
java.awt.event.ComponentEvent
java.awt.event.InputEvent
Все реализованные интерфейсы:
Serializable
Прямые известные подклассы:
KeyEvent, MouseEvent
public abstract sealed class InputEvent extends ComponentEvent permits KeyEvent, MouseEvent
Корневой класс событий для всех событий ввода на уровне компонентов. События ввода передаются прослушивателям до их обычной обработки источником, в котором они возникли. Это позволяет прослушивателям и подклассам компонентов «потреблять» событие, чтобы источник не обрабатывал его стандартным способом. Например, потребление событий mousePressed компонента Button предотвращает активацию Button.
Граф запечатанной иерархии классов:
Sealed class hierarchy graph for InputEventSealed class hierarchy graph for InputEvent
Начиная с:
1.1
См. также:
  • KeyEvent
  • KeyAdapter
  • MouseEvent
  • MouseAdapter
  • MouseMotionAdapter
  • Сериализованная форма

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

Модификатор и тип Поле Описание
static final int ALT_DOWN_MASK
Расширенная константа модификатора клавиши Alt.
static final int ALT_GRAPH_DOWN_MASK
Расширенная константа модификатора клавиши AltGraph.
static final int ALT_GRAPH_MASK
Устарело.
Рекомендуется вместо этого использовать ALT_GRAPH_DOWN_MASK и getModifiersEx()
static final int ALT_MASK
Устарело.
Рекомендуется вместо этого использовать ALT_DOWN_MASK и getModifiersEx()
static final int BUTTON1_DOWN_MASK
Расширенная константа модификатора кнопки мыши 1.
static final int BUTTON1_MASK
Устарело.
Рекомендуется вместо этого использовать BUTTON1_DOWN_MASK и getModifiersEx()
static final int BUTTON2_DOWN_MASK
Расширенная константа модификатора кнопки мыши 2.
static final int BUTTON2_MASK
Устарело.
Рекомендуется вместо этого использовать BUTTON2_DOWN_MASK и getModifiersEx().
static final int BUTTON3_DOWN_MASK
Расширенная константа модификатора кнопки мыши 3.
static final int BUTTON3_MASK
Устарело.
Рекомендуется вместо этого использовать BUTTON3_DOWN_MASK и getModifiersEx().
static final int CTRL_DOWN_MASK
Расширенная константа модификатора клавиши Control.
static final int CTRL_MASK
Устарело.
Рекомендуется вместо этого использовать CTRL_DOWN_MASK и getModifiersEx()
static final int META_DOWN_MASK
Расширенная константа модификатора клавиши Meta.
static final int META_MASK
Устарело.
Рекомендуется вместо этого использовать META_DOWN_MASK и getModifiersEx()
static final int SHIFT_DOWN_MASK
Расширенная константа модификатора клавиши Shift.
static final int SHIFT_MASK
Устарело.
Рекомендуется вместо этого использовать SHIFT_DOWN_MASK и getModifiersEx()

Поля, объявленные в классе ComponentEvent

COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN
Модификатор и тип Поле Описание
static final int COMPONENT_FIRST
Первый номер в диапазоне идентификаторов, используемых для событий компонентов.
static final int COMPONENT_HIDDEN
Это событие указывает, что компонент стал невидимым.
static final int COMPONENT_LAST
Последний номер в диапазоне идентификаторов, используемых для событий компонентов.
static final int COMPONENT_MOVED
Это событие указывает, что положение компонента изменилось.
static final int COMPONENT_RESIZED
Это событие указывает, что размер компонента изменился.
static final int COMPONENT_SHOWN
Это событие указывает, что компонент стал видимым.

Поля, объявленные в классе AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK
Модификатор и тип Поле Описание
static final long ACTION_EVENT_MASK
Маска событий для выбора событий действий.
static final long ADJUSTMENT_EVENT_MASK
Маска событий для выбора событий настройки.
static final long COMPONENT_EVENT_MASK
Маска событий для выбора событий компонентов.
protected boolean consumed
Определяет, отправляется ли событие обратно одноранговому объекту после обработки источником: значение false означает, что оно отправляется одноранговому объекту; true — что не отправляется.
static final long CONTAINER_EVENT_MASK
Маска событий для выбора событий контейнеров.
static final long FOCUS_EVENT_MASK
Маска событий для выбора событий фокуса.
static final long HIERARCHY_BOUNDS_EVENT_MASK
Маска событий для выбора событий границ иерархии.
static final long HIERARCHY_EVENT_MASK
Маска событий для выбора событий иерархии.
protected int id
Идентификатор события.
static final long INPUT_METHOD_EVENT_MASK
Маска событий для выбора событий метода ввода.
static final long INVOCATION_EVENT_MASK
Маска событий для выбора событий вызова.
static final long ITEM_EVENT_MASK
Маска событий для выбора событий элементов.
static final long KEY_EVENT_MASK
Маска событий для выбора событий клавиатуры.
static final long MOUSE_EVENT_MASK
Маска событий для выбора событий мыши.
static final long MOUSE_MOTION_EVENT_MASK
Маска событий для выбора событий движения мыши.
static final long MOUSE_WHEEL_EVENT_MASK
Маска событий для выбора событий колеса мыши.
static final long PAINT_EVENT_MASK
Маска событий для выбора событий отрисовки.
static final int RESERVED_ID_MAX
Максимальное значение зарезервированных идентификаторов событий AWT.
static final long TEXT_EVENT_MASK
Маска событий для выбора текстовых событий.
static final long WINDOW_EVENT_MASK
Маска событий для выбора событий окон.
static final long WINDOW_FOCUS_EVENT_MASK
Маска событий для выбора событий фокуса окна.
static final long WINDOW_STATE_EVENT_MASK
Маска событий для выбора событий состояния окна.

Поля, объявленные в классе EventObject

source
Модификатор и тип Поле Описание
protected Object source
Объект, в котором изначально произошло событие.

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

Модификатор и тип Метод Описание
void consume()
Потребляет это событие, чтобы источник, в котором оно возникло, не обработал его стандартным способом.
static int getMaskForButton(int button)
Метод для получения маски любой существующей кнопки мыши.
int getModifiers()
Устарело.
Рекомендуется вместо этого использовать расширенные клавиши-модификаторы и getModifiersEx()
int getModifiersEx()
Возвращает расширенную маску модификаторов для этого события.
static String getModifiersExText(int modifiers)
Возвращает строку с описанием расширенных клавиш-модификаторов и кнопок мыши, например «Shift», «Button1» или «Ctrl+Shift».
long getWhen()
Возвращает разницу в миллисекундах между временной меткой возникновения этого события и полуночью 1 января 1970 года по UTC.
boolean isAltDown()
Возвращает значение, указывающее, зажата ли клавиша-модификатор Alt для этого события.
boolean isAltGraphDown()
Возвращает значение, указывающее, зажата ли клавиша-модификатор AltGraph для этого события.
boolean isConsumed()
Возвращает значение, указывающее, было ли это событие потреблено.
boolean isControlDown()
Возвращает значение, указывающее, зажата ли клавиша-модификатор Control для этого события.
boolean isMetaDown()
Возвращает значение, указывающее, зажата ли клавиша-модификатор Meta для этого события.
boolean isShiftDown()
Возвращает значение, указывающее, зажата ли клавиша-модификатор Shift для этого события.

Методы, объявленные в классе ComponentEvent

getComponent, paramString
Модификатор и тип Метод Описание
Component getComponent()
Возвращает источник события.
String paramString()
Возвращает строку параметров, идентифицирующую это событие.

Методы, объявленные в классе AWTEvent

getID, setSource, toString
Модификатор и тип Метод Описание
int getID()
Возвращает тип события.
void setSource(Object newSource)
Перенаправляет событие новому источнику.
String toString()
Возвращает строковое представление этого объекта.

Методы, объявленные в классе EventObject

getSource
Модификатор и тип Метод Описание
Object getSource()
Объект, в котором изначально произошло событие.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Модификатор и тип Метод Описание
protected Object clone()
Создает и возвращает копию этого объекта.
boolean equals(Object obj)
Указывает, равен ли этот объект какому-либо другому объекту.
protected void finalize()
Устарело, будет удалено: этот элемент API может быть удален в будущей версии.
Финализация устарела и может быть удалена в одном из будущих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает хеш-код этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
final void wait()
Заставляет текущий поток ожидать пробуждения, обычно вследствие уведомления или прерывания.
final void wait(long timeoutMillis)
Заставляет текущий поток ожидать пробуждения, обычно вследствие уведомления или прерывания, либо до истечения заданного интервала реального времени.
final void wait(long timeoutMillis, int nanos)
Заставляет текущий поток ожидать пробуждения, обычно вследствие уведомления или прерывания, либо до истечения заданного интервала реального времени.

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

SHIFT_MASK

@Deprecated(since="9") public static final int SHIFT_MASK
Устарело.
Вместо этого рекомендуется использовать SHIFT_DOWN_MASK и getModifiersEx()
Константа модификатора клавиши Shift.
См. также:
  • Значения констант полей

CTRL_MASK

@Deprecated(since="9") public static final int CTRL_MASK
Устарело.
Вместо этого рекомендуется использовать CTRL_DOWN_MASK и getModifiersEx()
Константа модификатора клавиши Control.
См. также:
  • Значения констант полей

META_MASK

@Deprecated(since="9") public static final int META_MASK
Устарело.
Вместо этого рекомендуется использовать META_DOWN_MASK и getModifiersEx()
Константа модификатора клавиши Meta.
См. также:
  • Значения констант полей

ALT_MASK

@Deprecated(since="9") public static final int ALT_MASK
Устарело.
Вместо этого рекомендуется использовать ALT_DOWN_MASK и getModifiersEx()
Константа модификатора клавиши Alt.
См. также:
  • Значения констант полей

ALT_GRAPH_MASK

@Deprecated(since="9") public static final int ALT_GRAPH_MASK
Устарело.
Вместо этого рекомендуется использовать ALT_GRAPH_DOWN_MASK и getModifiersEx()
Константа модификатора клавиши AltGraph.
См. также:
  • Значения констант полей

BUTTON1_MASK

@Deprecated(since="9") public static final int BUTTON1_MASK
Устарело.
Вместо этого рекомендуется использовать BUTTON1_DOWN_MASK и getModifiersEx()
Константа модификатора кнопки 1 мыши.
См. также:
  • Значения констант полей

BUTTON2_MASK

@Deprecated(since="9") public static final int BUTTON2_MASK
Устарело.
Вместо этого рекомендуется использовать BUTTON2_DOWN_MASK и getModifiersEx(). Обратите внимание, что BUTTON2_MASK имеет то же значение, что и ALT_MASK.
Константа модификатора кнопки 2 мыши.
См. также:
  • Значения констант полей

BUTTON3_MASK

@Deprecated(since="9") public static final int BUTTON3_MASK
Устарело.
Вместо этого рекомендуется использовать BUTTON3_DOWN_MASK и getModifiersEx(). Обратите внимание, что BUTTON3_MASK имеет то же значение, что и META_MASK.
Константа модификатора кнопки 3 мыши.
См. также:
  • Значения констант полей

SHIFT_DOWN_MASK

public static final int SHIFT_DOWN_MASK
Константа расширенного модификатора клавиши Shift.
Начиная с версии:
1.4
См. также:
  • Значения констант полей

CTRL_DOWN_MASK

public static final int CTRL_DOWN_MASK
Константа расширенного модификатора клавиши Control.
Начиная с версии:
1.4
См. также:
  • Значения констант полей

META_DOWN_MASK

public static final int META_DOWN_MASK
Константа расширенного модификатора клавиши Meta.
Начиная с версии:
1.4
См. также:
  • Значения констант полей

ALT_DOWN_MASK

public static final int ALT_DOWN_MASK
Константа расширенного модификатора клавиши Alt.
Начиная с версии:
1.4
См. также:
  • Значения констант полей

BUTTON1_DOWN_MASK

public static final int BUTTON1_DOWN_MASK
Константа расширенного модификатора кнопки 1 мыши.
Начиная с версии:
1.4
См. также:
  • Значения констант полей

BUTTON2_DOWN_MASK

public static final int BUTTON2_DOWN_MASK
Константа расширенного модификатора кнопки 2 мыши.
Начиная с версии:
1.4
См. также:
  • Значения констант полей

BUTTON3_DOWN_MASK

public static final int BUTTON3_DOWN_MASK
Константа расширенного модификатора кнопки 3 мыши.
Начиная с версии:
1.4
См. также:
  • Значения констант полей

ALT_GRAPH_DOWN_MASK

public static final int ALT_GRAPH_DOWN_MASK
Константа расширенного модификатора клавиши AltGraph.
Начиная с версии:
1.4
См. также:
  • Значения констант полей

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

getMaskForButton

public static int getMaskForButton(int button)
Метод для получения маски любой существующей кнопки мыши. Возвращенную маску можно использовать для различных целей. Вот некоторые из них:
  • mousePress(buttons) и mouseRelease(buttons)
  • в качестве параметра modifiers при создании нового экземпляра MouseEvent
  • для проверки modifiersEx существующего MouseEvent
Параметры:
button — номер кнопки, начиная с 1. Например, 
int button = InputEvent.getMaskForButton(1);
будет иметь то же значение, что и 
int button = InputEvent.getMaskForButton(MouseEvent.BUTTON1);
, поскольку MouseEvent.BUTTON1 равно 1. Если у мыши включены три кнопки (см. MouseInfo.getNumberOfButtons()), то значения из левого столбца, переданные методу, вернут соответствующие значения из правого столбца: 
   button    returned mask
   BUTTON1  BUTTON1_DOWN_MASK
   BUTTON2  BUTTON2_DOWN_MASK
   BUTTON3  BUTTON3_DOWN_MASK
Если у мыши включено более трех кнопок, допустимы и другие значения (4, 5 и т. д.). Для этих дополнительных кнопок не определены именованные константы. Маскам дополнительных кнопок, возвращаемым этим методом, не присвоены имена, в отличие от масок первых трех кнопок.

Для этого метода действует следующее ограничение реализации. Он возвращает маски только для ограниченного числа кнопок. Максимальное число зависит от реализации и может различаться. Этот предел определяется соответствующим количеством кнопок, которые теоретически могут присутствовать на мыши, однако оно превышает значение, возвращаемое методом MouseInfo.getNumberOfButtons().

Возвращает:
маску существующей кнопки мыши.
Выбрасывает:
IllegalArgumentException — если button меньше нуля или больше количества масок кнопок, зарезервированных для кнопок
Начиная с версии:
1.7
См. также:
  • MouseInfo.getNumberOfButtons()
  • Toolkit.areExtraMouseButtonsEnabled()
  • getModifiers()
  • getModifiersEx()

isShiftDown

public boolean isShiftDown()
Возвращает значение, указывающее, удерживается ли модификатор Shift для этого события.
Возвращает:
значение, указывающее, удерживается ли модификатор Shift для этого события

isControlDown

public boolean isControlDown()
Возвращает значение, указывающее, удерживается ли модификатор Control для этого события.
Возвращает:
значение, указывающее, удерживается ли модификатор Control для этого события

isMetaDown

public boolean isMetaDown()
Возвращает значение, указывающее, удерживается ли модификатор Meta для этого события.
Возвращает:
значение, указывающее, удерживается ли модификатор Meta для этого события

isAltDown

public boolean isAltDown()
Возвращает значение, указывающее, удерживается ли модификатор Alt для этого события.
Возвращает:
значение, указывающее, удерживается ли модификатор Alt для этого события

isAltGraphDown

public boolean isAltGraphDown()
Возвращает значение, указывающее, удерживается ли модификатор AltGraph для этого события.
Возвращает:
значение, указывающее, удерживается ли модификатор AltGraph для этого события

getWhen

public long getWhen()
Возвращает разницу в миллисекундах между временной меткой возникновения этого события и полуночью 1 января 1970 года по UTC.
Возвращает:
разницу в миллисекундах между временной меткой и полуночью 1 января 1970 года по UTC

getModifiers

@Deprecated(since="9") public int getModifiers()
Устарело.
Вместо этого рекомендуется использовать расширенные клавиши-модификаторы и getModifiersEx()
Возвращает маску модификаторов для этого события.
Возвращает:
маску модификаторов для этого события

getModifiersEx

public int getModifiersEx()
Возвращает расширенную маску модификаторов для этого события.

К расширенным модификаторам относятся модификаторы, названия которых оканчиваются суффиксом _DOWN_MASK, например ALT_DOWN_MASK, BUTTON1_DOWN_MASK и другие.

Расширенные модификаторы отражают состояние всех клавиш-модификаторов, таких как ALT, CTRL, META, а также кнопок мыши сразу после возникновения события.

Например, если пользователь нажимает кнопку 1, затем кнопку 2 и после этого отпускает их в том же порядке, генерируется следующая последовательность событий: 

   MOUSE_PRESSED:  BUTTON1_DOWN_MASK
   MOUSE_PRESSED:  BUTTON1_DOWN_MASK | BUTTON2_DOWN_MASK
   MOUSE_RELEASED: BUTTON2_DOWN_MASK
   MOUSE_CLICKED:  BUTTON2_DOWN_MASK
   MOUSE_RELEASED:
   MOUSE_CLICKED:

Не рекомендуется сравнивать возвращаемое этим методом значение с помощью ==, поскольку в будущем могут быть добавлены новые модификаторы. Например, правильный способ проверить, что SHIFT и BUTTON1 нажаты, а CTRL не нажата, показан в следующем коде: 

   int onmask = SHIFT_DOWN_MASK | BUTTON1_DOWN_MASK;
   int offmask = CTRL_DOWN_MASK;
   if ((event.getModifiersEx() & (onmask | offmask)) == onmask) {
       ...
   }
Приведенный выше код будет работать, даже если будут добавлены новые модификаторы.
Возвращает:
расширенную маску модификаторов для этого события
Начиная с версии:
1.4

consume

public void consume()
Потребляет это событие, чтобы источник, породивший его, не обрабатывал его стандартным способом.
Переопределяет:
consume в классе AWTEvent

isConsumed

public boolean isConsumed()
Возвращает значение, указывающее, было ли это событие потреблено.
Переопределяет:
isConsumed в классе AWTEvent
Возвращает:
значение, указывающее, было ли это событие потреблено
См. также:
  • consume()

getModifiersExText

public static String getModifiersExText(int modifiers)
Возвращает строку с описанием расширенных клавиш-модификаторов и кнопок мыши, например «Shift», «Button1» или «Ctrl+Shift». Эти строки можно локализовать, изменив файл awt.properties.

Обратите внимание: передавать отрицательное значение параметра некорректно; в этом случае будет возвращена строка, не определенная спецификацией. Нулевое значение параметра означает, что модификаторы не переданы, и приводит к возврату пустой строки.

Параметры:
modifiers — маска модификаторов, описывающая расширенные клавиши-модификаторы и кнопки мыши для события
Возвращает:
текстовое описание комбинации расширенных клавиш-модификаторов и кнопок мыши, удерживавшихся во время события.
Начиная с версии:
1.4

Сообщить об ошибке или предложить улучшение
Дополнительную справочную информацию по API и документацию для разработчиков см. в разделе Документация Java SE, содержащем более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторские права © 1993, 2026, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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.

Spec-Zone.ru

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