Packagecom.adobe.portfolio.components
Classpublic class ScrollPad
InheritanceScrollPad Inheritance NavSkinnableComponent Inheritance spark.components.supportClasses.SkinnableComponent

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The ScrollPad class extends NavSkinnableComponent to implements "touch-like" scrolling of multipage documents.



Public Properties
 PropertyDefined By
  dataProvider : IList
The dataProvider for the list of pages.
ScrollPad
  enabled : Boolean
[override] [write-only]
ScrollPad
  model : IPreviewMultiPageModel
The model of the multipage document being scrolled.
ScrollPad
  pageNavigationEnabled : Boolean
Whether page navigation is enabled (via keyboard, mousewheel)
ScrollPad
  pageNumber : uint
The current page number.
ScrollPad
  scrollDuration : Number
The duration in msec of the scrolling action (effect).
ScrollPad
  scrollPosition : int
The current scroll position.
ScrollPad
  scrollToValue : int
The index of the page that should be scrolled to.
ScrollPad
  showButtons : Boolean
Whether to show the next / previous buttons on a rollOver.
ScrollPad
 InheritedskinState : String
The current skin state
NavSkinnableComponent
Protected Properties
 PropertyDefined By
 InheritedautoListen : AutoListen
NavSkinnableComponent
 InheritedautoWatch : AutoWatch
NavSkinnableComponent
  delayScrollCount : int = 0
ScrollPad
  delayScrollTimer : Timer
ScrollPad
  finalY : int
ScrollPad
  initScrollPosition : int
ScrollPad
  initY : int
ScrollPad
  scrollEffect : Effect
ScrollPad
  scrollTimer : Timer
ScrollPad
  wheelDelta : int = 0
ScrollPad
Public Methods
 MethodDefined By
  
Constructor.
ScrollPad
 Inherited
Creates autoListen and autoWatch for automatically tracking listeners and watchers.
NavSkinnableComponent
  
ScrollPad
 Inherited
Uses autoListen and autoWatch to remove all listeners and watchers.
NavSkinnableComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
[override] Sets the current component state and skin state.
NavSkinnableComponent
Protected Methods
 MethodDefined By
 Inherited
addListener(listener:IEventDispatcher, type:String, handler:Function, useCapture:Boolean = false, priority:int = 0):void
NavSkinnableComponent
 Inherited
addWatcher(watcher:ChangeWatcher):void
NavSkinnableComponent
  
attachSkin():void
[override]
ScrollPad
  
button_clickHandler(event:MouseEvent):void
ScrollPad
  
chooseActivePage(index1:int, index2:int):void
ScrollPad
  
[override]
ScrollPad
  
dataPending():Boolean
ScrollPad
  
ScrollPad
 Inherited
detachSkin():void
[override]
NavSkinnableComponent
 Inherited
[override]
NavSkinnableComponent
  
handleDelayScroll(e:Event):void
ScrollPad
 Inherited
initStates():void
NavSkinnableComponent
  
jumpToPage():void
ScrollPad
  
onAddedToStage(e:Event):void
ScrollPad
  
onEndScroll(e:Event):void
ScrollPad
  
onModelPageNumberChanged(value:uint):void
ScrollPad
  
onRemovedFromStage(e:Event):void
ScrollPad
  
onResize(e:Event):void
ScrollPad
  
pageByDelta(delta:int):void
ScrollPad
  
partAdded(partName:String, instance:Object):void
[override]
ScrollPad
 Inherited
partRemoved(partName:String, instance:Object):void
[override]
NavSkinnableComponent
  
ScrollPad
  
setModelPageNumber(pageNumber:uint):void
ScrollPad
  
setPageNumber(value:uint):void
ScrollPad
  
touchPad_keyDownHandler(event:KeyboardEvent):void
ScrollPad
  
touchPad_mouseDownHandler(event:MouseEvent):void
ScrollPad
  
touchPad_mouseUpHandler(event:MouseEvent):void
ScrollPad
  
touchPad_mouseWheelHandler(event:MouseEvent):void
ScrollPad
  
touchPad_rollOutHandler(event:MouseEvent):void
ScrollPad
  
touchPad_rollOverHandler(event:MouseEvent):void
ScrollPad
  
watchMovement(event:MouseEvent):void
ScrollPad
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
  
imageDisplay:spark.components.DataGroup
Required: false Part Type: Static
An optional skin part that displays a list of pages.
ScrollPad
  
nextBtn:spark.components.Button
Required: false Part Type: Static
An optional skin part that displays a next button for scrolling to the next page.
ScrollPad
  
prevBtn:spark.components.Button
Required: false Part Type: Static
An optional skin part that displays a previous button for scrolling to the next page.
ScrollPad
  
touchPad:spark.components.Group
Required: false Part Type: Static
An optional skin part that is normally transparent and which listens to mouse and keyboard events.
ScrollPad
Public Constants
 ConstantDefined By
 InheritedSTATE_DISABLED : String = disabled
[static]
NavSkinnableComponent
 InheritedSTATE_NORMAL : String = normal
[static]
NavSkinnableComponent
Protected Constants
 ConstantDefined By
  INIT_SCROLL_DURATION : int = 200
[static]
ScrollPad
  logger : ILogger
[static]
ScrollPad
  MIN_SCROLL_DURATION : int = 200
ScrollPad
Property Detail
dataProviderproperty
dataProvider:IList

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The dataProvider for the list of pages.

This property can be used as the source for data binding.


Implementation
    public function get dataProvider():IList
    public function set dataProvider(value:IList):void
delayScrollCountproperty 
protected var delayScrollCount:int = 0

delayScrollTimerproperty 
protected var delayScrollTimer:Timer

enabledproperty 
enabled:Boolean  [write-only] [override]


Implementation
    public function set enabled(value:Boolean):void
finalYproperty 
protected var finalY:int

initScrollPositionproperty 
protected var initScrollPosition:int

initYproperty 
protected var initY:int

modelproperty 
model:IPreviewMultiPageModel

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The model of the multipage document being scrolled.

This property can be used as the source for data binding.


Implementation
    public function get model():IPreviewMultiPageModel
    public function set model(value:IPreviewMultiPageModel):void
pageNavigationEnabledproperty 
pageNavigationEnabled:Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.1
Runtime Versions : Flash Player 10.1, AIR 2.0

Whether page navigation is enabled (via keyboard, mousewheel)

This property can be used as the source for data binding.


Implementation
    public function get pageNavigationEnabled():Boolean
    public function set pageNavigationEnabled(value:Boolean):void
pageNumberproperty 
pageNumber:uint

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The current page number. Setting it will cause ScrollPad to scroll to the indicated page.

This property can be used as the source for data binding.


Implementation
    public function get pageNumber():uint
    public function set pageNumber(value:uint):void
scrollDurationproperty 
scrollDuration:Number

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The duration in msec of the scrolling action (effect).

This property can be used as the source for data binding.


Implementation
    public function get scrollDuration():Number
    public function set scrollDuration(value:Number):void
scrollEffectproperty 
protected var scrollEffect:Effect

scrollPositionproperty 
scrollPosition:int

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The current scroll position. Different from the page index, it basically specifies the vertical edge of pages.

This property can be used as the source for data binding.


Implementation
    public function get scrollPosition():int
    public function set scrollPosition(value:int):void
scrollTimerproperty 
protected var scrollTimer:Timer

scrollToValueproperty 
scrollToValue:int

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

The index of the page that should be scrolled to.

This property can be used as the source for data binding.


Implementation
    public function get scrollToValue():int
    public function set scrollToValue(value:int):void
showButtonsproperty 
showButtons:Boolean

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Whether to show the next / previous buttons on a rollOver.

This property can be used as the source for data binding.


Implementation
    public function get showButtons():Boolean
    public function set showButtons(value:Boolean):void
wheelDeltaproperty 
protected var wheelDelta:int = 0

Constructor Detail
ScrollPad()Constructor
public function ScrollPad()

Language Version : ActionScript 3.0
Product Version : Portfolio 10.0
Runtime Versions : Flash Player 10.1, AIR 2.0

Constructor.

Method Detail
attachSkin()method
override protected function attachSkin():void

button_clickHandler()method 
protected function button_clickHandler(event:MouseEvent):void

Parameters

event:MouseEvent

chooseActivePage()method 
protected function chooseActivePage(index1:int, index2:int):void

Parameters

index1:int
 
index2:int

commitProperties()method 
override protected function commitProperties():void

dataPending()method 
protected function dataPending():Boolean

Returns
Boolean
delayedButtonScroll()method 
protected function delayedButtonScroll():void

handleDelayScroll()method 
protected function handleDelayScroll(e:Event):void

Parameters

e:Event

invalidateScrolling()method 
public function invalidateScrolling():void

jumpToPage()method 
protected function jumpToPage():void

onAddedToStage()method 
protected function onAddedToStage(e:Event):void

Parameters

e:Event

onEndScroll()method 
protected function onEndScroll(e:Event):void

Parameters

e:Event

onModelPageNumberChanged()method 
protected function onModelPageNumberChanged(value:uint):void

Parameters

value:uint

onRemovedFromStage()method 
protected function onRemovedFromStage(e:Event):void

Parameters

e:Event

onResize()method 
protected function onResize(e:Event):void

Parameters

e:Event

pageByDelta()method 
protected function pageByDelta(delta:int):void

Parameters

delta:int

partAdded()method 
override protected function partAdded(partName:String, instance:Object):void

Parameters

partName:String
 
instance:Object

playButtonScroll()method 
protected function playButtonScroll():void

setModelPageNumber()method 
protected function setModelPageNumber(pageNumber:uint):void

Parameters

pageNumber:uint

setPageNumber()method 
protected function setPageNumber(value:uint):void

Parameters

value:uint

touchPad_keyDownHandler()method 
protected function touchPad_keyDownHandler(event:KeyboardEvent):void

Parameters

event:KeyboardEvent

touchPad_mouseDownHandler()method 
protected function touchPad_mouseDownHandler(event:MouseEvent):void

Parameters

event:MouseEvent

touchPad_mouseUpHandler()method 
protected function touchPad_mouseUpHandler(event:MouseEvent):void

Parameters

event:MouseEvent

touchPad_mouseWheelHandler()method 
protected function touchPad_mouseWheelHandler(event:MouseEvent):void

Parameters

event:MouseEvent

touchPad_rollOutHandler()method 
protected function touchPad_rollOutHandler(event:MouseEvent):void

Parameters

event:MouseEvent

touchPad_rollOverHandler()method 
protected function touchPad_rollOverHandler(event:MouseEvent):void

Parameters

event:MouseEvent

watchMovement()method 
protected function watchMovement(event:MouseEvent):void

Parameters

event:MouseEvent

Constant Detail
INIT_SCROLL_DURATIONConstant
protected static const INIT_SCROLL_DURATION:int = 200

loggerConstant 
protected static const logger:ILogger

MIN_SCROLL_DURATIONConstant 
protected const MIN_SCROLL_DURATION:int = 200