Класс MouseEvent

public class MouseEvent
extends InputEvent

Событие, указывающее на то, что в компоненте произошло действие мыши. Действие мыши считается произошедшим в конкретном компоненте только в том случае, если курсор мыши находится над нео скрытой частью границ компонента в момент действия. Для лёгких компонентов, таких как компоненты Swing, события мыши передаются компоненту только в том случае, если тип события мыши включён в компоненте. Тип события мыши включается путём добавления соответствующего события, основанного на мыши, EventListener в компонент (MouseListener или MouseMotionListener), или путём вызова Component.enableEvents(long) с соответствующим параметром маски (AWTEvent.MOUSE_EVENT_MASK или AWTEvent.MOUSE_MOTION_EVENT_MASK). Если тип события мыши не включён в компоненте, соответствующие события мыши передаются первому предку, который включил тип события мыши.

Например, если в компонент добавлен MouseListener или вызван enableEvents(AWTEvent.MOUSE_EVENT_MASK), то все события, определённые MouseListener, передаются компоненту. С другой стороны, если MouseMotionListener не добавлен и enableEvents не вызван с AWTEvent.MOUSE_MOTION_EVENT_MASK, то события перемещения мыши не передаются компоненту. Вместо этого события перемещения мыши передаются первому предку, который включил события перемещения мыши.

Это событие низкого уровня генерируется объектом компонента для:

• События мыши
  • нажата кнопка мыши
  • кнопка мыши отпущена
  • кнопка мыши нажата и отпущена (щелчок)
  • курсор мыши входит в нео скрытую часть геометрии компонента
  • курсор мыши выходит из нео скрытой части геометрии компонента
• События перемещения мыши
  • мышь перемещена
  • мышь перетаскивается

Объект MouseEvent передаётся каждому объекту MouseListener или MouseAdapter, который зарегистрирован для получения «интересных» событий мыши с помощью метода addMouseListener компонента. (Объекты MouseAdapter реализуют интерфейс MouseListener.) Каждый такой объект-слушатель получает MouseEvent, содержащий событие мыши.

Объект MouseEvent также передаётся каждому объекту MouseMotionListener или MouseMotionAdapter, который зарегистрирован для получения событий перемещения мыши с помощью метода addMouseMotionListener компонента. (Объекты MouseMotionAdapter реализуют интерфейс MouseMotionListener.) Каждый такой объект-слушатель получает MouseEvent, содержащий событие перемещения мыши.

Когда кнопка мыши щелкается, события генерируются и отправляются зарегистрированным MouseListener. Состояние модальных клавиш можно получить с помощью InputEvent.getModifiers() и InputEvent.getModifiersEx(). Маска кнопки, возвращаемая InputEvent.getModifiers(), отражает только кнопку, состояние которой изменилось, а не текущее состояние всех кнопок. (Примечание: из-за перекрытия значений ALT_MASK/BUTTON2_MASK и META_MASK/BUTTON3_MASK это не всегда верно для событий мыши, включающих модификаторные клавиши). Чтобы получить состояние всех кнопок и модификаторных клавиш, используйте InputEvent.getModifiersEx(). Кнопка, состояние которой изменилось, возвращается методом getButton()

Например, если нажата первая кнопка мыши, события отправляются в следующей последовательности:

id              modifiers    button
    MOUSE_PRESSED:  BUTTON1_MASK BUTTON1
    MOUSE_RELEASED: BUTTON1_MASK BUTTON1
    MOUSE_CLICKED:  BUTTON1_MASK BUTTON1

Когда нажаты несколько кнопок мыши, каждое нажатие, отпускание и щелчок приводят к отдельному событию.

Например, если пользователь нажимает кнопку 1, затем кнопку 2, а затем отпускает их в том же порядке, генерируется следующая последовательность событий:

id              modifiers    button
    MOUSE_PRESSED:  BUTTON1_MASK BUTTON1
    MOUSE_PRESSED:  BUTTON2_MASK BUTTON2
    MOUSE_RELEASED: BUTTON1_MASK BUTTON1
    MOUSE_CLICKED:  BUTTON1_MASK BUTTON1
    MOUSE_RELEASED: BUTTON2_MASK BUTTON2
    MOUSE_CLICKED:  BUTTON2_MASK BUTTON2

Если кнопка 2 отпускается первой, пара MOUSE_RELEASED/MOUSE_CLICKED для BUTTON2_MASK приходит первой, за ней следует пара для BUTTON1_MASK.

Некоторые дополнительные кнопки мыши добавлены для расширения стандартного набора кнопок, представленных следующими константами: BUTTON1, BUTTON2 и BUTTON3. Дополнительные кнопки не имеют назначенных BUTTONx констант, а также их маски кнопок не имеют назначенных BUTTONx_DOWN_MASK констант. Тем не менее, порядковые номера, начиная с 4, могут использоваться в качестве номеров кнопок (идентификаторы кнопок). Значения, полученные методом getMaskForButton(button), могут использоваться в качестве масок кнопок.

События MOUSE_DRAGGED доставляются в Component, в котором была нажата кнопка мыши, до тех пор, пока кнопка мыши не будет отпущена (независимо от того, находится ли положение мыши в пределах границ Component). Из-за зависящих от платформы реализаций Drag&Drop, события MOUSE_DRAGGED могут не доставляться во время операции Drag&Drop. В многоэкранной среде события перемещения мыши доставляются в Component, даже если положение мыши находится вне границ GraphicsConfiguration, связанной с этой Component. Однако отчётное положение для событий перемещения мыши в этом случае может отличаться от фактического положения мыши:

• В многоэкранной среде без виртуального устройства:
  Отчётные координаты событий перемещения мыши обрезаются для соответствия границам GraphicsConfiguration, связанной с Component.
• В многоэкранной среде с виртуальным устройством:
  Отчётные координаты событий перемещения мыши обрезаются для соответствия границам виртуального устройства, связанного с Component.

Неопределённое поведение возникнет, если параметр id любого конкретного экземпляра MouseEvent не находится в диапазоне от MOUSE_FIRST до MOUSE_LAST-1 (MOUSE_WHEEL неприемлемо).