Класс InputEvent

Все реализованные интерфейсы:
Serializable
Прямые известные подклассы:
KeyEvent, MouseEvent 
public abstract class InputEvent
extends ComponentEvent

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

С момента:
1.1
См. также:
KeyEvent, KeyAdapter, MouseEvent, MouseAdapter, MouseMotionAdapter, Сериализованная форма

Поля

Модификатор и тип Поле Описание
static int ALT_DOWN_MASK

Постоянная расширенного модификатора Alt.
static int ALT_GRAPH_DOWN_MASK

Постоянная расширенного модификатора AltGraph.
static int ALT_GRAPH_MASK

Устарело.

Рекомендуется использовать ALT_GRAPH_DOWN_MASK и getModifiersEx() вместо этого
static int ALT_MASK

Устарело.

Рекомендуется использовать ALT_DOWN_MASK и getModifiersEx() вместо этого
static int BUTTON1_DOWN_MASK

Постоянная расширенного модификатора левой кнопки мыши.
static int BUTTON1_MASK

Устарело.

Рекомендуется использовать BUTTON1_DOWN_MASK и getModifiersEx() вместо этого
static int BUTTON2_DOWN_MASK

Постоянная расширенного модификатора правой кнопки мыши.
static int BUTTON2_MASK

Устарело.

Рекомендуется использовать BUTTON2_DOWN_MASK и getModifiersEx() вместо этого.
static int BUTTON3_DOWN_MASK

Постоянная расширенного модификатора средней кнопки мыши.
static int BUTTON3_MASK

Устарело.

Рекомендуется использовать BUTTON3_DOWN_MASK и getModifiersEx() вместо этого.
static int CTRL_DOWN_MASK

Постоянная расширенного модификатора Control.
static int CTRL_MASK

Устарело.

Рекомендуется использовать CTRL_DOWN_MASK и getModifiersEx() вместо этого
static int META_DOWN_MASK

Постоянная расширенного модификатора Meta.
static int META_MASK

Устарело.

Рекомендуется использовать META_DOWN_MASK и getModifiersEx() вместо этого
static int SHIFT_DOWN_MASK

Постоянная расширенного модификатора Shift.
static int SHIFT_MASK

Устарело.

Рекомендуется использовать SHIFT_DOWN_MASK и getModifiersEx() вместо этого

Поля, объявленные в классе java.awt.event.ComponentEvent

COMPONENT_FIRST, COMPONENT_HIDDEN, COMPONENT_LAST, COMPONENT_MOVED, COMPONENT_RESIZED, COMPONENT_SHOWN

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

Поля, объявленные в классе java.util.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 для этого события.

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

getComponent, paramString

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

getID, setSource, toString

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

getSource

Методы, объявленные в классе java.lang.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)

Метод для получения маски для любой существующей кнопки мыши. Возвращаемая маска может быть использована для различных целей. Вот некоторые из них:

Параметры:
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

© 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/event/InputEvent.html

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