Package com.teamdev.jxbrowser.dom.event

Interface WheelEventParams

All Superinterfaces:
EventParams, MouseEventParams, UiEventModifierParams
public interface WheelEventParams extends MouseEventParams
The DOM wheel event parameters.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    WheelEventParams.Builder
    A builder of WheelEventParams.

  • Method Summary

    Modifier and Type
    Method
    Description
    default MouseEvent.Button
    button()
    Returns a button pressed during events caused by pressing or releasing one or multiple buttons.
    default int
    clickCount()
    Returns the count of consecutive clicks that happened in a short amount of time for mouse events, such as "click", "mouseDown, "mouseUp".
    default Point
    clientLocation()
    Returns the location of the mouse cursor in the component's coordinate system at the time the event occurred.
    default WheelEvent.DeltaMode
    deltaMode()
    Returns the delta units type.
    default double
    deltaX()
    Returns the amount of units to scroll horizontally.
    default double
    deltaY()
    Returns the amount of units to scroll vertically.
    default boolean
    isBubbles()
    Returns true if the event bubbles up through the DOM.
    default boolean
    isCancelable()
    Returns true if the event can be canceled, and therefore prevented as if the event never happened.
    default boolean
    isTrusted()
    Returns true if the event is trusted, and therefore was generated by a user action.
    default KeyModifiers
    keyModifiers()
    Returns the key modifiers that are applied to the event.
    default com.teamdev.jxbrowser.dom.event.internal.rpc.MouseEventParams
    mouseParams()
     
    static WheelEventParams.Builder
    newBuilder()
    Creates a new WheelEventParams builder.
    default Point
    screenLocation()
    Returns the location of the mouse cursor in the screen's coordinate system at the time the event occurred.
    default com.teamdev.jxbrowser.dom.event.internal.rpc.WheelEventParams
    self()
     

    Methods inherited from interface com.teamdev.jxbrowser.dom.event.MouseEventParams

    offsetLocation, pageLocation

  • Method Details

    • newBuilder

      static WheelEventParams.Builder newBuilder()
      Creates a new WheelEventParams builder.
      Returns:
      a new WheelEventParams.Builder instance

    • isBubbles

      default boolean isBubbles()
      Returns true if the event bubbles up through the DOM.
      Specified by:
      isBubbles in interface EventParams
      Specified by:
      isBubbles in interface MouseEventParams
      Specified by:
      isBubbles in interface UiEventModifierParams

    • isTrusted

      default boolean isTrusted()
      Returns true if the event is trusted, and therefore was generated by a user action.
      Specified by:
      isTrusted in interface EventParams
      Specified by:
      isTrusted in interface MouseEventParams
      Specified by:
      isTrusted in interface UiEventModifierParams
      Since:
      7.12

    • isCancelable

      default boolean isCancelable()
      Returns true if the event can be canceled, and therefore prevented as if the event never happened.
      Specified by:
      isCancelable in interface EventParams
      Specified by:
      isCancelable in interface MouseEventParams
      Specified by:
      isCancelable in interface UiEventModifierParams

    • clientLocation

      default Point clientLocation()
      Returns the location of the mouse cursor in the component's coordinate system at the time the event occurred.

      For example, clicking in the top-left corner of the client area will always result in that the x field of the result equals 0, regardless of whether the page is scrolled horizontally.

      Specified by:
      clientLocation in interface MouseEventParams

    • screenLocation

      default Point screenLocation()
      Returns the location of the mouse cursor in the screen's coordinate system at the time the event occurred.
      Specified by:
      screenLocation in interface MouseEventParams

    • button

      default MouseEvent.Button button()
      Returns a button pressed during events caused by pressing or releasing one or multiple buttons. As such, it is not reliable for events such as mouseenter, mouseleave, mouseover, mouseout or mousemove.

      Users may change the configuration of buttons on their pointing device so that if an event's button property is MouseEvent.Button.MAIN (left), it may not have been caused by the button that is physically left–most on the pointing device; however, it should behave as if the left button was clicked in the standard button layout.

      Specified by:
      button in interface MouseEventParams

    • clickCount

      default int clickCount()
      Returns the count of consecutive clicks that happened in a short amount of time for mouse events, such as "click", "mouseDown, "mouseUp".

      For all other UI events returns 0.

      Specified by:
      clickCount in interface MouseEventParams

    • deltaX

      default double deltaX()
      Returns the amount of units to scroll horizontally.

    • deltaY

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

    • deltaMode

      default WheelEvent.DeltaMode deltaMode()
      Returns the delta units type.

    • keyModifiers

      default KeyModifiers keyModifiers()
      Returns the key modifiers that are applied to the event.
      Specified by:
      keyModifiers in interface MouseEventParams
      Specified by:
      keyModifiers in interface UiEventModifierParams

    • self

      @InternalApi default com.teamdev.jxbrowser.dom.event.internal.rpc.WheelEventParams self()

    • mouseParams

      @InternalApi default com.teamdev.jxbrowser.dom.event.internal.rpc.MouseEventParams mouseParams()