Class MouseWheelEvent

All Implemented Interfaces:
HasNativeEvent

public class MouseWheelEvent extends MouseEvent<MouseWheelHandler>
Represents a native mouse wheel event.
  • Constructor Details

  • Method Details

    • getType

      public static DomEvent.Type<MouseWheelHandler> getType()
      Gets the event type associated with mouse wheel events.
      Returns:
      the handler type
    • getAssociatedType

      public final DomEvent.Type<MouseWheelHandler> getAssociatedType()
      Description copied from class: Event
      Returns the Event.Type used to register this event, allowing an EventBus to find handlers of the appropriate class.
      Specified by:
      getAssociatedType in class DomEvent<MouseWheelHandler>
      Returns:
      the type
    • getDeltaY

      public int getDeltaY()
      Get the change in the mouse wheel position along the Y-axis; negative if the mouse wheel is moving north (toward the top of the screen) or positive if the mouse wheel is moving south (toward the bottom of the screen). Note that delta values are not normalized across browsers or OSes.
      Returns:
      the delta of the mouse wheel along the y axis
    • isNorth

      public boolean isNorth()
      Convenience method that returns true if getDeltaY() is a negative value (ie, the velocity is directed toward the top of the screen).
      Returns:
      true if the velocity is directed toward the top of the screen
    • isSouth

      public boolean isSouth()
      Convenience method that returns true if getDeltaY() is a positive value (ie, the velocity is directed toward the bottom of the screen).
      Returns:
      true if the velocity is directed toward the bottom of the screen
    • dispatch

      protected void dispatch(MouseWheelHandler handler)
      Description copied from class: GwtEvent
      Should only be called by HandlerManager. In other words, do not use or call.
      Specified by:
      dispatch in class GwtEvent<MouseWheelHandler>
      Parameters:
      handler - handler
      See Also: