Package | com.gestureworks.cml.elements |
Class | public class RadialSlider |
Inheritance | RadialSlider ![]() ![]() |
See also
Property | Defined By | ||
---|---|---|---|
![]() | autoShuffle : 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 | ||
![]() | childList : ChildList
Returns the object's childList. | TouchContainer | |
![]() | className : String
sets the class name of displayobject
| TouchContainer | |
clockwise : Boolean
Sets if the slider should go clockwise
| RadialSlider | ||
![]() | 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
| RadialSlider | ||
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
![]() | group : String | TouchContainer | |
![]() | height : Number [override]
sets the height of the container
| TouchContainer | |
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
hit : *
Sets the slider's hit area
| RadialSlider | ||
![]() | id : 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 | ||
![]() | layout : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
max : Number
Sets the max output value
| RadialSlider | ||
min : Number
Sets the min output value
| RadialSlider | ||
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
![]() | 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 | |
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 | ||
![]() | 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 | |
![]() | sound : String | TouchContainer | |
startAngle : Number
Sets the angle, clockwise from x axis, to start the slider
| RadialSlider | ||
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
steps : int
Sets the number of discrete steps used when discrete is true
| RadialSlider | ||
![]() | toBitmap : Boolean | TouchContainer | |
touchKnob : TouchContainer | RadialSlider | ||
value : Number [read-only]
Stores the current value as mapped to the min and max values. | RadialSlider | ||
![]() | width : Number [override]
sets the width of the container
| TouchContainer | |
![]() | widthPercent : Number
sets the width of the container
| TouchContainer |
Property | Defined By | ||
---|---|---|---|
![]() | cmlGestureList : Object | TouchContainer | |
defaultKnob : DisplayObject [read-only]
Provides default knob graphic when one is not provided. | RadialSlider |
Method | Defined By | ||
---|---|---|---|
Constructor
| RadialSlider | ||
![]() | 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] | RadialSlider | ||
createEvents():void | RadialSlider | ||
dispose():void [override]
Destructor
| RadialSlider | ||
![]() | 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]
Initializes the slider object
| RadialSlider | ||
input(val:Number):void
Sets the value of the slider. | RadialSlider | ||
![]() | 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 | |
![]() | 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 | |
![]() | 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 | RadialSlider | ||
onDrag(event:GWGestureEvent):void | RadialSlider | ||
setupUI():void
Generates default elements
| RadialSlider |
centerX | property |
centerX:Number
Sets the center X value to use for slider
public function get centerX():Number
public function set centerX(value:Number):void
centerY | property |
centerY:Number
Sets the center Y value to use for slider
public function get centerY():Number
public function set centerY(value:Number):void
clockwise | property |
clockwise:Boolean
Sets if the slider should go clockwise
The default value is false
.
public function get clockwise():Boolean
public function set clockwise(value:Boolean):void
defaultKnob | property |
defaultKnob:DisplayObject
[read-only] Provides default knob graphic when one is not provided. External to allow subclasses to bypass knob requirement.
protected function get defaultKnob():DisplayObject
discrete | property |
discrete:Boolean
Sets the slider's mode
The default value is false
.
public function get discrete():Boolean
public function set discrete(value:Boolean):void
hit | property |
hit:*
Sets the slider's hit area
The default value is null
.
public function get hit():*
public function set hit(value:any):void
innerRadius | property |
innerRadius:Number
Sets the inner radius value for the slider
public function get innerRadius():Number
public function set innerRadius(value:Number):void
knob | property |
knob:*
Sets the slider's knob element
The default value is null
.
public function get knob():*
public function set knob(value:any):void
knobColor | property |
knobColor:uint
Color of default knob
public function get knobColor():uint
public function set knobColor(value:uint):void
knobRadius | property |
knobRadius:Number
Radius of default knob
public function get knobRadius():Number
public function set knobRadius(value:Number):void
max | property |
max:Number
Sets the max output value
The default value is 100
.
public function get max():Number
public function set max(value:Number):void
min | property |
min:Number
Sets the min output value
The default value is 0
.
public function get min():Number
public function set min(value:Number):void
progress | property |
progress:Number
Sets the progress of the slider, in min to max range. Setting does not refresh display of progress.
public function get progress():Number
public function set progress(value:Number):void
radius | property |
radius:Number
Sets the outer radius value for the slider
public function get radius():Number
public function set radius(value:Number):void
rail | property |
rail:*
Sets the slider's rail element
The default value is null
.
public function get rail():*
public function set rail(value:any):void
railAlpha | property |
railAlpha:Number
Alpha of default rail
public function get railAlpha():Number
public function set railAlpha(value:Number):void
railColor | property |
railColor:uint
Color of default rail
public function get railColor():uint
public function set railColor(value:uint):void
startAngle | property |
startAngle:Number
Sets the angle, clockwise from x axis, to start the slider
public function get startAngle():Number
public function set startAngle(value:Number):void
steps | property |
steps:int
Sets the number of discrete steps used when discrete is true
The default value is 9
.
public function get steps():int
public function set steps(value:int):void
touchKnob | property |
public var touchKnob:TouchContainer
value | property |
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
.
public function get value():Number
RadialSlider | () | Constructor |
public function RadialSlider()
Constructor
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