Spec-Zone.ru › OpenJDK 17

Класс 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 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
Постоянная расширенного модификатора клавиши Ctrl.
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
См. также:
  • MouseInfo.getNumberOfButtons()
  • Toolkit.areExtraMouseButtonsEnabled()
  • getModifiers()
  • getModifiersEx()

isShiftDown

public boolean isShiftDown()
Возвращает, нажата ли клавиша Shift в этом событии.
Возвращает:
нажата ли клавиша Shift в этом событии

isControlDown

public boolean isControlDown()
Возвращает, нажата ли клавиша Control в этом событии.
Возвращает:
нажата ли клавиша Control в этом событии
END_OF_DOCUMENT_MARKER

isMetaDown

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

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, 2021, 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/17/docs/api/java.desktop/java/awt/event/InputEvent.html

Spec-Zone.ru

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