Класс InputEvent

java.lang.Object
- java.util.EventObject
- - java.awt.AWTEvent
  - - java.awt.event.ComponentEvent
    - - java.awt.event.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` Константа модификатора клавиши AltGraph.
`static int`	`ALT_MASK` Константа модификатора клавиши Alt.
`static int`	`BUTTON1_DOWN_MASK` Константа расширенного модификатора кнопки мыши 1.
`static int`	`BUTTON1_MASK` Константа модификатора кнопки мыши 1.
`static int`	`BUTTON2_DOWN_MASK` Константа расширенного модификатора кнопки мыши 2.
`static int`	`BUTTON2_MASK` Константа модификатора кнопки мыши 2.
`static int`	`BUTTON3_DOWN_MASK` Константа расширенного модификатора кнопки мыши 3.
`static int`	`BUTTON3_MASK` Константа модификатора кнопки мыши 3.
`static int`	`CTRL_DOWN_MASK` Константа расширенного модификатора клавиши Ctrl.
`static int`	`CTRL_MASK` Константа модификатора клавиши Ctrl.
`static int`	`META_DOWN_MASK` Константа расширенного модификатора клавиши Meta.
`static int`	`META_MASK` Константа модификатора клавиши Meta.
`static int`	`SHIFT_DOWN_MASK` Константа расширенного модификатора клавиши Shift.
`static int`	`SHIFT_MASK` Константа модификатора клавиши Shift.

Поля, унаследованные от класса 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()` Возвращает маску модификаторов для этого события.
`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()` Возвращает, нажата ли клавиша Ctrl в этом событии.
`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

public static final int SHIFT_MASK

Константа модификатора клавиши Shift. Рекомендуется использовать SHIFT_DOWN_MASK вместо неё.

См. также:: Значения константных полей

CTRL_MASK

public static final int CTRL_MASK

Константа модификатора клавиши Control. Рекомендуется использовать CTRL_DOWN_MASK вместо неё.

См. также:: Значения константных полей

META_MASK

public static final int META_MASK

Константа модификатора клавиши Meta. Рекомендуется использовать META_DOWN_MASK вместо неё.

См. также:: Значения константных полей

ALT_MASK

public static final int ALT_MASK

Константа модификатора клавиши Alt. Рекомендуется использовать ALT_DOWN_MASK вместо неё.

См. также:: Значения константных полей

ALT_GRAPH_MASK

public static final int ALT_GRAPH_MASK

Константа модификатора клавиши AltGraph.

См. также:: Значения константных полей

BUTTON1_MASK

public static final int BUTTON1_MASK

Константа модификатора кнопки мыши 1. Рекомендуется использовать BUTTON1_DOWN_MASK вместо неё.

См. также:: Значения константных полей

BUTTON2_MASK

public static final int BUTTON2_MASK

Константа модификатора кнопки мыши 2. Рекомендуется использовать BUTTON2_DOWN_MASK вместо неё. Обратите внимание, что BUTTON2_MASK имеет то же значение, что и ALT_MASK.

См. также:: Значения константных полей

BUTTON3_MASK

public static final int BUTTON3_MASK

Константа модификатора кнопки мыши 3. Рекомендуется использовать BUTTON3_DOWN_MASK вместо неё. Обратите внимание, что BUTTON3_MASK имеет то же значение, что и META_MASK.

См. также:: Значения константных полей

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 меньше нуля или больше числа масок кнопок, зарезервированных для кнопок

С:

7.0

См. также:

MouseInfo.getNumberOfButtons(), Toolkit.areExtraMouseButtonsEnabled(), getModifiers(), MouseEvent.getModifiersEx()

isShiftDown

public boolean isShiftDown()

Возвращает значение, указывающее, нажата ли клавиша Shift в данном событии.

isControlDown

public boolean isControlDown()

Возвращает значение, указывающее, нажата ли клавиша Control в данном событии.

isMetaDown

public boolean isMetaDown()

Возвращает значение, указывающее, нажата ли клавиша Meta в данном событии.

isAltDown

public boolean isAltDown()

Возвращает значение, указывающее, нажата ли клавиша Alt в данном событии.

isAltGraphDown

public boolean isAltGraphDown()

Возвращает значение, указывающее, нажата ли клавиша AltGraph в данном событии.

getWhen

public long getWhen()

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

getModifiers

public int getModifiers()

Возвращает маску модификаторов для данного события.

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.