Module: UWA/Controls/Scroller

Classes

UWA.Controls.Scroller

Index

Members

<protected, inner> name

Properties:

Name	Type	Description
name	Object	Controls identifier

<protected, inner> defaultOptions

Properties:

Name	Type	Description
defaultOptions	Object	The default controls options.

<protected, inner> position

Properties:

Name	Type	Description
position	Object	ScrollBar "x" and "y" current positions.

<protected, inner> scroller

Properties:

Name	Type	Description
scroller	Object	Instance of UWA.Controls.Scroller linked to the current Scrollbar.

<protected, inner> visible

Properties:

Name	Type	Description
visible	Boolean	current visibility Scrollbar status.

Methods

<inner> init(options)

Set the options to the current controls instance, creates observers and elements object

Parameters

Name	Type	Description
options	Object	options hash or a option/value pair.

<inner> destroy()

Destroy scrollbar instance.

<inner> createDebugPixel(position, color, msg, clear)

Create Ghost pixel position that is used to avoid bad click events.

Parameters

Name	Type	Description
position	Object	position axis/value pair.
color	String	pixel color.
msg	String	debug color.
clear	Bool	if true will remove previous pixel.

<inner> buildSkeleton()

Build main dom elements.

<inner> initEvents()

Init main dom events.

<inner> handleEvent() → {Boolean}

Handle scroller events.

Returns

• false if event should not propagate.

Type

Boolean

<inner> setSize(scroll, size)

Change scrollbar dimensions according to scroller.

Parameters

Name	Type	Description
scroll	Number	the width or the height of scroller offset.
size	Number	the width or the height of scroller.

<inner> onScrollInit(event)

Invoked when user click on left button or touch the scrollbar area.

Parameters

Name	Type	Description
event	Event	a standart DOM event.

<inner> onScrollMove(event)

Invoked when user mouse or touch move on the scrollbar area.

Parameters

Name	Type	Description
event	Event	a standart DOM event.

<inner> onScrollStop(event)

Invoked when user mouse or touch up/end/cancel on the scrollbar area.

Parameters

Name	Type	Description
event	Event	a standart DOM event.

<inner> setPosition(x, runtime, hideScrollBars)

Scroll scrollbar to position and handle scrollbar position/display.

Parameters

Name	Type	Description
x	Number	new scroll position axis position.
runtime	Number	scroll duration.
hideScrollBars	Boolean	hide scrollbar during scroll.

<inner> onScrollStart()

Invoked when scrollbar start moving.

<inner> onScrollEnd()

Invoked when scrollbar stop moving.

<inner> show()

Display scrollbar.

<inner> hide()

Hide scrollbar.