Scroller.js

Contains the Scroller.

License

MIT-style license.

Summary
Scroller.jsContains the Scroller.
ScrollerThe Scroller is a class to scroll any element with an overflow (including the window) when the mouse cursor reaches certain buondaries of that element.
Properties
startThe scroller starts listening to mouse movements.
stopThe scroller stops listening to mouse movements.

Scroller

The Scroller is a class to scroll any element with an overflow (including the window) when the mouse cursor reaches certain buondaries of that element.  You must call its start method to start listening to mouse movements.

Note

The Scroller requires an XHTML doctype.

Arguments

elementrequired, the element to scroll.
optionsoptional, see options below, and Fx.Base options.

Options

areainteger, the necessary boundaries to make the element scroll.
velocityinteger, velocity ratio, the modifier for the window scrolling speed.

Events

onChangeoptionally, when the mouse reaches some boundaries, you can choose to alter some other values, instead of the scrolling offsets.  Automatically passes as parameters x and y values.
Summary
Properties
startThe scroller starts listening to mouse movements.
stopThe scroller stops listening to mouse movements.

Properties

start

The scroller starts listening to mouse movements.

stop

The scroller stops listening to mouse movements.

The Scroller is a class to scroll any element with an overflow (including the window) when the mouse cursor reaches certain buondaries of that element.
Base class for the Effects.

Documentation by Aaron Newton & Mootools Developers, generated by NaturalDocs and GeSHi