Class Guacamole.Mouse
Defined in: mouse.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Guacamole.Mouse(element)
Provides cross-browser mouse events for a given element.
|
Field Attributes | Field Name and Description |
---|---|
The current mouse state.
|
|
The number of pixels to scroll per line.
|
|
The number of pixels to scroll per page.
|
|
<inner> |
Cumulative scroll delta amount.
|
The minimum amount of pixels scrolled required for a single scroll button
click.
|
|
The number of mousemove events to require before re-enabling mouse
event handling after receiving a touch event.
|
Event Attributes | Event Name and Description |
---|---|
onmousedown(state)
Fired whenever the user presses a mouse button down over the element
associated with this Guacamole.Mouse.
|
|
onmousemove(state)
Fired whenever the user moves the mouse over the element associated with
this Guacamole.Mouse.
|
|
onmouseup(state)
Fired whenever the user releases a mouse button down over the element
associated with this Guacamole.Mouse.
|
Class Detail
Guacamole.Mouse(element)
Provides cross-browser mouse events for a given element. The events of
the given element are automatically populated with handlers that translate
mouse events into a non-browser-specific event provided by the
Guacamole.Mouse instance.
- Parameters:
- {Element} element
- The Element to use to provide mouse events.
Field Detail
{Guacamole.Mouse.State}
currentState
The current mouse state. The properties of this state are updated when
mouse events fire. This state object is also passed in as a parameter to
the handler of any mouse events.
PIXELS_PER_LINE
The number of pixels to scroll per line.
PIXELS_PER_PAGE
The number of pixels to scroll per page.
<inner>
scroll_delta
Cumulative scroll delta amount. This value is accumulated through scroll
events and results in scroll button clicks if it exceeds a certain
threshold.
scrollThreshold
The minimum amount of pixels scrolled required for a single scroll button
click.
touchMouseThreshold
The number of mousemove events to require before re-enabling mouse
event handling after receiving a touch event.
Event Detail
onmousedown(state)
Fired whenever the user presses a mouse button down over the element
associated with this Guacamole.Mouse.
- Parameters:
- {Guacamole.Mouse.State} state
- The current mouse state.
onmousemove(state)
Fired whenever the user moves the mouse over the element associated with
this Guacamole.Mouse.
- Parameters:
- {Guacamole.Mouse.State} state
- The current mouse state.
onmouseup(state)
Fired whenever the user releases a mouse button down over the element
associated with this Guacamole.Mouse.
- Parameters:
- {Guacamole.Mouse.State} state
- The current mouse state.