Class MouseEvent<H extends EventHandler>

Type Parameters:
H - handler type
All Implemented Interfaces:
HasNativeEvent
Direct Known Subclasses:
ClickEvent, DoubleClickEvent, MouseDownEvent, MouseMoveEvent, MouseOutEvent, MouseOverEvent, MouseUpEvent, MouseWheelEvent

public abstract class MouseEvent<H extends EventHandler> extends HumanInputEvent<H>
Abstract class representing mouse events.
  • Constructor Details

    • MouseEvent

      public MouseEvent()
  • Method Details

    • getClientX

      public int getClientX()
      Gets the mouse x-position within the browser window's client area.
      Returns:
      the mouse x-position
    • getClientY

      public int getClientY()
      Gets the mouse y-position within the browser window's client area.
      Returns:
      the mouse y-position
    • getNativeButton

      public int getNativeButton()
      Gets the button value. Compare it to NativeEvent.BUTTON_LEFT, NativeEvent.BUTTON_RIGHT, NativeEvent.BUTTON_MIDDLE

      Note: this is unreliable for events not caused by the depression or release of a mouse button.

      Returns:
      the button value
    • getRelativeX

      public int getRelativeX(Element target)
      Gets the mouse x-position relative to a given element.
      Parameters:
      target - the element whose coordinate system is to be used
      Returns:
      the relative x-position
    • getRelativeY

      public int getRelativeY(Element target)
      Gets the mouse y-position relative to a given element.
      Parameters:
      target - the element whose coordinate system is to be used
      Returns:
      the relative y-position
    • getScreenX

      public int getScreenX()
      Gets the mouse x-position on the user's display.
      Returns:
      the mouse x-position
    • getScreenY

      public int getScreenY()
      Gets the mouse y-position on the user's display.
      Returns:
      the mouse y-position
    • getX

      public int getX()
      Gets the mouse x-position relative to the event's current target element.
      Returns:
      the relative x-position
    • getY

      public int getY()
      Gets the mouse y-position relative to the event's current target element.
      Returns:
      the relative y-position