ui.vscroll

Virtual scrolls.

The component renders plain scrolls without content.

Methods
activeArea assigns active mouse wheel zone
attachEvent attaches the handler to an inner event of the component
blockEvent temporarily blocks triggering of ALL events of the calling object
callEvent calls an inner event
define redefines a single configuration property (or a object with properties)
detachEvent detaches a handler from an event (which was attached before by the attachEvent method)
getScroll return current state of scroller
getSize returns full scrollable size ( scrollWidth or scrollHeight of content )
hasEvent checks whether the component has the specified event handler
mapEvent routes events from one object to another
reset resets the scrollbars
scrollTo set new position of scroller
sizeTo set new size of scrollable content ( scrollWidth or scrollHeight )
unblockEvent cancels events blocking that was enabled by the 'blockEvent' command
Events
onScroll fires when the scroll changes its position
Properties
container an HTML container (or its ID) where the component should be initialized
id the ID of a widget
on allows attaching custom handlers to inner events of the component
scroll the direction of scrolling
scrollHeight the scrolling height of the object (vertical scrolling)
scrollPos the top (vertical scrolling ) or left (horizontal scrolling) offset of the scroll.
scrollSize the width(vertical scrolling) or height(horizontal scrolling) of the scroll
scrollStep the number of items that will be scrolled on each mouse move
scrollVisible defines visibility of scroll
scrollWidth the scrolling width of the object (horizontal scrolling)
zoom the zoom of the total scroll bar length
Other
$skin the method which will be called when skin is defined
config all options from the initial component configuration
name indicates the name of the component (a read-only property)
Back to top