Mouse Interaction
Description: The base interaction layer.
Similar to jQuery.Widget, the mouse interaction is not intended to be used directly. It is purely a base layer for other widgets to inherit from. This page only documents what is added to jQuery.Widget, but it does include internal methods that are not intended to be overwritten. The intended public API is _mouseStart(), _mouseDrag(), _mouseStop(), and _mouseCapture().
Dependencies
Options
cancelType: Selector
"input,textarea,button,select,option"
Initialize the mouse with the cancel option specified:
|
1
|
|
Get or set the cancel option, after initialization:
|
1
2
3
4
5
|
|
delayType: Number
0
Initialize the mouse with the delay option specified:
|
1
|
|
Get or set the delay option, after initialization:
|
1
2
3
4
5
|
|
distanceType: Number
1
Initialize the mouse with the distance option specified:
|
1
|
|
Get or set the distance option, after initialization:
|
1
2
3
4
5
|
|
Methods
_mouseCapture()Returns: Boolean
true.
- This method does not accept any arguments.
Invoke the _mouseCapture method:
|
1
|
|
_mouseDestroy()Returns: jQuery (plugin only)
_destroy() method.
- This method does not accept any arguments.
Invoke the _mouseDestroy method:
|
1
|
|
_mouseDown()Returns: jQuery (plugin only)
delay and distance options are met prior to starting the interaction. When the interaction is ready to start, invokes the _mouseStart() method for the extending widget to handle.
- This method does not accept any arguments.
Invoke the _mouseDown method:
|
1
|
|
_mouseDrag()Returns: jQuery (plugin only)
_mouseDrag() method to handle each movement of an interaction. This method will receive the mouse event associated with the movement.
- This method does not accept any arguments.
Invoke the _mouseDrag method:
|
1
|
|
_mouseInit()Returns: jQuery (plugin only)
_create() method.
- This method does not accept any arguments.
Invoke the _mouseInit method:
|
1
|
|
_mouseMove()Returns: jQuery (plugin only)
mouseDrag() method for the extending widget to handle.
- This method does not accept any arguments.
Invoke the _mouseMove method:
|
1
|
|
_mouseStart()Returns: jQuery (plugin only)
_mouseStart() method to handle the beginning of an interaction. This method will receive the mouse event associated with the start of the interaction.
- This method does not accept any arguments.
Invoke the _mouseStart method:
|
1
|
|
_mouseStop()Returns: jQuery (plugin only)
_mouseStop() method to handle the end of an interaction. This method will receive the mouse event associated with the end of the interaction.
- This method does not accept any arguments.
Invoke the _mouseStop method:
|
1
|
|
_mouseUp()Returns: jQuery (plugin only)
mouseStop() method for the extending widget to handle.
- This method does not accept any arguments.
Invoke the _mouseUp method:
|
1
|
|