Класс MouseEvent

Событие, указывающее на то, что в компоненте произошло действие мыши. Действие мыши считается произошедшим в конкретном компоненте только в том случае, если курсор мыши находится над незатенённой частью области компонента в момент действия. Для лёгких компонентов, таких как компоненты 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

Некоторые дополнительные кнопки мыши добавлены для расширения стандартного набора кнопок, представленных следующими константами: 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 недопустимо).

Поля

MOUSE_FIRST

public static final int MOUSE_FIRST

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

См. также:

Значения константных полей

MOUSE_LAST

public static final int MOUSE_LAST

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

См. также:

Значения константных полей

MOUSE_CLICKED

public static final int MOUSE_CLICKED

Событие "нажатие мыши". Это MouseEvent происходит, когда кнопка мыши нажимается и отпускается.

См. также:

Значения константных полей

MOUSE_PRESSED

public static final int MOUSE_PRESSED

Событие "нажатие мыши". Это MouseEvent происходит, когда кнопка мыши нажимается.

См. также:

Значения константных полей

MOUSE_RELEASED

public static final int MOUSE_RELEASED

Событие "отпускание мыши". Это MouseEvent происходит, когда кнопка мыши отпускается.

См. также:

Значения константных полей

MOUSE_MOVED

public static final int MOUSE_MOVED

Событие "движение мыши". Это MouseEvent происходит, когда изменяется положение мыши.

См. также:

Значения константных полей

MOUSE_ENTERED

public static final int MOUSE_ENTERED

Событие "вход мыши". Это MouseEvent происходит, когда курсор мыши входит в необнаруживаемую часть геометрии компонента.

См. также:

Значения константных полей

MOUSE_EXITED

public static final int MOUSE_EXITED

Событие "выход мыши". Это MouseEvent происходит, когда курсор мыши выходит из необнаруживаемой части геометрии компонента.

См. также:

Значения константных полей

MOUSE_DRAGGED

public static final int MOUSE_DRAGGED

Событие "перетаскивание мыши". Это MouseEvent происходит, когда положение мыши изменяется при нажатой кнопке мыши.

См. также:

Значения константных полей

MOUSE_WHEEL

public static final int MOUSE_WHEEL

Событие "колесо мыши". Это единственное MouseWheelEvent. Оно происходит, когда колесо мыши вращается.

С:

1.4

См. также:

Значения константных полей

NOBUTTON

public static final int NOBUTTON

Указывает отсутствие нажатых кнопок мыши; используется методом getButton().

С:

1.4

См. также:

Значения константных полей

BUTTON1

public static final int BUTTON1

Указывает нажатую кнопку мыши #1; используется методом getButton().

С:

1.4

См. также:

Значения константных полей

BUTTON2

public static final int BUTTON2

Указывает нажатую кнопку мыши #2; используется методом getButton().

С:

1.4

См. также:

Значения константных полей

BUTTON3

public static final int BUTTON3

Указывает нажатую кнопку мыши #3; используется методом getButton().

С:

1.4

См. также:

Значения константных полей

Конструкторы

MouseEvent

public MouseEvent(Component source,
                  int id,
                  long when,
                  int modifiers,
                  int x,
                  int y,
                  int clickCount,
                  boolean popupTrigger,
                  int button)

Параметры:

source - Компонент Component, породивший событие

id - Целое число, указывающее тип события. Информацию об допустимых значениях см. в описании класса MouseEvent

when - Целое число с плавающей точкой, указывающее время наступления события. Не рекомендуется передавать отрицательное или нулевое значение.

modifiers - Маска модификаторов, описывающая нажатые клавиши модификации и кнопки мыши (например, Shift, Ctrl, Alt и Meta), которые активны во время события. Разрешается использовать только расширенные модификаторы (см. описание расширенных модификаторов в классе InputEvent.getModifiersEx()). Передача отрицательного параметра не рекомендуется. Нулевое значение означает, что модификаторы не передавались

x - Горизонтальная координата x для положения мыши. Разрешается передавать отрицательные значения

y - Вертикальная координата y для положения мыши. Разрешается передавать отрицательные значения

clickCount - Количество щелчков мыши, связанных с событием. Передача отрицательного значения не рекомендуется

popupTrigger - Логическое значение, равное true, если это событие является триггером для всплывающего меню

button - Целое число, указывающее, какая из кнопок мыши изменила свое состояние. К этому параметру применяются следующие правила:

• Если поддержка расширенных кнопок мыши disabled в Java, то разрешается создавать объекты MouseEvent только со стандартными кнопками: NOBUTTON, BUTTON1, BUTTON2, и BUTTON3.
• Если поддержка расширенных кнопок мыши enabled в Java, то разрешается создавать объекты MouseEvent со стандартными кнопками. Если поддержка расширенных кнопок мыши enabled в Java, то помимо стандартных кнопок, объекты MouseEvent можно создавать, используя кнопки из диапазона от 4 до MouseInfo.getNumberOfButtons(), если у мыши больше трёх кнопок.

Исключения:

IllegalArgumentException - если button меньше нуля

IllegalArgumentException - если source равно null

IllegalArgumentException - если button больше, чем BUTTON3, и поддержка расширенных кнопок мыши disabled в Java

IllegalArgumentException - если button больше, чем current number of buttons, и поддержка расширенных кнопок мыши enabled в Java

IllegalArgumentException - если передано недопустимое значение button

IllegalArgumentException - если source равно null

С:

1.4

См. также:

EventObject.getSource(), AWTEvent.getID(), InputEvent.getWhen(), InputEvent.getModifiers(), getX(), getY(), getClickCount(), isPopupTrigger(), getButton()

MouseEvent

public MouseEvent(Component source,
                  int id,
                  long when,
                  int modifiers,
                  int x,
                  int y,
                  int clickCount,
                  boolean popupTrigger)

Создаёт объект MouseEvent со указанным исходным компонентом, типом, модификаторами, координатами, количеством щелчков и флагом popupTrigger. Вызов в форме MouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger) ведет себя точно так же, как вызов MouseEvent(source, id, when, modifiers, x, y, xAbs, yAbs, clickCount, popupTrigger, MouseEvent.NOBUTTON), где xAbs и yAbs определяются как положение источника на экране плюс относительные координаты x и y. xAbs и yAbs устанавливаются в ноль, если источник не отображается. Этот метод выбрасывает IllegalArgumentException, если source равно null.

Параметры:

source - Компонент, породивший событие

id - Целое число, указывающее тип события. Для получения информации о допустимых значениях см. описание класса MouseEvent

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

modifiers - Маска модификаторов, описывающая нажатые модификаторы и кнопки мыши (например, Shift, Ctrl, Alt и Meta) во время события. В качестве значения этого параметра разрешается использовать только расширенные модификаторы (см. класс InputEvent.getModifiersEx() для описания расширенных модификаторов). Передача отрицательного параметра не рекомендуется. Нулевое значение означает, что модификаторы не были переданы

x - Горизонтальная координата x для местоположения курсора мыши. Разрешается передавать отрицательные значения

y - Вертикальная координата y для местоположения курсора мыши. Разрешается передавать отрицательные значения

clickCount - Количество щелчков мыши, связанных с событием. Передача отрицательного значения не рекомендуется

popupTrigger - Логическое значение, равное true, если это событие является триггером для всплывающего меню

Исключения:

IllegalArgumentException - если source равно null

См. также:

EventObject.getSource(), AWTEvent.getID(), InputEvent.getWhen(), InputEvent.getModifiers(), getX(), getY(), getClickCount(), isPopupTrigger()

MouseEvent

public MouseEvent(Component source,
                  int id,
                  long when,
                  int modifiers,
                  int x,
                  int y,
                  int xAbs,
                  int yAbs,
                  int clickCount,
                  boolean popupTrigger,
                  int button)

Параметры:

source - Компонент, породивший событие

id - Целое число, указывающее тип события. Для получения информации о допустимых значениях см. описание класса MouseEvent

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

modifiers - Маска модификаторов, описывающая нажатые клавиши модификаторов и кнопки мыши во время события. В качестве значения этого параметра разрешается использовать только расширенные модификаторы (см. класс InputEvent.getModifiersEx() для описания расширенных модификаторов). Передача отрицательного параметра не рекомендуется. Нулевое значение означает, что модификаторы не были переданы

x - Горизонтальная координата x для местоположения курсора мыши. Разрешается передавать отрицательные значения

y - Вертикальная координата y для местоположения курсора мыши. Разрешается передавать отрицательные значения

xAbs - Абсолютная горизонтальная координата x для местоположения курсора мыши. Разрешается передавать отрицательные значения

yAbs - Абсолютная вертикальная координата y для местоположения курсора мыши. Разрешается передавать отрицательные значения

clickCount - Количество щелчков мыши, связанных с событием. Передача отрицательного значения не рекомендуется

popupTrigger - Логическое значение, равное true, если это событие является триггером для всплывающего меню

button - Целое число, указывающее, какая из кнопок мыши изменила своё состояние. Применяются следующие правила к этому параметру:

• Если поддержка расширенных кнопок мыши disabled в Java, то разрешается создавать объекты MouseEvent только со стандартными кнопками: NOBUTTON, BUTTON1, BUTTON2, и BUTTON3.
• Если поддержка расширенных кнопок мыши enabled в Java, то разрешается создавать объекты MouseEvent со стандартными кнопками. В случае, если поддержка расширенных кнопок мыши enabled в Java, то помимо стандартных кнопок, объекты MouseEvent могут быть созданы с использованием кнопок из диапазона, начиная с 4 до MouseInfo.getNumberOfButtons(), если у мыши более трёх кнопок.

Исключения:

IllegalArgumentException - если button меньше нуля

IllegalArgumentException - если source равно null

IllegalArgumentException - если button больше, чем BUTTON3, и поддержка расширенных кнопок мыши disabled в Java

IllegalArgumentException - если button больше, чем current number of buttons, и поддержка расширенных кнопок мыши enabled в Java

IllegalArgumentException - если передано неверное значение button

IllegalArgumentException - если source равно null

С тех пор:

1.6

См. также:

EventObject.getSource(), AWTEvent.getID(), InputEvent.getWhen(), InputEvent.getModifiers(), getX(), getY(), getXOnScreen(), getYOnScreen(), getClickCount(), isPopupTrigger(), getButton(), button, Toolkit.areExtraMouseButtonsEnabled(), MouseInfo.getNumberOfButtons(), InputEvent.getMaskForButton(int)

Методы

getLocationOnScreen

public Point getLocationOnScreen()

Возвращает абсолютные координаты x, y события. В среде виртуального устройства с несколькими экранами, где рабочая область может охватывать несколько физических экранов, эти координаты относительны к виртуальной системе координат. В противном случае эти координаты относительны к системе координат, связанной с GraphicsConfiguration компонента.

Возвращает:

объект Point содержащий абсолютные координаты x и y.

С тех пор:

1.6

См. также:

GraphicsConfiguration

getXOnScreen

public int getXOnScreen()

Возвращает абсолютную горизонтальную координату x события. В среде виртуального устройства с несколькими экранами, где рабочая область может охватывать несколько физических экранов, эта координата относительна к виртуальной системе координат. В противном случае эта координата относительна к системе координат, связанной с GraphicsConfiguration компонента.

Возвращает:

целое число x, указывающее абсолютную горизонтальную позицию.

С тех пор:

1.6

См. также:

GraphicsConfiguration

getYOnScreen

public int getYOnScreen()

Возвращает абсолютную вертикальную координату y события. В среде виртуального устройства с несколькими экранами, где рабочая область может охватывать несколько физических экранов, эта координата относительна к виртуальной системе координат. В противном случае эта координата относительна к системе координат, связанной с GraphicsConfiguration компонента.

Возвращает:

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

С тех пор:

1.6

См. также:

GraphicsConfiguration

getModifiersEx

public int getModifiersEx()

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:

int onmask = SHIFT_DOWN_MASK | BUTTON1_DOWN_MASK;
    int offmask = CTRL_DOWN_MASK;
    if ((event.getModifiersEx() & (onmask | offmask)) == onmask) {
        ...
    }

Переопределяет:

getModifiersEx в классе InputEvent

getX

public int getX()

Возвращает горизонтальную координату x события относительно компонента-источника.

Возвращает:

целое число x, указывающее горизонтальную позицию относительно компонента

getY

public int getY()

Возвращает вертикальную координату y события относительно компонента-источника.

Возвращает:

целое число y, указывающее вертикальную позицию относительно компонента

getPoint

public Point getPoint()

Возвращает координаты x, y события относительно компонента-источника.

Возвращает:

объект Point содержащий координаты x и y, относительные к компоненту-источнику

translatePoint

public void translatePoint(int x,
                           int y)

Перемещает координаты события в новое положение, добавив указанные x (горизонтальное) и y (вертикальное) смещения.

Параметры:

x — добавляемое к текущей координате x горизонтальное значение

y — добавляемое к текущей координате y вертикальное значение

getClickCount

public int getClickCount()

Возвращает количество щелчков мыши, связанных с этим событием.

Возвращает:

целое значение количества щелчков

getButton

public int getButton()

if (anEvent.getButton() == MouseEvent.BUTTON1) {

Возвращает:

одно из значений от 0 до MouseInfo.getNumberOfButtons(), если поддержка расширенных кнопок мыши enabled Java. Этот диапазон включает NOBUTTON, BUTTON1, BUTTON2, BUTTON3;
NOBUTTON, BUTTON1, BUTTON2 или BUTTON3 если поддержка расширенных кнопок мыши disabled Java

С:

1.4

См. также:

Toolkit.areExtraMouseButtonsEnabled(), MouseInfo.getNumberOfButtons(), MouseEvent(Component, int, long, int, int, int, int, int, int, boolean, int), InputEvent.getMaskForButton(int)

isPopupTrigger

public boolean isPopupTrigger()

Возвращает:

логическое значение, true, если это событие является триггером всплывающего меню для текущей платформы

getMouseModifiersText

public static String getMouseModifiersText(int modifiers)

Параметры:

modifiers — маска модификаторов, описывающая нажатые модификаторы клавиш и кнопки мыши во время события

Возвращает:

строка, содержащая текстовое описание комбинации нажатых модификаторов клавиш и кнопок мыши во время события

С:

1.4

См. также:

InputEvent.getModifiersExText(int)

paramString

public String paramString()

Возвращает строку параметров, идентифицирующую это событие. Этот метод полезен для ведения журнала событий и отладки.

Переопределяет:

paramString в классе ComponentEvent

Возвращает:

строка, идентифицирующая событие и его атрибуты