Класс MouseWheelEvent

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

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

Объект MouseWheelEvent передаётся каждому MouseWheelListener объекту, который зарегистрирован для получения «интересных» событий мыши, используя метод компонента addMouseWheelListener. Каждый такой объект-слушатель получает MouseEvent , содержащий событие мыши.

Из-за особой взаимосвязи колеса мыши и компонентов прокрутки MouseWheelEvents доставляются несколько иначе, чем другие MouseEvents. Это связано с тем, что в то время как другие MouseEvents обычно влияют на изменения в компоненте непосредственно под курсором мыши (например, при нажатии на кнопку), MouseWheelEvents часто оказывают влияние вне курсора мыши (движение колеса над компонентом внутри ScrollPane должно прокручивать одну из полос прокрутки на ScrollPane).

Доставка MouseWheelEvents начинается с компонента под курсором мыши. Если MouseWheelEvents не включены в компоненте, событие доставляется первому предку Container с включёнными MouseWheelEvents. Обычно это ScrollPane с включённой прокруткой колёсиком. Источник-компонент и координаты x, y будут относиться к конечному пункту назначения события (ScrollPane). Это позволяет установить сложный GUI без модификаций в ScrollPane, и все MouseWheelEvents доставляются в ScrollPane для прокрутки.

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

Платформы предлагают настраивать объём прокрутки, который должен происходить при перемещении колеса мыши. Две наиболее распространённые настройки — прокрутка на определённое количество «единиц» (обычно строк текста в текстовом компоненте) или на весь «блок» (аналогично клавишам Page-Up/Page-Down). MouseWheelEvent предлагает методы для соответствия настройкам базовой платформы. Эти настройки платформы могут быть изменены пользователем в любое время. MouseWheelEvents отражают последние настройки.

Класс MouseWheelEvent содержит методы для получения количества «щелчков», на которые повернуто колесо мыши. Метод getWheelRotation() возвращает целое число «щелчков», соответствующее количеству зубцов, на которые было повернуто колесо. Кроме этого метода, класс MouseWheelEvent предоставляет метод getPreciseWheelRotation(), который возвращает двойное число «щелчков» в случае частичного поворота. Метод getPreciseWheelRotation() полезен, если мышь поддерживает колесо с высоким разрешением, например, свободно вращающееся колесо без зубцов. Приложения могут извлечь выгоду из использования этого метода для более точной обработки событий колёсика мыши, тем самым сделав визуальное восприятие плавнее.

Поля

WHEEL_UNIT_SCROLL

@Native
public static final int WHEEL_UNIT_SCROLL

Константа, представляющая прокрутку на "единицы" (например, прокрутка с помощью стрелок)

См. также:

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

WHEEL_BLOCK_SCROLL

@Native
public static final int WHEEL_BLOCK_SCROLL

Константа, представляющая прокрутку на "блок" (например, прокрутка с помощью клавиш Page Up, Page Down)

См. также:

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

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

MouseWheelEvent

public MouseWheelEvent(Component source,
                       int id,
                       long when,
                       int modifiers,
                       int x,
                       int y,
                       int clickCount,
                       boolean popupTrigger,
                       int scrollType,
                       int scrollAmount,
                       int wheelRotation)

Параметры:

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

id - целое число, идентифицирующее событие

when - значение типа long, указывающее время возникновения события

modifiers - нажатые клавиши модификаторов (Shift, Ctrl, Alt, Meta) во время события

x - горизонтальная координата x для положения мыши

y - вертикальная координата y для положения мыши

clickCount - количество щелчков мыши, связанных с событием

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

scrollType - тип прокрутки, который должен произойти в ответ на это событие; допустимые значения - WHEEL_UNIT_SCROLL и WHEEL_BLOCK_SCROLL

scrollAmount - для scrollType WHEEL_UNIT_SCROLL, количество единиц прокрутки

wheelRotation - целое число "щелчков" вращения колеса мыши

Исключения:

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

См. также:

MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean), MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)

MouseWheelEvent

public MouseWheelEvent(Component source,
                       int id,
                       long when,
                       int modifiers,
                       int x,
                       int y,
                       int xAbs,
                       int yAbs,
                       int clickCount,
                       boolean popupTrigger,
                       int scrollType,
                       int scrollAmount,
                       int wheelRotation)

Параметры:

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

id - целое число, идентифицирующее событие

when - значение типа long, указывающее время возникновения события

modifiers - нажатые клавиши модификаторов (Shift, Ctrl, Alt, Meta) во время события

x - горизонтальная координата x для положения мыши

y - вертикальная координата y для положения мыши

xAbs - абсолютная горизонтальная координата x для положения мыши

yAbs - абсолютная вертикальная координата y для положения мыши

clickCount - количество щелчков мыши, связанных с событием

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

scrollType - тип прокрутки, который должен произойти в ответ на это событие; допустимые значения - WHEEL_UNIT_SCROLL и WHEEL_BLOCK_SCROLL

scrollAmount - для scrollType WHEEL_UNIT_SCROLL, количество единиц прокрутки

wheelRotation - целое число "щелчков" вращения колеса мыши

Исключения:

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

С:

1.6

См. также:

MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean), MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)

MouseWheelEvent

public MouseWheelEvent(Component source,
                       int id,
                       long when,
                       int modifiers,
                       int x,
                       int y,
                       int xAbs,
                       int yAbs,
                       int clickCount,
                       boolean popupTrigger,
                       int scrollType,
                       int scrollAmount,
                       int wheelRotation,
                       double preciseWheelRotation)

Параметры:

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

id - целое значение, идентифицирующее событие

when - значение типа long, указывающее время возникновения события

modifiers - нажатые клавиши модификаторов (Shift, Ctrl, Alt, Meta) во время события

x - горизонтальная координата x для положения мыши

y - вертикальная координата y для положения мыши

xAbs - абсолютная горизонтальная координата x для положения мыши

yAbs - абсолютная вертикальная координата y для положения мыши

clickCount - количество щелчков мыши, связанных с событием

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

scrollType - тип прокрутки, который должен произойти в ответ на это событие; допустимые значения - WHEEL_UNIT_SCROLL и WHEEL_BLOCK_SCROLL

scrollAmount - для scrollType WHEEL_UNIT_SCROLL, количество единиц прокрутки

wheelRotation - целое число "щелчков" вращения колеса мыши

preciseWheelRotation - дробное число "щелчков" вращения колеса мыши

Исключения:

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

С:

1.7

См. также:

MouseEvent(java.awt.Component, int, long, int, int, int, int, boolean), MouseEvent(java.awt.Component, int, long, int, int, int, int, int, int, boolean, int)

Методы

getScrollType

public int getScrollType()

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

• MouseWheelEvent.WHEEL_UNIT_SCROLL
• MouseWheelEvent.WHEEL_BLOCK_SCROLL

Возвращает:

либо MouseWheelEvent.WHEEL_UNIT_SCROLL, либо MouseWheelEvent.WHEEL_BLOCK_SCROLL, в зависимости от конфигурации нативной платформы.

См. также:

Adjustable.getUnitIncrement(), Adjustable.getBlockIncrement(), Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int), Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)

getScrollAmount

public int getScrollAmount()

Возвращает количество единиц, которые должны быть прокручены при каждом нажатии колеса мыши. Действительно только если getScrollType возвращает MouseWheelEvent.WHEEL_UNIT_SCROLL

Возвращает:

количество единиц для прокрутки, или неопределенное значение, если getScrollType возвращает MouseWheelEvent.WHEEL_BLOCK_SCROLL

См. также:

getScrollType()

getWheelRotation

public int getWheelRotation()

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

Возвращает:

отрицательные значения, если колесо мыши вращалось вверх/от пользователя, и положительные значения, если колесо мыши вращалось вниз/к пользователю

См. также:

getPreciseWheelRotation()

getPreciseWheelRotation

public double getPreciseWheelRotation()

Возвращает число "щелчков" вращения колеса мыши как double. Частичное вращение может произойти, если мышь поддерживает колесо высокой точности. В этом случае возвращаемое значение будет включать дробный "щелчок".

Возвращает:

отрицательные значения, если колесо мыши вращалось вверх или от пользователя, и положительные значения, если колесо мыши вращалось вниз или к пользователю

С:

1.7

См. также:

getWheelRotation()

getUnitsToScroll

public int getUnitsToScroll()

mouseWheelMoved(MouseWheelEvent event) {
      ScrollPane sp = getScrollPaneFromSomewhere();
      Adjustable adj = sp.getVAdjustable()
      if (MouseWheelEvent.getScrollType() == WHEEL_UNIT_SCROLL) {
          int totalScrollAmount =
              event.getUnitsToScroll() *
              adj.getUnitIncrement();
          adj.setValue(adj.getValue() + totalScrollAmount);
      }
  }

Возвращает:

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

См. также:

getScrollType(), getScrollAmount(), MouseWheelListener, Adjustable, Adjustable.getUnitIncrement(), Scrollable, Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int), ScrollPane, ScrollPane.setWheelScrollingEnabled(boolean), JScrollPane, JScrollPane.setWheelScrollingEnabled(boolean)

paramString

public String paramString()

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

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

paramString в классе MouseEvent

Возвращает:

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