Package | com.gestureworks.cml.element |
Class | public class ProgressBar |
Inheritance | ProgressBar Slider Container ContainerFactory ElementFactory flash.display.Sprite |
Property | Defined By | ||
---|---|---|---|
alpha : 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 | ||
blur : Boolean
Sets the drop shadow effect
| ElementFactory | ||
bottom : Number
sets the bottom value
| ElementFactory | ||
childList : ChildList [read-only]
store the child list
| ContainerFactory | ||
class_ : String
Object's css class;
| ElementFactory | ||
className : String
sets the class name of displayobject
| ElementFactory | ||
cmlIndex : int
sets the cml index
| ElementFactory | ||
debugStyle : *
sets the debug style
| ElementFactory | ||
dimensionsTo : String
sets the dimensions of the container
| ContainerFactory | ||
discrete : Boolean
Sets the slider's mode
| Slider | ||
displayEvents : String
Use for dispatch completes. | ElementFactory | ||
dropShadow : Boolean
Sets the drop shadow effect
| ElementFactory | ||
gestureReleaseInertia : Boolean
Turns gestureReleaseInertia off and on
| Slider | ||
height : Number [override]
Synchronize the bar height
| ProgressBar | ||
heightPercent : String
sets the height percent of display object
| ElementFactory | ||
hit : *
Sets the slider's hit area
| Slider | ||
horizontalCenter : Number
sets the horizontal center of display object
| ElementFactory | ||
id : String
sets the id of child
| ElementFactory | ||
index : int
sets the index of display object
| ElementFactory | ||
infoSource : String
sets info source
| ContainerFactory | ||
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 : *
Sets the layout of the container
| Container | ||
layoutComplete : Function
Sets the function to call when the layout is complete
| Container | ||
layoutList : Dictionary
Defines the layoutlist
| Container | ||
layoutUpdate : Function
Sets the function to call when the layout updates
| Container | ||
left : Number
sets left value
| ElementFactory | ||
max : Number
Sets the max output value
| Slider | ||
min : Number
Sets the min output value
| Slider | ||
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. | Container | ||
paddingLeft : Number
Sets the number of pixels between the component's left border and the left edge of its content area. | Container | ||
paddingRight : Number
Sets the number of pixels between the component's right border and the right edge of its content area. | Container | ||
paddingTop : Number
Sets the number of pixels between the container's top border and the top of its content area. | Container | ||
position : String
Sets the position
| Container | ||
propertyStates : Array Deprecated: Please Use state | ElementFactory | ||
rail : *
Sets the slider's rail element
| Slider | ||
railAlpha : Number
Alpha of default rail
| Slider | ||
railColor : uint
Color of default rail
| Slider | ||
right : Number
sets the right value
| ElementFactory | ||
scale : Number
Sets both the x and y scale values
| ElementFactory | ||
scaleX : Number [override]
Sets width of the display object in pixels
| ElementFactory | ||
scaleY : Number [override]
Sets width of the display object in pixels
| ElementFactory | ||
source : *
The source task
| ProgressBar | ||
state : Array
property states array
| ElementFactory | ||
steps : int
Sets the number of discrete steps used when discrete is true
| Slider | ||
top : Number
sets top value
| ElementFactory | ||
touchKnob : TouchContainer | Slider | ||
value : Number [read-only]
Stores the current value as mapped to the min and max values. | Slider | ||
verticalCenter : Number
sets the vertical center of display object
| ElementFactory | ||
width : Number [override]
Synchronize the bar width
| ProgressBar | ||
widthPercent : String
sets the percent of width of display object
| ElementFactory |
Property | Defined By | ||
---|---|---|---|
defaultKnob : DisplayObject [override] [read-only]
Allows slider knob to be optional
| ProgressBar |
Method | Defined By | ||
---|---|---|---|
ProgressBar | |||
addAllChildren():void
This method searches the childlist and add the children
| ContainerFactory | ||
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 | ||
applyLayout(value:* = null):void
Apply the containers layout
| Container | ||
childToList(id:String, child:*):void
this method append to the childlist
| ContainerFactory | ||
clone():* [override] | Slider | ||
createEvents():void | Slider | ||
displayComplete():void
CML callback
| ElementFactory | ||
dispose():void [override]
Dispose methods and remove listeners
| Slider | ||
getIndex(index:int):*
returns childlist index
| Container | ||
getKey(key:String):*
returns the childlist key
| Container | ||
hideIndex(index:int):void
hides the childlist index
| Container | ||
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 | ||
isHorizontal():Boolean
Convenience orientation flag
| Slider | ||
parseCML(cml:XMLList):XMLList [override]
Parse cml for local layouts. | Container | ||
postparseCML(cml:XMLList):void
post parses the cml file
| ElementFactory | ||
reset():void
Resets the knob position
| Slider | ||
searchChildren(value:*, returnType:Class = null):*
This method does a depth first search of childLists. | Container | ||
setDimensionsToChild():void
This method sets the dimensions of childlist
| ContainerFactory | ||
showIndex(index:int):void
shows the childlist index
| Container | ||
showKey(key:String):void
shows the childlist key
| Container | ||
updateLayout():void | Slider | ||
updateProperties(state:Number = 0):void
this method updates the properties
| ElementFactory |
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()
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