Class com.sekati.ui.Scroll

Implemented Interfaces

IScrollable

Description

Scroll handles mouseWheel (PC & Mac), dynamic resizing of content, external size tracking for accordian style content scrolling, slideContent method, modal ui states, proportional bar, gutter and more. 

 Usage:
  var _scroll:Scroll = Scroll("_y", contentMc, maskMc, gutterMc, barMc, true, true, true, true);
  var _scroll:Scroll = Scroll ("_y", contentMc, maskMc, gutter, bar, true, true, true, true, contentMc, .8, .5);

Method Index

new Scroll()
destroy(), init(), isDragging(), isMouseInArea(), isScrollable(), moveScroller(), slideContent(), slideScroller()

Inherited from CoreObject

toString()

Constructor Detail

Scroll

public function Scroll(axis:String, content:Object, mask:MovieClip, gutter:MovieClip, bar:MovieClip, isResizeGutter:Boolean, isResizeBar:Boolean, isMouseWheel:Boolean, isInit:Boolean, contentSizeTracker:Object, friction:Number, ratio:Number)

Constructor

Parameters

axis(String) axis the scroller will scroll on: must be "_x" or "_y"
content(Object) content object
mask(MovieClip) content mask
gutter(MovieClip) gutter object
bar(MovieClip) scroller bar object
isResizeGutter(Boolean) optional resize gutter to content mask
isResizeBar(Boolean) optional resize bar proportional to content
isMouseWheel(Boolean) optional enable mouseWheel scrolling (one may choose to use 2 instances of Scroll for hscroll & vscroll and only want vscroll in which case mouseWheel should only be enabled for one instance)
isInit(Boolean) optional init scroller upon instantiation, else init() must be called manually
contentSizeTracker(Object) optional object used to track content size. Useful in accordian content where visibility or masking is used to hide partial content [default: content]
friction(Number) optional scroll motion friction [default 0.8]
ratio(Number) optional scroll motion ratio [default 0.5]

Return

Void

Throws

Errorif axis is not "_x" or "_y" & returns without proper instantiation 
 Usage:
 	var scroll:Scroll = new Scroll("_x", contentMc, maskMc, gutterMc, barMc, true, true, true, true, contentMc, 0.7, 0.4);

Method Detail

init

public function init():Void

Initialize scroll behavior.

Return

Void

Specified By

init() in com.sekati.ui.IScrollable

slideContent

public function slideContent(pos:Number, sec:Number):Void

Tween content to position, scroller will reposition accordingly.

Parameters

pos(Number) position to slide content on axis
sec(Number) optional tween duration in seconds [default: 0.5]

Return

Void

Specified By

slideContent() in com.sekati.ui.IScrollable

slideScroller

public function slideScroller(pos:Number, sec:Number):Void

Tween bar to position, content will reposition accordingly.

Parameters

pos(Number) position to slide scroller on axis
sec(Number) optional tween duration in seconds [default: 0.5]

Return

Void

Specified By

slideScroller() in com.sekati.ui.IScrollable

moveScroller

public function moveScroller(amount:Number):Void

Move the scroller bar by a certain amount

Parameters

amount(Number) pixels to move: positive or negative

Return

Void 

 	_myScroll.moveScroll( -100 );

isScrollable

public function isScrollable():Boolean

Check if content is scrollable.

Return

Boolean

Specified By

isScrollable() in com.sekati.ui.IScrollable

isDragging

public function isDragging():Boolean

Check if bar is being dragged.

Return

Boolean

Specified By

isDragging() in com.sekati.ui.IScrollable

isMouseInArea

public function isMouseInArea():Boolean

Check if Mouse is in scrollable area.

Return

Boolean

Specified By

isMouseInArea() in com.sekati.ui.IScrollable

destroy

public function destroy():Void

Destroy the Scroll.

Return

Void

Specified By

destroy() in com.sekati.core.CoreInterface

Overrides

destroy() in com.sekati.core.CoreObject

as2api