Interface MouseWheel

All Superinterfaces:
MouseEvent

public interface MouseWheel extends MouseEvent
An event indicating that the mouse wheel button has been rotated.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    A builder of MouseWheel.
  • Method Summary

    Modifier and Type
    Method
    Description
    default float
    Returns the amount of units to scroll horizontally.
    default float
    Returns the amount of units to scroll vertically.
    default KeyModifiers
    Returns the keyboard modifiers applied.
    default Point
    Returns the mouse position relative to the bounds of the browser instance.
    default Point
    Returns the mouse position relative to the bounds of the screen.
    newBuilder(Point location)
    Creates a new MouseWheel builder with the given required parameters.
    default ScrollType
    Returns the scroll type of the event.
  • Method Details

    • newBuilder

      static MouseWheel.Builder newBuilder(Point location)
      Creates a new MouseWheel builder with the given required parameters.
      Parameters:
      location - the mouse position relative to the bounds of the browser instance
      Returns:
      a new MouseWheel.Builder instance
    • location

      default Point location()
      Description copied from interface: MouseEvent
      Returns the mouse position relative to the bounds of the browser instance.
      Specified by:
      location in interface MouseEvent
    • locationOnScreen

      default Point locationOnScreen()
      Description copied from interface: MouseEvent
      Returns the mouse position relative to the bounds of the screen.
      Specified by:
      locationOnScreen in interface MouseEvent
    • keyModifiers

      default KeyModifiers keyModifiers()
      Returns the keyboard modifiers applied.
    • scrollType

      default ScrollType scrollType()
      Returns the scroll type of the event.
    • deltaX

      default float deltaX()
      Returns the amount of units to scroll horizontally.
    • deltaY

      default float deltaY()
      Returns the amount of units to scroll vertically.