Packagecom.gestureworks.cml.elements
Classpublic class ProgressBar
InheritanceProgressBar Inheritance Slider Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The ProgressBar provides a visual representation of the progress of a task over time.



Public Properties
 PropertyDefined By
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
  bar : *
The bar object
ProgressBar
  barColor : uint
The color of the default bar
ProgressBar
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
 InheritedcloneExclusions : Vector.<String>
[read-only] Returns a list of properties to exclude when cloning this object
TouchContainer
 InheritedcmlIndex : int
Returns the index created by the CML parser.
TouchContainer
 InheriteddimensionsTo : Object
Sets the dimensions of TouchContainer to given object
TouchContainer
 Inheriteddiscrete : Boolean
Sets the slider's mode
Slider
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
  height : Number
[override] Synchronize the bar height
ProgressBar
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
 Inheritedhit : *
Sets the slider's hit area
Slider
 Inheritedid : String
Returns the object's id.
TouchContainer
 Inheritedknob : *
Sets the slider's knob element
Slider
 InheritedknobColor : uint
Color of default knob
Slider
 InheritedknobPosition : Number
[read-only] Stores the current knobPosition in pixels
Slider
 InheritedknobRadius : Number
Radius of default knob
Slider
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
 Inheritedmax : Number
Sets the max output value
Slider
 Inheritedmin : Number
Sets the min output value
Slider
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 Inheritedorientation : String
Sets the orientation of the slider, choose horizontal or vertical
Slider
 InheritedpaddingBottom : Number
Sets the number of pixels between the container's bottom border and the bottom of its content area.
TouchContainer
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
TouchContainer
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
TouchContainer
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
TouchContainer
 Inheritedposition : *
Sets the position
TouchContainer
 Inheritedrail : *
Sets the slider's rail element
Slider
 InheritedrailAlpha : Number
Alpha of default rail
Slider
 InheritedrailColor : uint
Color of default rail
Slider
 InheritedrailLineColor : uint
Color of default rail line
Slider
 InheritedrelativeX : Boolean
When set true this containers children's x position will be laid out relatively to each other.
TouchContainer
 InheritedrelativeY : Boolean
When set true this containers children's y position will be laid out relatively to each other.
TouchContainer
 InheritedreleaseInertia : Boolean
[override] Turns gestureReleaseInertia off and on
Slider
 Inheritedsound : String
TouchContainer
  source : *
The source task
ProgressBar
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
 Inheritedsteps : int
Sets the number of discrete steps used when discrete is true
Slider
 InheritedtoBitmap : Boolean
TouchContainer
 InheritedtouchKnob : TouchContainer
Slider
 Inheritedvalue : Number
[read-only] Stores the current value as mapped to the min and max values.
Slider
  width : Number
[override] Synchronize the bar width
ProgressBar
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
  defaultKnob : DisplayObject
[override] [read-only] Allows slider knob to be optional
ProgressBar
Public Methods
 MethodDefined By
  
ProgressBar
 Inherited
TouchContainer
 Inherited
method searches the child and adds to the list
TouchContainer
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
addChildAt(child:DisplayObject, index:int):DisplayObject
[override] Adds child to display list and, if not already added, the child list
TouchContainer
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
TouchContainer
 Inherited
childToList(id:String, child:*):void
child appended to the childlist
TouchContainer
 Inherited
clone():*
[override]
Slider
 Inherited
Slider
  
dispose():void
[override] Destructor
ProgressBar
 Inherited
getElementById(id:String):*
Searches CML childList by id.
TouchContainer
 Inherited
getElementsByClassName(className:String):Array
Searches the CML childList by className.
TouchContainer
 Inherited
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
 Inherited
isHorizontal():Boolean
Convenience orientation flag
Slider
 Inherited
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
TouchContainer
 Inherited
makeGestureList(value:XMLList):Object
Creates gestureList object from XML
TouchContainer
 Inherited
parseCML(cml:XMLList):XMLList
Parse cml for local layouts.
TouchContainer
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
TouchContainer
 Inherited
querySelector(selector:String):*
Searches the CML childList by selector.
TouchContainer
 Inherited
querySelectorAll(selector:*):Array
Search the CML childList by selector.
TouchContainer
 Inherited
removeChild(child:DisplayObject):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildAt(index:int):DisplayObject
[override] Removes child from display list and, if not already removed, the child list
TouchContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 2147483647):void
[override] Removes children from display list and, if not already removed, the child list
TouchContainer
 Inherited
reset():void
Resets the knob position
Slider
 Inherited
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
TouchContainer
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
TouchContainer
 Inherited
method sets the dimensions of each child
TouchContainer
 Inherited
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
TouchContainer
 Inherited
Slider
 Inherited
Updates child padding within this container
TouchContainer
 Inherited
Updates child percent dimensions within this container
TouchContainer
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
TouchContainer
 Inherited
Updates child relative positions within this container
TouchContainer
Protected Methods
 MethodDefined 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
Property Detail
barproperty
bar:*

The bar object


Implementation
    public function get bar():*
    public function set bar(value:any):void
barColorproperty 
barColor:uint

The color of the default bar


Implementation
    public function get barColor():uint
    public function set barColor(value:uint):void
defaultKnobproperty 
defaultKnob:DisplayObject  [read-only] [override]

Allows slider knob to be optional


Implementation
    protected function get defaultKnob():DisplayObject
heightproperty 
height:Number[override]

Synchronize the bar height


Implementation
    public function get height():Number
    public function set height(value:Number):void
sourceproperty 
source:*

The source task


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

Synchronize the bar width


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



Method Detail
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