Class Index | File Index

Classes


Class adf.MouseWheelAction


Extends adf.Action.

Defined in: Action.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Extends adf.Action to handle user interaction with a mouse scroll wheel.
Fields borrowed from class adf.Action:
cursor, graphicsZIndex, name, symbol
Method Summary
Method Attributes Method Name and Description
 
activate(element, callBack)
This method activates the action and registers the required event listeners.
 
Deactivates the action and the event listeners set by this action
Methods borrowed from class adf.Action:
reactivate
Class Detail
adf.MouseWheelAction()
Extends adf.Action to handle user interaction with a mouse scroll wheel.
Method Detail
activate(element, callBack)
This method activates the action and registers the required event listeners. The second paramter callBack will be called after the onmousewheel event has been fired by the browser, with only one paramter being the change in position of the scroll wheel.
Parameters:
{Element} element
The HTML DOM element that listens for mouse wheel events.
{Function} callBack
Callback function is called when when a browser's mouse wheel event is fired. The function is passed a single paramater, an Integer, representing how much the user has scrolled.

deactivate()
Deactivates the action and the event listeners set by this action

Documentation generated by JsDoc Toolkit 2.1.0 on Mon May 17 2010 13:45:43 GMT-0700 (PDT)