Class lime.ui.Scroller

Extends lime.Sprite.

Defined in: scroller.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	lime.ui.Scroller()

Field Summary
Field Attributes	Field Name and Description
<static>	lime.ui.Scroller.Direction Directions of the scroller.
<static>	lime.ui.Scroller.FRICTION How fast to slow down
<static>	lime.ui.Scroller.OFFSET Offset that can be dragged over the edge
<static>	lime.ui.Scroller.OFFSET_LAG Factor to slow down if over the edge

Fields borrowed from class lime.Sprite:: fill_, getCanvasContextName_, id, supportedRenderers
Fields borrowed from class lime.Node:: customEvent_, eventHandlers_, inTree_, transitionsAdd_, transitionsClear_

Method Summary
Method Attributes	Method Name and Description
	appendChild()
	cancelEvents() Cancel all current movement events.
<private>	captureVelocity_() Capture the scrolling velocity to get some throwing motion after release.
<private>	downHandler_(e) Handle down events
	getDirection() Returns the direction of the scroller (horizontal/vertical)
	measureLimits() Measure the contents of the scroller and set up high and low limits.
<private>	moveHandler_(e) Handle move events.
	removeChild()
	scrollTo(offset, opt_duration) Scroll to specific offset in pixels
	setAnchorPoint()
	setDirection(direction) Set the direction of the scroller (horizontal/vertical)
<private>	upHandler_(e) Handle release(up) events.

Methods borrowed from class lime.Sprite:: getFill, getStroke, setFill, setStroke
Methods borrowed from class lime.Node:: addDependency, addEventListener, addTransition, calcRelativeQuality, clearTransition, createDomElement, getAnchorPoint, getAutoResize, getBoundingBox, getChildAt, getChildIndex, getDeepestDomElement, getDeepestParentWithDom, getDirector, getDirty, getFrame, getHidden, getMask, getNumberOfChildren, getOpacity, getParent, getParentStack_, getPosition, getQuality, getRelativeQuality, getRotation, getScale, getScene, getSize, hitTest, localToNode, localToParent, localToScreen, measureContents, needsDomElement, parentToLocal, releaseDependencies, removeAllChildren, removeChildAt, removeDependency, removeDomElement, removeEventListener, runAction, screenToLocal, setAutoResize, setChildIndex, setDirty, setHidden, setMask, setOpacity, setPosition, setQuality, setRenderer, setRotation, setScale, setSize, setupDependencies, update, updateDomElement, updateLayout, wasAddedToTree, wasRemovedFromTree

Class Detail

lime.ui.Scroller()

Field Detail

<static> lime.ui.Scroller.Direction

Directions of the scroller.

<static> {number} lime.ui.Scroller.FRICTION

How fast to slow down

<static> {number} lime.ui.Scroller.OFFSET

Offset that can be dragged over the edge

<static> {number} lime.ui.Scroller.OFFSET_LAG

Factor to slow down if over the edge

Method Detail

appendChild()

See:: lime.Node#appendChild

cancelEvents()

Cancel all current movement events.

<private> captureVelocity_()

Capture the scrolling velocity to get some throwing motion after release.

<private> downHandler_(e)

Handle down events

Parameters:
{lime.events.Event} e: Event.

{lime.ui.Scroller.Direction} getDirection()

Returns the direction of the scroller (horizontal/vertical)

Returns:: {lime.ui.Scroller.Direction} Scroll direction.

measureLimits()

Measure the contents of the scroller and set up high and low limits.

<private> moveHandler_(e)

Handle move events.

Parameters:
{lime.events.Event} e: Event.

removeChild()

See:: lime.Node#removeChild

scrollTo(offset, opt_duration)

Scroll to specific offset in pixels

Parameters:
{number} offset: Offset in pixels.
{number=} opt_duration: Animation duration.

setAnchorPoint()

See:: lime.Node#setAnchorPoint

{lime.ui.Scroller} setDirection(direction)

Set the direction of the scroller (horizontal/vertical)

Parameters:
{lime.ui.Scroller.Direction} direction: Direction.

Returns:: {lime.ui.Scroller} object itself.

<private> upHandler_(e)

Handle release(up) events.

Parameters:
{lime.events.Event} e: Event.

Classes

Class lime.ui.Scroller