Package | com.gestureworks.cml.elements |
Class | public class ScrollPane |
Inheritance | ScrollPane ![]() ![]() |
Property | Defined By | ||
---|---|---|---|
autohide : Boolean
Sets whether to auto-hides scroll bars. | ScrollPane | ||
autohideSpeed : Number
Sets the auto-hide tween speed. | ScrollPane | ||
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
![]() | childList : ChildList
Returns the object's childList. | TouchContainer | |
![]() | className : String
sets the class name of displayobject
| TouchContainer | |
![]() | cloneExclusions : Vector.<String> [read-only]
Returns a list of properties to exclude when cloning this object
| TouchContainer | |
![]() | cmlIndex : int
Returns the index created by the CML parser. | TouchContainer | |
content : * [read-only]
Returns content of pane. | ScrollPane | ||
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
enableScroll : Boolean [write-only]
Drag event registration
| ScrollPane | ||
![]() | group : String | TouchContainer | |
![]() | height : Number [override]
sets the height of the container
| TouchContainer | |
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
_horizontal : Boolean = false | ScrollPane | ||
_horizontalMovement : Number | ScrollPane | ||
_horizontalScroll : ScrollBar | ScrollPane | ||
_horizStyleSet : Boolean = false | ScrollPane | ||
![]() | id : String
Returns the object's id. | TouchContainer | |
invertDrag : Boolean
Sets whether to invert drag. | ScrollPane | ||
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
_mask : Graphic | ScrollPane | ||
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
![]() | paddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area. | TouchContainer | |
![]() | paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | TouchContainer | |
![]() | paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | TouchContainer | |
![]() | paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | TouchContainer | |
paneStroke : Number
Sets the thickness of a border stroke around the pane. | ScrollPane | ||
paneStrokeColor : uint
Sets the color of the pane stroke. | ScrollPane | ||
paneStrokeMargin : Number
Set a margin if the border should be slightly separate from the content. | ScrollPane | ||
![]() | position : *
Sets the position
| TouchContainer | |
![]() | relativeX : Boolean
When set true this containers children's x position will be laid out relatively
to each other. | TouchContainer | |
![]() | relativeY : Boolean
When set true this containers children's y position will be laid out relatively
to each other. | 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 | ||
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
![]() | toBitmap : Boolean | TouchContainer | |
_vertical : Boolean = false | ScrollPane | ||
_verticalMovement : Number | ScrollPane | ||
_verticalScroll : ScrollBar | ScrollPane | ||
_vertStyleSet : Boolean = false | ScrollPane | ||
![]() | width : Number [override]
sets the width of the container
| TouchContainer | |
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
Constructor
| ScrollPane | ||
![]() | activateTouch():void | TouchContainer | |
![]() | addAllChildren():void
method searches the child and adds to the list
| TouchContainer | |
![]() | addChild(child:DisplayObject):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds child to display list and, if not already added, the child list
| TouchContainer | |
![]() | applyLayout(value:* = null):void
Apply the containers layout
| TouchContainer | |
![]() | childToList(id:String, child:*):void
child appended to the childlist
| TouchContainer | |
clone():* [override]
Clone method
| ScrollPane | ||
createEvents():void
Creates scroll pane events
| ScrollPane | ||
dispose():void [override]
Destructor
| ScrollPane | ||
![]() | getElementById(id:String):*
Searches CML childList by id. | TouchContainer | |
![]() | getElementsByClassName(className:String):Array
Searches the CML childList by className. | TouchContainer | |
![]() | getElementsByTagName(tagName:Class):Array
Searches the CML childList by tagName as Class. | TouchContainer | |
init():void [override]
Initialisation method
| ScrollPane | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
![]() | parseCML(cml:XMLList):XMLList
Parse cml for local layouts. | TouchContainer | |
![]() | postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine. | TouchContainer | |
![]() | querySelector(selector:String):*
Searches the CML childList by selector. | TouchContainer | |
![]() | querySelectorAll(selector:*):Array
Search the CML childList by selector. | TouchContainer | |
![]() | removeChild(child:DisplayObject):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildAt(index:int):DisplayObject [override]
Removes child from display list and, if not already removed, the child list
| TouchContainer | |
![]() | removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void [override]
Removes children from display list and, if not already removed, the child list
| TouchContainer | |
removeEvents():void
Removes scroll pane events
| ScrollPane | ||
reset():void
Resets scroll positions. | ScrollPane | ||
![]() | saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number. | TouchContainer | |
![]() | searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | TouchContainer | |
![]() | setDimensionsToChild():void
method sets the dimensions of each child
| TouchContainer | |
![]() | tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index. | TouchContainer | |
updateContent(value:DisplayObject):void
Updates / replaces content with given value. | ScrollPane | ||
updateLayout(inWidth:Number, inHeight:Number):void
Updates scroll pane layout
| ScrollPane | ||
![]() | updatePadding():void
Updates child padding within this container
| TouchContainer | |
![]() | updatePercentDim():void
Updates child percent dimensions within this container
| TouchContainer | |
![]() | updateProperties(state:* = 0):void
Updates properties from state. | TouchContainer | |
![]() | updateRelativePos():void
Updates child relative positions within this container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
onScale(e:GWGestureEvent):void | ScrollPane |
_horizontal | property |
public var _horizontal:Boolean = false
_horizontalMovement | property |
public var _horizontalMovement:Number
_horizontalScroll | property |
public var _horizontalScroll:ScrollBar
_horizStyleSet | property |
public var _horizStyleSet:Boolean = false
_mask | property |
public var _mask:Graphic
_vertical | property |
public var _vertical:Boolean = false
_verticalMovement | property |
public var _verticalMovement:Number
_verticalScroll | property |
public var _verticalScroll:ScrollBar
_vertStyleSet | property |
public var _vertStyleSet:Boolean = false
autohide | property |
autohide:Boolean
Sets whether to auto-hides scroll bars.
The default value is false
.
public function get autohide():Boolean
public function set autohide(value:Boolean):void
autohideSpeed | property |
autohideSpeed:Number
Sets the auto-hide tween speed.
The default value is .5
.
public function get autohideSpeed():Number
public function set autohideSpeed(value:Number):void
content | property |
content:*
[read-only] Returns content of pane.
public function get content():*
enableScroll | property |
enableScroll:Boolean
[write-only] Drag event registration
public function set enableScroll(value:Boolean):void
invertDrag | property |
invertDrag:Boolean
Sets whether to invert drag.
The default value is false
.
public function get invertDrag():Boolean
public function set invertDrag(value:Boolean):void
paneStroke | property |
paneStroke:Number
Sets the thickness of a border stroke around the pane.
The default value is 1
.
public function get paneStroke():Number
public function set paneStroke(value:Number):void
paneStrokeColor | property |
paneStrokeColor:uint
Sets the color of the pane stroke.
The default value is 0x777777
.
public function get paneStrokeColor():uint
public function set paneStrokeColor(value:uint):void
paneStrokeMargin | property |
paneStrokeMargin:Number
Set a margin if the border should be slightly separate from the content.
The default value is 0
.
public function get paneStrokeMargin():Number
public function set paneStrokeMargin(value:Number):void
scrollMargin | property |
scrollMargin:Number
Set the margin between the scroll bars and the content.
The default value is 5
.
public function get scrollMargin():Number
public function set scrollMargin(value:Number):void
scrollThickness | property |
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.
The default value is 30
.
public function get scrollThickness():Number
public function set scrollThickness(value:Number):void
ScrollPane | () | Constructor |
public function ScrollPane()
Constructor
clone | () | method |
override public function clone():*
Clone method
Returns* |
createEvents | () | method |
public function createEvents():void
Creates scroll pane events
dispose | () | method |
override public function dispose():void
Destructor
init | () | method |
override public function init():void
Initialisation method
onScale | () | method |
protected function onScale(e:GWGestureEvent):void
Parameters
e:GWGestureEvent |
removeEvents | () | method |
public function removeEvents():void
Removes scroll pane events
reset | () | method |
public function reset():void
Resets scroll positions.
updateContent | () | method |
public function updateContent(value:DisplayObject):void
Updates / replaces content with given value. If you are only changing the dimensions of the content, such as a string change on a text field, the method updateLayout will be faster.
Parameters
value:DisplayObject |
updateLayout | () | method |
public function updateLayout(inWidth:Number, inHeight:Number):void
Updates scroll pane layout
Parameters
inWidth:Number (default = NaN )
| |
inHeight:Number (default = NaN )
|