Класс 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 не приемлемо).