Packagecom.gestureworks.cml.element
Classpublic class ScrollPane
InheritanceScrollPane Inheritance TouchContainer Inheritance TouchContainerFactory Inheritance TouchSprite Inheritance flash.display.Sprite

The ScrollPane creates a masked viewing area of a display object and dynamically updates two scrollbars as that content is optionally dragged or scaled inside the viewing area. The ScrollPane optionally allows content inside the area to be dragged (and/or scaled), and allows the option to explore the content by dragging or touching the scroll bars.



Public Properties
 PropertyDefined By
 Inherited_$height : Number = 0
TouchSprite
 Inherited_$rotation : Number = 0
TouchSprite
 Inherited$rotation : Number
TouchSprite
 Inherited_$scaleX : Number = 1
TouchSprite
 Inherited$scaleX : Number
TouchSprite
 Inherited_$scaleY : Number = 1
TouchSprite
 Inherited$scaleY : Number
TouchSprite
 Inherited$transformPoint : Point
TouchSprite
 Inherited_$width : Number = 0
TouchSprite
 Inherited_$x : Number = 0
TouchSprite
 Inherited$x : Number
TouchSprite
 Inherited_$y : Number = 0
TouchSprite
 Inherited$y : Number
TouchSprite
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainerFactory
 InheritedbroadcastTarget : Boolean
TouchSprite
 InheritedchildList : ChildList
[read-only] returns the childlist
TouchContainerFactory
 Inheritedclass_ : String
Object's css class;
TouchContainerFactory
 InheritedclassName : String
sets the class name of displayobject
TouchContainerFactory
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedclusterBubbling : Boolean
Allows touch points from a childclusters to copy into container touch objects in the local parent child display list stack.
TouchSprite
 InheritedclusterEvents : Boolean
Determins whether clusterEvents are processed and dispatched on the touchSprite.
TouchSprite
 InheritedclusterID : int
TouchSprite
 InheritedcmlIndex : int
sets the cml index
TouchContainerFactory
 Inheritedcml_item : Boolean
TouchSprite
 InheritedcO : ClusterObject
TouchSprite
  _content : *
ScrollPane
 InheriteddebugDisplay : Boolean
TouchSprite
 InheriteddeltaFilterOn : Boolean
Determins whether filtering is applied to the delta values.
TouchSprite
 InheriteddimensionsTo : String
sets the dimensions of touchcontainer
TouchContainerFactory
 InheriteddisableAffineTransform : Boolean
Determins whether internal (native) transformations are affine (dynamically centered) on the touchSprite.
TouchSprite
 InheriteddisableNativeTransform : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite.
TouchSprite
 InheriteddN : Number
TouchSprite
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainerFactory
 InheritedGESTRELIST_UPDATE : String = gestureList update
[static]
TouchSprite
 InheritedgestureEventComplete : Boolean
Indicates weather all gestureEvents have been completed on the touchSprite.
TouchSprite
 InheritedgestureEventRelease : Boolean
Indicates whether all touch points have been released on the touchSprite.
TouchSprite
 InheritedgestureEvents : Boolean
Determins whether gestureEvents are processed and dispatched on the touchSprite.
TouchSprite
 InheritedgestureEventStart : Boolean
Indicates whether any gestureEvents have been started on the touchSprite.
TouchSprite
 InheritedgestureFilters : Boolean
TouchSprite
 InheritedgestureList : Object
TouchSprite
 InheritedgestureReleaseInertia : Boolean
Determins whether release inertia is given to gestureEvents on the touchSprite.
TouchSprite
 InheritedgestureTouchInertia : Boolean
Determins whether touch inertia is processed on the touchSprite.
TouchSprite
 Inherited_gestureTweenOn : Boolean = false
TouchSprite
 InheritedgestureTweenOn : Boolean
TouchSprite
 InheritedgO : GestureListObject
TouchSprite
 Inheritedgroup : String
TouchContainerFactory
  height : Number
[override] Set the height of the window pane of the scrollPane.
ScrollPane
  _hit : TouchContainer
ScrollPane
  _hitBox : Graphic
ScrollPane
  _horizontal : Boolean = false
ScrollPane
  _horizontalMovement : Number
ScrollPane
  _horizontalScroll : ScrollBar
ScrollPane
  _horizStyleSet : Boolean = false
ScrollPane
 Inheritedid : String
sets childlist id
TouchContainerFactory
  invertDrag : Boolean = false
ScrollPane
 Inheritedlayout : *
speciffies the type of layout
TouchContainerFactory
 InheritedlayoutComplete : Function
Sets the function to call when the layout is complete
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 InheritedlayoutUpdate : Function
Sets the function to call when the layout updates
TouchContainer
  _mask : Graphic
ScrollPane
 InheritedmaxScale : Number
This method is called after class initialization.
TouchContainerFactory
 InheritedminScale : Number
This method is called after class initialization.
TouchContainerFactory
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainerFactory
 InheritedN : int
TouchSprite
 InheritednestedTransform : Boolean
TouchSprite
 Inheritedoutline_alpha : Number
sets the alpha of outline
TouchContainerFactory
 Inheritedoutline_color : Number
sets the color of outline
TouchContainerFactory
 Inheritedoutline_joint : String
TODO
TouchContainerFactory
 InheritedoutlineOn : String
specifies the outline of container to true or false
TouchContainerFactory
 Inheritedoutline_stroke : int
sets the line stroke of outline
TouchContainerFactory
  paneStroke : Number
Set the thickness of a border stroke around the pane.
ScrollPane
  paneStrokeColor : uint
Set the color of the paneStroke.
ScrollPane
  paneStrokeMargin : Number
Set a margin if the border should be slightly separate from the content
ScrollPane
 InheritedpointArray : Vector.<PointObject>
[read-only]
TouchSprite
 InheritedpointCount : int
TouchSprite
 InheritedpropertyStates : Array
Deprecated: Please Use state
TouchContainerFactory
 Inheritedscale : Number
Scales display object
TouchContainer
  scrollMargin : Number
Set the margin between the scroll bars and the content;
ScrollPane
  scrollThickness : Number
The only styling that can be set for the scroll bars in the scrollPane is their thickness.
ScrollPane
 InheritedsO : StrokeObject
TouchSprite
 Inheritedstate : Array
property states array
TouchContainerFactory
 Inheritedtargeting : Boolean
Turns off manual ALL targeting control, defaults to a simple hit test targeting model with exclusive target clustering
TouchSprite
 InheritedtargetList : Array
Allows touch and gesture events to explicitly target a group of defined touch objects which can be outside of the local parent child display list stack
TouchSprite
 InheritedtargetObject : Object
Allows touch and gesture events to explicitly target a touch object this can be outside the local parent child display list stack
TouchSprite
 InheritedtargetParent : Boolean
Allows touch and gesture events to explicitly target the parent touch object
TouchSprite
 Inheritedtc : TouchCluster
TouchSprite
 Inheritedtd : TouchDebugDisplay
TouchSprite
 Inheritedtg : TouchGesture
TouchSprite
 InheritedtiO : TimelineObject
TouchSprite
 InheritedtouchChildren : Boolean
TouchSprite
 InheritedtouchObjectID : int
[read-only]
TouchSprite
 Inheritedtp : TouchPipeline
TouchSprite
 InheritedtraceDebugModeOn : Boolean
TouchSprite
 InheritedtransformComplete : Boolean
TouchSprite
 InheritedtransformEventComplete : Boolean
TouchSprite
 InheritedtransformEvents : Boolean
Determins whether transformEvents are processed and dispatched on the touchSprite.
TouchSprite
 InheritedtransformEventStart : Boolean
TouchSprite
 InheritedtransformGestureVectors : Boolean
Determins whether transformations are handled internally (natively) on the touchSprite.
TouchSprite
 InheritedtransformStart : Boolean
TouchSprite
 InheritedtrO : TransformObject
TouchSprite
 Inheritedtt : TouchTransform
TouchSprite
  _vertical : Boolean = false
ScrollPane
  _verticalMovement : Number
ScrollPane
  _verticalScroll : ScrollBar
ScrollPane
  _vertStyleSet : Boolean = false
ScrollPane
  width : Number
[override] Set the width of the window pane of the scrollPane.
ScrollPane
 Inheritedx_lock : Boolean
TouchSprite
 Inheritedy_lock : Boolean
TouchSprite
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainerFactory
Public Methods
 MethodDefined By
  
ScrollPane
 Inherited
TODO
TouchContainerFactory
 Inherited
method searches the child and adds to the list
TouchContainerFactory
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[override] Registers event listeners.
TouchSprite
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainerFactory
  
clone():*
[override]
ScrollPane
  
ScrollPane
  
[override]
ScrollPane
  
dispose():void
[override]
ScrollPane
 Inherited
hideIndex(index:int):void
hides child list index
TouchContainer
 Inherited
hideKey(key:String):void
hides childlist key visibility
TouchContainer
  
init():void
[override]
ScrollPane
 Inherited
makeGestureList(value:XMLList):Object
TODO
TouchContainerFactory
 Inherited
onTouchDown(event:TouchEvent, target:* = null):void
decides how to assign the captured touch point to a cluster can pass to parent, an explicit target, an explicit list or targets or a passed to any touch object in the local display stack.
TouchSprite
 Inherited
parseCML(cml:XMLList):XMLList
[override] Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
postparse method
TouchContainerFactory
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainerFactory
 Inherited
showIndex(index:int):void
shows index of the child list
TouchContainer
 Inherited
showKey(key:String):void
shows the child list key visibility
TouchContainer
 Inherited
TouchSprite
 Inherited
TouchSprite
 Inherited
TouchSprite
  
updateLayout(inWidth:Number, inHeight:Number):void
ScrollPane
 Inherited
Registers/unregisters event handlers depending on the active modes
TouchSprite
 Inherited
TouchSprite
 Inherited
updateProperties(state:Number = 0):void
update properties of child
TouchContainerFactory
 Inherited
TouchSprite
 Inherited
TouchSprite
Protected Methods
 MethodDefined By
 Inherited
This method is called after class initialization.
TouchContainerFactory
 Inherited
This method is called after class initialization.
TouchContainerFactory
 Inherited
randomMinMax(min:Number, max:Number):Number
This method is called after class initialization.
TouchContainerFactory
 Inherited
This method is called after class initialization.
TouchContainerFactory
 Inherited
thumbUpdate(event:Event):void
This method is called after class initialization.
TouchContainerFactory
Property Detail
_contentproperty
public var _content:*

_hitproperty 
public var _hit:TouchContainer

_hitBoxproperty 
public var _hitBox:Graphic

_horizontalproperty 
public var _horizontal:Boolean = false

_horizontalMovementproperty 
public var _horizontalMovement:Number

_horizontalScrollproperty 
public var _horizontalScroll:ScrollBar

_horizStyleSetproperty 
public var _horizStyleSet:Boolean = false

_maskproperty 
public var _mask:Graphic

_verticalproperty 
public var _vertical:Boolean = false

_verticalMovementproperty 
public var _verticalMovement:Number

_verticalScrollproperty 
public var _verticalScroll:ScrollBar

_vertStyleSetproperty 
public var _vertStyleSet:Boolean = false

heightproperty 
height:Number[override]

Set the height of the window pane of the scrollPane.


Implementation
    public function get height():Number
    public function set height(value:Number):void
invertDragproperty 
public var invertDrag:Boolean = false

paneStrokeproperty 
paneStroke:Number

Set the thickness of a border stroke around the pane.


Implementation
    public function get paneStroke():Number
    public function set paneStroke(value:Number):void
paneStrokeColorproperty 
paneStrokeColor:uint

Set the color of the paneStroke.


Implementation
    public function get paneStrokeColor():uint
    public function set paneStrokeColor(value:uint):void
paneStrokeMarginproperty 
paneStrokeMargin:Number

Set a margin if the border should be slightly separate from the content


Implementation
    public function get paneStrokeMargin():Number
    public function set paneStrokeMargin(value:Number):void
scrollMarginproperty 
scrollMargin:Number

Set the margin between the scroll bars and the content;


Implementation
    public function get scrollMargin():Number
    public function set scrollMargin(value:Number):void
scrollThicknessproperty 
scrollThickness:Number

The only styling that can be set for the scroll bars in the scrollPane is their thickness. For all other custom styling, a ScrollBar item should be added in CML, or through the childToList function in AS3, and the ScrollPane class will automatically pull styles from that.


Implementation
    public function get scrollThickness():Number
    public function set scrollThickness(value:Number):void
widthproperty 
width:Number[override]

Set the width of the window pane of the scrollPane.


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Detail
ScrollPane()Constructor
public function ScrollPane()



Method Detail
clone()method
override public function clone():*

Returns
*
createEvents()method 
public function createEvents():void

displayComplete()method 
override public function displayComplete():void

dispose()method 
override public function dispose():void

init()method 
override public function init():void

updateLayout()method 
public function updateLayout(inWidth:Number, inHeight:Number):void

Parameters

inWidth:Number
 
inHeight:Number