Package | com.gestureworks.cml.elements |
Class | public class ScrollBar |
Inheritance | ScrollBar ![]() ![]() |
Property | Defined By | ||
---|---|---|---|
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
buttonAlpha : Number
The color of the button's background. | ScrollBar | ||
buttonFill : uint
The color of the button's background. | ScrollBar | ||
buttonVisible : Boolean
The color of the button's background. | ScrollBar | ||
![]() | 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 | |
contentHeight : Number
The height of the content that needs to be scrolled. | ScrollBar | ||
contentWidth : Number
The width of the content that needs to be scrolled;
| ScrollBar | ||
cornerHeight : Number
Sets part of the corner radius for the ellipse used to round the rectangle of the thumb. | ScrollBar | ||
cornerWidth : Number
Sets part of the corner radius for the ellipse used to round the rectangle of the thumb. | ScrollBar | ||
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
fill : uint
The scrollbar fill (background color). | ScrollBar | ||
![]() | group : String | TouchContainer | |
height : Number [override] | ScrollBar | ||
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | id : String
Returns the object's id. | TouchContainer | |
invertDrag : Boolean = false | ScrollBar | ||
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
loaded : Boolean [read-only]
Checks to see if the element is loaded. | ScrollBar | ||
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
movementRail : Number | ScrollBar | ||
orientation : String
Designates the orientation of the scrollbar, "horizontal" or "vertical"
| ScrollBar | ||
![]() | 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 | |
![]() | position : *
Sets the position
| TouchContainer | |
railGraphic : Graphic | ScrollBar | ||
railShape : String
Sets the shape of the rail grpahic, either "rectangle" or "roundRectangle". | ScrollBar | ||
railTouch : TouchContainer | ScrollBar | ||
![]() | 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 | |
scrollBtn1 : Graphic | ScrollBar | ||
scrollBtn2 : Graphic | ScrollBar | ||
scrollPosition : Number
The position of the scroll thumb on the rail. | ScrollBar | ||
shape : String
Sets the shape of the thumb, either "rectangle", or "roundRectangle". | ScrollBar | ||
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
thumb : Graphic | ScrollBar | ||
thumbFill : uint
The color of the central thumb that slides up and down the scrollbar. | ScrollBar | ||
thumbMin : Number
The minimum size the thumb of the scroll bar can reach. | ScrollBar | ||
thumbPosition : Number [write-only]
This sets the thumbPosition, this is not to be accessed externally in CML or used in Actionscript,
it is solely here for the ScrollPane class to reach when content is dragged. | ScrollBar | ||
thumbTouch : TouchContainer | ScrollBar | ||
![]() | toBitmap : Boolean | TouchContainer | |
touchBtn1 : TouchContainer | ScrollBar | ||
touchBtn2 : TouchContainer | ScrollBar | ||
width : Number [override] | ScrollBar | ||
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Method | Defined By | ||
---|---|---|---|
Constructor
| ScrollBar | ||
![]() | 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] | ScrollBar | ||
createEvents():void | ScrollBar | ||
dispose():void [override]
Destructor
| ScrollBar | ||
![]() | 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
| ScrollBar | ||
![]() | loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number. | TouchContainer | |
![]() | makeGestureList(value:XMLList):Object
Creates gestureList object from XML
| TouchContainer | |
onDrag(e:GWGestureEvent):void | ScrollBar | ||
![]() | 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 | |
reset():void | ScrollBar | ||
resize(newDimension:Number):void
Used by the ScrollPane class to resize the scrollbar when scrollable content is scaled larger or smaller. | ScrollBar | ||
![]() | 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 | |
![]() | 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 |
buttonAlpha | property |
buttonAlpha:Number
The color of the button's background.
public function get buttonAlpha():Number
public function set buttonAlpha(value:Number):void
buttonFill | property |
buttonFill:uint
The color of the button's background.
public function get buttonFill():uint
public function set buttonFill(value:uint):void
buttonVisible | property |
buttonVisible:Boolean
The color of the button's background.
public function get buttonVisible():Boolean
public function set buttonVisible(value:Boolean):void
contentHeight | property |
contentHeight:Number
The height of the content that needs to be scrolled.
public function get contentHeight():Number
public function set contentHeight(value:Number):void
contentWidth | property |
contentWidth:Number
The width of the content that needs to be scrolled;
public function get contentWidth():Number
public function set contentWidth(value:Number):void
cornerHeight | property |
cornerHeight:Number
Sets part of the corner radius for the ellipse used to round the rectangle of the thumb. Shape must be "roundRectangle" for this to be used.
The default value is 10
.
public function get cornerHeight():Number
public function set cornerHeight(value:Number):void
cornerWidth | property |
cornerWidth:Number
Sets part of the corner radius for the ellipse used to round the rectangle of the thumb. Shape must be "roundRectangle" for this to be used.
The default value is 10
.
public function get cornerWidth():Number
public function set cornerWidth(value:Number):void
fill | property |
fill:uint
The scrollbar fill (background color).
public function get fill():uint
public function set fill(value:uint):void
height | property |
height:Number
[override] public function get height():Number
public function set height(value:Number):void
invertDrag | property |
public var invertDrag:Boolean = false
loaded | property |
loaded:Boolean
[read-only] Checks to see if the element is loaded. Setter is only for cloning to be available to set a scrollbar is loaded, do not set this variable.
public function get loaded():Boolean
movementRail | property |
public var movementRail:Number
orientation | property |
orientation:String
Designates the orientation of the scrollbar, "horizontal" or "vertical"
The default value is vertical
.
public function get orientation():String
public function set orientation(value:String):void
railGraphic | property |
public var railGraphic:Graphic
railShape | property |
railShape:String
Sets the shape of the rail grpahic, either "rectangle" or "roundRectangle".
public function get railShape():String
public function set railShape(value:String):void
railTouch | property |
public var railTouch:TouchContainer
scrollBtn1 | property |
public var scrollBtn1:Graphic
scrollBtn2 | property |
public var scrollBtn2:Graphic
scrollPosition | property |
scrollPosition:Number
The position of the scroll thumb on the rail. This is to dispatch events to the ScrollPane class to set the position of the content, it should not be accessed externally.
public function get scrollPosition():Number
public function set scrollPosition(value:Number):void
shape | property |
shape:String
Sets the shape of the thumb, either "rectangle", or "roundRectangle".
The default value is roundRectangle
.
public function get shape():String
public function set shape(value:String):void
thumb | property |
public var thumb:Graphic
thumbFill | property |
thumbFill:uint
The color of the central thumb that slides up and down the scrollbar. If no color is set, it will default to match the button styles.
public function get thumbFill():uint
public function set thumbFill(value:uint):void
thumbMin | property |
thumbMin:Number
The minimum size the thumb of the scroll bar can reach.
The default value is 30
.
public function get thumbMin():Number
public function set thumbMin(value:Number):void
thumbPosition | property |
thumbPosition:Number
[write-only] This sets the thumbPosition, this is not to be accessed externally in CML or used in Actionscript, it is solely here for the ScrollPane class to reach when content is dragged.
public function set thumbPosition(value:Number):void
thumbTouch | property |
public var thumbTouch:TouchContainer
touchBtn1 | property |
public var touchBtn1:TouchContainer
touchBtn2 | property |
public var touchBtn2:TouchContainer
width | property |
width:Number
[override] public function get width():Number
public function set width(value:Number):void
ScrollBar | () | Constructor |
public function ScrollBar()
Constructor
clone | () | method |
override public function clone():*
Returns* |
createEvents | () | method |
public function createEvents():void
dispose | () | method |
override public function dispose():void
Destructor
init | () | method |
override public function init():void
Initialisation method
onDrag | () | method |
public function onDrag(e:GWGestureEvent):void
Parameters
e:GWGestureEvent |
reset | () | method |
public function reset():void
resize | () | method |
public function resize(newDimension:Number):void
Used by the ScrollPane class to resize the scrollbar when scrollable content is scaled larger or smaller.
Parameters
newDimension:Number |