public interface MouseEventParams extends UiEventModifierParams
| Modifier and Type | Interface and Description |
|---|---|
static class |
MouseEventParams.Builder
A builder of
MouseEventParams. |
| Modifier and Type | Method and 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 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. |
static MouseEventParams.Builder |
newBuilder()
Creates a new
MouseEventParams builder. |
default Point |
screenLocation()
Returns the location of the mouse cursor in the screen's coordinate system at the time the
event occurred.
|
keyModifiersstatic MouseEventParams.Builder newBuilder()
MouseEventParams builder.newBuilder in interface EventParamsnewBuilder in interface UiEventModifierParamsMouseEventParams.Builder instancedefault boolean isBubbles()
true if the event bubbles up through the DOM.isBubbles in interface EventParamsisBubbles in interface UiEventModifierParamsdefault boolean isCancelable()
true if the event can be canceled, and therefore prevented as if the event
never happened.isCancelable in interface EventParamsisCancelable in interface UiEventModifierParamsdefault Point clientLocation()
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.
default Point screenLocation()
default MouseEvent.Button button()
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.
default int clickCount()
For all other UI events returns 0.