Package | com.gestureworks.cml.elements |
Class | public class ProgressBar |
Inheritance | ProgressBar ![]() ![]() ![]() |
Property | Defined By | ||
---|---|---|---|
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
bar : *
The bar object
| ProgressBar | ||
barColor : uint
The color of the default bar
| ProgressBar | ||
![]() | 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 | |
![]() | dimensionsTo : Object
Sets the dimensions of TouchContainer to given object
| TouchContainer | |
![]() | discrete : Boolean
Sets the slider's mode
| Slider | |
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
![]() | group : String | TouchContainer | |
height : Number [override]
Synchronize the bar height
| ProgressBar | ||
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
![]() | hit : *
Sets the slider's hit area
| Slider | |
![]() | id : String
Returns the object's id. | TouchContainer | |
![]() | knob : *
Sets the slider's knob element
| Slider | |
![]() | knobColor : uint
Color of default knob
| Slider | |
![]() | knobPosition : Number [read-only]
Stores the current knobPosition in pixels
| Slider | |
![]() | knobRadius : Number
Radius of default knob
| Slider | |
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
![]() | max : Number
Sets the max output value
| Slider | |
![]() | min : Number
Sets the min output value
| Slider | |
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
![]() | orientation : String
Sets the orientation of the slider, choose horizontal or vertical
| Slider | |
![]() | 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 | |
![]() | rail : *
Sets the slider's rail element
| Slider | |
![]() | railAlpha : Number
Alpha of default rail
| Slider | |
![]() | railColor : uint
Color of default rail
| Slider | |
![]() | railLineColor : uint
Color of default rail line
| Slider | |
![]() | 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 | |
![]() | releaseInertia : Boolean [override]
Turns gestureReleaseInertia off and on
| Slider | |
![]() | sound : String | TouchContainer | |
source : *
The source task
| ProgressBar | ||
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
![]() | steps : int
Sets the number of discrete steps used when discrete is true
| Slider | |
![]() | toBitmap : Boolean | TouchContainer | |
![]() | touchKnob : TouchContainer | Slider | |
![]() | value : Number [read-only]
Stores the current value as mapped to the min and max values. | Slider | |
width : Number [override]
Synchronize the bar width
| ProgressBar | ||
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Property | Defined By | ||
---|---|---|---|
![]() | cmlGestureList : Object | TouchContainer | |
defaultKnob : DisplayObject [override] [read-only]
Allows slider knob to be optional
| ProgressBar |
Method | Defined By | ||
---|---|---|---|
ProgressBar | |||
![]() | 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] | Slider | |
![]() | createEvents():void | Slider | |
dispose():void [override]
Destructor
| ProgressBar | ||
![]() | 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] | ProgressBar | ||
input(val:Number):void [override]
Sets the value of the progress bar
| ProgressBar | ||
![]() | isHorizontal():Boolean
Convenience orientation flag
| Slider | |
![]() | 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 | |
![]() | reset():void
Resets the knob position
| Slider | |
![]() | 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 | |
![]() | updateLayout():void | Slider | |
![]() | 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 | ||
---|---|---|---|
onDownHit(event:*):void [override]
Expands or contracts the bar on hit touch
| ProgressBar | ||
onDrag(event:GWGestureEvent):void [override]
Expands or contracts the bar on drag
| ProgressBar | ||
setupUI():void [override]
Generates a default bar if one is not provided
| ProgressBar |
bar | property |
bar:*
The bar object
public function get bar():*
public function set bar(value:any):void
barColor | property |
barColor:uint
The color of the default bar
public function get barColor():uint
public function set barColor(value:uint):void
defaultKnob | property |
defaultKnob:DisplayObject
[read-only] [override] Allows slider knob to be optional
protected function get defaultKnob():DisplayObject
height | property |
height:Number
[override] Synchronize the bar height
public function get height():Number
public function set height(value:Number):void
source | property |
source:*
The source task
public function get source():*
public function set source(value:any):void
width | property |
width:Number
[override] Synchronize the bar width
public function get width():Number
public function set width(value:Number):void
ProgressBar | () | Constructor |
public function ProgressBar()
dispose | () | method |
override public function dispose():void
Destructor
init | () | method |
override public function init():void
input | () | method |
override public function input(val:Number):void
Sets the value of the progress bar
Parameters
val:Number |
onDownHit | () | method |
override protected function onDownHit(event:*):void
Expands or contracts the bar on hit touch
Parameters
event:* |
onDrag | () | method |
override protected function onDrag(event:GWGestureEvent):void
Expands or contracts the bar on drag
Parameters
event:GWGestureEvent |
setupUI | () | method |
override protected function setupUI():void
Generates a default bar if one is not provided