Class: Scroller

lime.ui.Scroller

new lime.ui.Scroller()

Source:

Extends

Summary

Members
<static> Direction
Directions of the scroller.
<static, constant> FRICTION :number
How fast to slow down
<static, constant> OFFSET :number
Offset that can be dragged over the edge
<static, constant> OFFSET_LAG :number
Factor to slow down if over the edge
Inherited
Methods
appendChild()
cancelEvents()
Cancel all current movement events.
<private> captureVelocity_()
Capture the scrolling velocity to get some throwing motion after release.
dispose()
Cleans up event listeners and references
<private> downHandler_(e)
Handle down events
getDirection() → {lime.ui.Scroller.Direction}
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) → {lime.ui.Scroller}
Set the direction of the scroller (horizontal/vertical)
<private> upHandler_(e)
Handle release(up) events.
Inherited
lime.Sprite.addEventListener,  lime.Sprite.addTransition,  lime.Sprite.calcRelativeQuality,  lime.Sprite.clearTransition,  lime.Sprite.createDomElement,  lime.Sprite.getAnchorPoint,  lime.Sprite.getAutoResize,  lime.Sprite.getBoundingBox,  lime.Sprite.getChildAt,  lime.Sprite.getChildIndex,  lime.Sprite.getCSS3DTransformsAllowed,  lime.Sprite.getDeepestDomElement,  lime.Sprite.getDeepestParentWithDom,  lime.Sprite.getDirector,  lime.Sprite.getDirty,  lime.Sprite.getFill,  lime.Sprite.getFrame,  lime.Sprite.getHidden,  lime.Sprite.getMask,  lime.Sprite.getNumberOfChildren,  lime.Sprite.getOpacity,  lime.Sprite.getParent,  lime.Sprite.getParentStack_,  lime.Sprite.getPosition,  lime.Sprite.getQuality,  lime.Sprite.getRelativeQuality,  lime.Sprite.getRotation,  lime.Sprite.getScale,  lime.Sprite.getScene,  lime.Sprite.getSize,  lime.Sprite.getStroke,  lime.Sprite.hitTest,  lime.Sprite.localToNode,  lime.Sprite.localToParent,  lime.Sprite.localToScreen,  lime.Sprite.measureContents,  lime.Sprite.needsDomElement,  lime.Sprite.parentToLocal,  lime.Sprite.removeAllChildren,  lime.Sprite.removeChildAt,  lime.Sprite.removeDomElement,  lime.Sprite.removeEventListener,  lime.Sprite.runAction,  lime.Sprite.screenToLocal,  lime.Sprite.setAllow3DCSSTransforms,  lime.Sprite.setAutoResize,  lime.Sprite.setChildIndex,  lime.Sprite.setDirty,  lime.Sprite.setFill,  lime.Sprite.setHidden,  lime.Sprite.setMask,  lime.Sprite.setOpacity,  lime.Sprite.setPosition,  lime.Sprite.setQuality,  lime.Sprite.setRenderer,  lime.Sprite.setRotation,  lime.Sprite.setScale,  lime.Sprite.setSize,  lime.Sprite.setStroke,  lime.Sprite.update,  lime.Sprite.updateDomElement,  lime.Sprite.updateLayout,  lime.Sprite.wasAddedToTree,  lime.Sprite.wasRemovedFromTree

Members

<static> Direction

Directions of the scroller.
Properties:
Name Type Default Description
HORIZONTAL 0
VERTICAL 1
Source:

<static, constant> FRICTION :number

How fast to slow down
Source:

<static, constant> OFFSET :number

Offset that can be dragged over the edge
Source:

<static, constant> OFFSET_LAG :number

Factor to slow down if over the edge
Source:

Methods

appendChild()

Source:
See:

cancelEvents()

Cancel all current movement events.
Source:

<private> captureVelocity_()

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

dispose()

Cleans up event listeners and references
Source:

<private> downHandler_(e)

Handle down events
Parameters:
Name Type Description
e lime.events.Event Event.
Source:

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

Returns the direction of the scroller (horizontal/vertical)
Source:
Returns:
Scroll direction.
Type
lime.ui.Scroller.Direction

measureLimits()

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

<private> moveHandler_(e)

Handle move events.
Parameters:
Name Type Description
e lime.events.Event Event.
Source:

removeChild()

Source:
See:

scrollTo(offset, opt_duration)

Scroll to specific offset in pixels
Parameters:
Name Type Argument Description
offset number Offset in pixels.
opt_duration number <optional>
 Animation duration.
Source:

setAnchorPoint()

Source:
See:

setDirection(direction) → {lime.ui.Scroller}

Set the direction of the scroller (horizontal/vertical)
Parameters:
Name Type Description
direction lime.ui.Scroller.Direction Direction.
Source:
Returns:
object itself.
Type
lime.ui.Scroller

<private> upHandler_(e)

Handle release(up) events.
Parameters:
Name Type Description
e lime.events.Event Event.
Source: