Class Guacamole.Mouse.Touchscreen
Defined in: Mouse.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Guacamole.Mouse.Touchscreen(element)
Provides cross-browser absolute touch event translation for a given element.
|
| Field Attributes | Field Name and Description |
|---|---|
| <inner> |
The timeout associated with the delayed, cancellable click release.
|
|
The maximum number of pixels to allow a touch to move for the gesture to
be considered a click.
|
|
|
The maximum number of milliseconds to wait for a touch to end for the
gesture to be considered a click.
|
|
|
The current mouse state.
|
|
| <inner> |
Whether a gesture is known to be in progress.
|
| <inner> |
The timeout associated with long-press for right click.
|
|
The amount of time a press must be held for long press to be
detected.
|
|
|
The distance a two-finger touch must move per scrollwheel event, in
pixels.
|
| Event Attributes | Event Name and Description |
|---|---|
|
onmousedown(state)
Fired whenever a mouse button is effectively pressed.
|
|
|
onmousemove(state)
Fired whenever the user moves the mouse by dragging their finger over
the touchscreen element.
|
|
|
onmouseup(state)
Fired whenever a mouse button is effectively released.
|
Class Detail
Guacamole.Mouse.Touchscreen(element)
Provides cross-browser absolute touch event translation for a given element.
Touch events are translated into mouse events as if the touches occurred
on a touchscreen (tapping anywhere on the screen clicks at that point,
long-press to right-click).
- Parameters:
- {Element} element
- The Element to use to provide touch events.
Field Detail
<inner>
click_release_timeout
The timeout associated with the delayed, cancellable click release.
clickMoveThreshold
The maximum number of pixels to allow a touch to move for the gesture to
be considered a click.
clickTimingThreshold
The maximum number of milliseconds to wait for a touch to end for the
gesture to be considered a click.
{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.
<inner>
gesture_in_progress
Whether a gesture is known to be in progress. If false, touch events
will be ignored.
<inner>
long_press_timeout
The timeout associated with long-press for right click.
longPressThreshold
The amount of time a press must be held for long press to be
detected.
scrollThreshold
The distance a two-finger touch must move per scrollwheel event, in
pixels.
Event Detail
onmousedown(state)
Fired whenever a mouse button is effectively pressed. This can happen
as part of a "mousedown" gesture initiated by the user by pressing one
finger over the touchscreen element, as part of a "scroll" gesture
initiated by dragging two fingers up or down, etc.
- Parameters:
- {Guacamole.Mouse.State} state
- The current mouse state.
onmousemove(state)
Fired whenever the user moves the mouse by dragging their finger over
the touchscreen element. Note that unlike Guacamole.Mouse.Touchpad,
dragging a finger over the touchscreen element will always cause
the mouse button to be effectively down, as if clicking-and-dragging.
- Parameters:
- {Guacamole.Mouse.State} state
- The current mouse state.
onmouseup(state)
Fired whenever a mouse button is effectively released. This can happen
as part of a "mouseup" gesture initiated by the user by removing the
finger pressed against the touchscreen element, or as part of a "scroll"
gesture initiated by dragging two fingers up or down, etc.
- Parameters:
- {Guacamole.Mouse.State} state
- The current mouse state.