Класс InputEvent

java.awt.event.InputEvent

Все реализуемые интерфейсы:: Serializable

Непосредственные известные подклассы:: KeyEvent, MouseEvent

public abstract sealed class InputEvent extends ComponentEvent permits KeyEvent, MouseEvent

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

Диаграмма иерархии класса (запечатанный):

Sealed class hierarchy graph for InputEvent

С:

1.1

См. также:

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

Модификатор и тип	Поле	Описание
`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()` вместо этого.

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

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

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

См. также:

isShiftDown

public boolean isShiftDown()

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

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

isControlDown

public boolean isControlDown()

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

Возвращает:: значение, указывающее, нажата ли клавиша Ctrl в этом событии

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

Возвращает:

значение, указывающее, было ли это событие потреблено

См. также:

getModifiersExText

public static String getModifiersExText(int modifiers)

Возвращает строку, описывающую расширенные клавиши модификаторов и кнопки мыши, такие как "Shift", "Button1" или "Ctrl+Shift". Эти строки могут быть локализованы путем изменения файла awt.properties.

Обратите внимание, что передача отрицательного параметра является ошибочной и приведет к возвращению неопределенной строки. Параметр со значением ноль означает, что модификаторы не были переданы, и приведет к возвращению пустой строки.

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

© 1993, 2023, 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/21/docs/api/java.desktop/java/awt/event/InputEvent.html