Packagecom.gestureworks.cml.elements
Classpublic class RadialSlider
InheritanceRadialSlider Inheritance TouchContainer Inheritance com.gestureworks.core.TouchSprite

The RadialSlider element creates a circular progress bar that reponds touch and mouse input.

See also

ProgressBar


Public Properties
 PropertyDefined By
 InheritedautoShuffle : Boolean
autoshuffles
TouchContainer
  centerX : Number
Sets the center X value to use for slider
RadialSlider
  centerY : Number
Sets the center Y value to use for slider
RadialSlider
 InheritedchildList : ChildList
Returns the object's childList.
TouchContainer
 InheritedclassName : String
sets the class name of displayobject
TouchContainer
  clockwise : Boolean
Sets if the slider should go clockwise
RadialSlider
 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
  discrete : Boolean
Sets the slider's mode
RadialSlider
 InheriteddropShadow : Boolean
Sets the drop shadow effect
TouchContainer
 Inheritedgroup : String
TouchContainer
 Inheritedheight : Number
[override] sets the height of the container
TouchContainer
 InheritedheightPercent : Number
sets the height of the container
TouchContainer
  hit : *
Sets the slider's hit area
RadialSlider
 Inheritedid : String
Returns the object's id.
TouchContainer
  innerRadius : Number
Sets the inner radius value for the slider
RadialSlider
  knob : *
Sets the slider's knob element
RadialSlider
  knobColor : uint
Color of default knob
RadialSlider
  knobRadius : Number
Radius of default knob
RadialSlider
 Inheritedlayout : *
specifies the type of layout
TouchContainer
 InheritedlayoutList : Dictionary
TouchContainer
  max : Number
Sets the max output value
RadialSlider
  min : Number
Sets the min output value
RadialSlider
 InheritedmouseChildren : Boolean
[override] sets the mousechildren value to true or false.
TouchContainer
 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
  progress : Number
Sets the progress of the slider, in min to max range.
RadialSlider
  radius : Number
Sets the outer radius value for the slider
RadialSlider
  rail : *
Sets the slider's rail element
RadialSlider
  railAlpha : Number
Alpha of default rail
RadialSlider
  railColor : uint
Color of default rail
RadialSlider
 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
 Inheritedsound : String
TouchContainer
  startAngle : Number
Sets the angle, clockwise from x axis, to start the slider
RadialSlider
 Inheritedstate : Dictionary
TouchContainer
 InheritedstateId : *
Returns the current state id.
TouchContainer
  steps : int
Sets the number of discrete steps used when discrete is true
RadialSlider
 InheritedtoBitmap : Boolean
TouchContainer
  touchKnob : TouchContainer
RadialSlider
  value : Number
[read-only] Stores the current value as mapped to the min and max values.
RadialSlider
 Inheritedwidth : Number
[override] sets the width of the container
TouchContainer
 InheritedwidthPercent : Number
sets the width of the container
TouchContainer
Protected Properties
 PropertyDefined By
 InheritedcmlGestureList : Object
TouchContainer
  defaultKnob : DisplayObject
[read-only] Provides default knob graphic when one is not provided.
RadialSlider
Public Methods
 MethodDefined By
  
Constructor
RadialSlider
 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
  
clone():*
[override]
RadialSlider
  
RadialSlider
  
dispose():void
[override] Destructor
RadialSlider
 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] Initializes the slider object
RadialSlider
  
input(val:Number):void
Sets the value of the slider.
RadialSlider
 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
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
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
RadialSlider
  
onDrag(event:GWGestureEvent):void
RadialSlider
  
setupUI():void
Generates default elements
RadialSlider
Property Detail
centerXproperty
centerX:Number

Sets the center X value to use for slider


Implementation
    public function get centerX():Number
    public function set centerX(value:Number):void
centerYproperty 
centerY:Number

Sets the center Y value to use for slider


Implementation
    public function get centerY():Number
    public function set centerY(value:Number):void
clockwiseproperty 
clockwise:Boolean

Sets if the slider should go clockwise

The default value is false.


Implementation
    public function get clockwise():Boolean
    public function set clockwise(value:Boolean):void
defaultKnobproperty 
defaultKnob:DisplayObject  [read-only]

Provides default knob graphic when one is not provided. External to allow subclasses to bypass knob requirement.


Implementation
    protected function get defaultKnob():DisplayObject
discreteproperty 
discrete:Boolean

Sets the slider's mode

The default value is false.


Implementation
    public function get discrete():Boolean
    public function set discrete(value:Boolean):void
hitproperty 
hit:*

Sets the slider's hit area

The default value is null.


Implementation
    public function get hit():*
    public function set hit(value:any):void
innerRadiusproperty 
innerRadius:Number

Sets the inner radius value for the slider


Implementation
    public function get innerRadius():Number
    public function set innerRadius(value:Number):void
knobproperty 
knob:*

Sets the slider's knob element

The default value is null.


Implementation
    public function get knob():*
    public function set knob(value:any):void
knobColorproperty 
knobColor:uint

Color of default knob


Implementation
    public function get knobColor():uint
    public function set knobColor(value:uint):void
knobRadiusproperty 
knobRadius:Number

Radius of default knob


Implementation
    public function get knobRadius():Number
    public function set knobRadius(value:Number):void
maxproperty 
max:Number

Sets the max output value

The default value is 100.


Implementation
    public function get max():Number
    public function set max(value:Number):void
minproperty 
min:Number

Sets the min output value

The default value is 0.


Implementation
    public function get min():Number
    public function set min(value:Number):void
progressproperty 
progress:Number

Sets the progress of the slider, in min to max range. Setting does not refresh display of progress.


Implementation
    public function get progress():Number
    public function set progress(value:Number):void
radiusproperty 
radius:Number

Sets the outer radius value for the slider


Implementation
    public function get radius():Number
    public function set radius(value:Number):void
railproperty 
rail:*

Sets the slider's rail element

The default value is null.


Implementation
    public function get rail():*
    public function set rail(value:any):void
railAlphaproperty 
railAlpha:Number

Alpha of default rail


Implementation
    public function get railAlpha():Number
    public function set railAlpha(value:Number):void
railColorproperty 
railColor:uint

Color of default rail


Implementation
    public function get railColor():uint
    public function set railColor(value:uint):void
startAngleproperty 
startAngle:Number

Sets the angle, clockwise from x axis, to start the slider


Implementation
    public function get startAngle():Number
    public function set startAngle(value:Number):void
stepsproperty 
steps:int

Sets the number of discrete steps used when discrete is true

The default value is 9.


Implementation
    public function get steps():int
    public function set steps(value:int):void
touchKnobproperty 
public var touchKnob:TouchContainer

valueproperty 
value:Number  [read-only]

Stores the current value as mapped to the min and max values. Can be used as input value, set input=true

The default value is 0.


Implementation
    public function get value():Number
Constructor Detail
RadialSlider()Constructor
public function RadialSlider()

Constructor

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

Initializes the slider object

input()method 
public function input(val:Number):void

Sets the value of the slider. Can set mouseInput=false to disable touch/mouse interaction.

Parameters

val:Number — Input value contrained to output min and max

onDownHit()method 
protected function onDownHit(event:*):void

Parameters

event:*

onDrag()method 
protected function onDrag(event:GWGestureEvent):void

Parameters

event:GWGestureEvent

setupUI()method 
protected function setupUI():void

Generates default elements