Spec-Zone.ru › OpenJDK 25

Класс 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

Поля, объявленные в классе 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

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

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

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

getID, setSource, toString

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

getSource

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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, 2025, 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.desktop/java/awt/event/InputEvent.html

Spec-Zone.ru

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