Packagecom.gestureworks.cml.element
Classpublic class ProgressBar
InheritanceProgressBar Inheritance Slider Inheritance Container Inheritance ContainerFactory Inheritance ElementFactory Inheritance flash.display.Sprite

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



Public Properties
 PropertyDefined By
 Inheritedalpha : Number
[override] [write-only] sets the alpha for display objects
ElementFactory
  bar : *
The bar object
ProgressBar
  barColor : uint
The color of the default bar
ProgressBar
 Inheritedblur : Boolean
Sets the drop shadow effect
ElementFactory
 Inheritedbottom : Number
sets the bottom value
ElementFactory
 InheritedchildList : ChildList
[read-only] store the child list
ContainerFactory
 Inheritedclass_ : String
Object's css class;
ElementFactory
 InheritedclassName : String
sets the class name of displayobject
ElementFactory
 InheritedcmlIndex : int
sets the cml index
ElementFactory
 InheriteddebugStyle : *
sets the debug style
ElementFactory
 InheriteddimensionsTo : String
sets the dimensions of the container
ContainerFactory
 Inheriteddiscrete : Boolean
Sets the slider's mode
Slider
 InheriteddisplayEvents : String
Use for dispatch completes.
ElementFactory
 InheriteddropShadow : Boolean
Sets the drop shadow effect
ElementFactory
 InheritedgestureReleaseInertia : Boolean
Turns gestureReleaseInertia off and on
Slider
  height : Number
[override] Synchronize the bar height
ProgressBar
 InheritedheightPercent : String
sets the height percent of display object
ElementFactory
 Inheritedhit : *
Sets the slider's hit area
Slider
 InheritedhorizontalCenter : Number
sets the horizontal center of display object
ElementFactory
 Inheritedid : String
sets the id of child
ElementFactory
 Inheritedindex : int
sets the index of display object
ElementFactory
 InheritedinfoSource : String
sets info source
ContainerFactory
 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 : *
Sets the layout of the container
Container
 InheritedlayoutComplete : Function
Sets the function to call when the layout is complete
Container
 InheritedlayoutList : Dictionary
Defines the layoutlist
Container
 InheritedlayoutUpdate : Function
Sets the function to call when the layout updates
Container
 Inheritedleft : Number
sets left value
ElementFactory
 Inheritedmax : Number
Sets the max output value
Slider
 Inheritedmin : Number
Sets the min output value
Slider
 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.
Container
 InheritedpaddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area.
Container
 InheritedpaddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area.
Container
 InheritedpaddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area.
Container
 Inheritedposition : String
Sets the position
Container
 InheritedpropertyStates : Array
Deprecated: Please Use state
ElementFactory
 Inheritedrail : *
Sets the slider's rail element
Slider
 InheritedrailAlpha : Number
Alpha of default rail
Slider
 InheritedrailColor : uint
Color of default rail
Slider
 Inheritedright : Number
sets the right value
ElementFactory
 Inheritedscale : Number
Sets both the x and y scale values
ElementFactory
 InheritedscaleX : Number
[override] Sets width of the display object in pixels
ElementFactory
 InheritedscaleY : Number
[override] Sets width of the display object in pixels
ElementFactory
  source : *
The source task
ProgressBar
 Inheritedstate : Array
property states array
ElementFactory
 Inheritedsteps : int
Sets the number of discrete steps used when discrete is true
Slider
 Inheritedtop : Number
sets top value
ElementFactory
 InheritedtouchKnob : TouchContainer
Slider
 Inheritedvalue : Number
[read-only] Stores the current value as mapped to the min and max values.
Slider
 InheritedverticalCenter : Number
sets the vertical center of display object
ElementFactory
  width : Number
[override] Synchronize the bar width
ProgressBar
 InheritedwidthPercent : String
sets the percent of width of display object
ElementFactory
Protected Properties
 PropertyDefined By
  defaultKnob : DisplayObject
[override] [read-only] Allows slider knob to be optional
ProgressBar
Public Methods
 MethodDefined By
  
ProgressBar
 Inherited
This method searches the childlist and add the children
ContainerFactory
 Inherited
addChild(child:DisplayObject):DisplayObject
[override] Adds child to display list and, if not already added, the child list TODO: This mechanism should be abstracted to better syncrhonize child and display lists
Container
 Inherited
applyLayout(value:* = null):void
Apply the containers layout
Container
 Inherited
childToList(id:String, child:*):void
this method append to the childlist
ContainerFactory
 Inherited
clone():*
[override]
Slider
 Inherited
Slider
 Inherited
CML callback
ElementFactory
 Inherited
dispose():void
[override] Dispose methods and remove listeners
Slider
 Inherited
getIndex(index:int):*
returns childlist index
Container
 Inherited
getKey(key:String):*
returns the childlist key
Container
 Inherited
hideIndex(index:int):void
hides the childlist index
Container
 Inherited
hideKey(key:String):void
hides the childlist key
Container
  
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
parseCML(cml:XMLList):XMLList
[override] Parse cml for local layouts.
Container
 Inherited
postparseCML(cml:XMLList):void
post parses the cml file
ElementFactory
 Inherited
reset():void
Resets the knob position
Slider
 Inherited
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists.
Container
 Inherited
This method sets the dimensions of childlist
ContainerFactory
 Inherited
showIndex(index:int):void
shows the childlist index
Container
 Inherited
showKey(key:String):void
shows the childlist key
Container
 Inherited
Slider
 Inherited
updateProperties(state:Number = 0):void
this method updates the properties
ElementFactory
Protected Methods
 MethodDefined By
  
onDownHit(event:*):void
[override] Expands or contracts the bar on hit touch
ProgressBar
  
[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
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