Class Index | File Index

Classes


Class Guacamole.Mouse.Touchpad


Defined in: Mouse.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Provides cross-browser relative touch event translation for a given element.
Field Summary
Field Attributes Field Name and Description
 
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.
 
The distance a two-finger touch must move per scrollwheel event, in pixels.
Event Summary
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 touchpad element.
 
onmouseup(state)
Fired whenever a mouse button is effectively released.
Class Detail
Guacamole.Mouse.Touchpad(element)
Provides cross-browser relative touch event translation for a given element. Touch events are translated into mouse events as if the touches occurred on a touchpad (drag to push the mouse pointer, tap to click).
Parameters:
{Element} element
The Element to use to provide touch events.
Field Detail
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.

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 "click" gesture initiated by the user by tapping one or more fingers over the touchpad 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 touchpad element.
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 "click" gesture initiated by the user by tapping one or more fingers over the touchpad 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.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jun 10 2015 21:35:44 GMT-0700 (PDT)