Package | com.gestureworks.cml.elements |
Class | public class Slider |
Inheritance | Slider ![]() ![]() |
Subclasses | ProgressBar |
See also
Property | Defined By | ||
---|---|---|---|
![]() | autoShuffle : Boolean
autoshuffles
| TouchContainer | |
![]() | childList : ChildList
Returns the object's childList. | TouchContainer | |
![]() | className : String
sets the class name of displayobject
| TouchContainer | |
![]() | 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
| Slider | ||
![]() | dropShadow : Boolean
Sets the drop shadow effect
| TouchContainer | |
![]() | group : String | TouchContainer | |
height : Number [override] | Slider | ||
![]() | heightPercent : Number
sets the height of the container
| TouchContainer | |
hit : *
Sets the slider's hit area
| Slider | ||
![]() | id : String
Returns the object's id. | TouchContainer | |
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 : *
specifies the type of layout
| TouchContainer | |
![]() | layoutList : Dictionary | TouchContainer | |
max : Number
Sets the max output value
| Slider | ||
min : Number
Sets the min output value
| Slider | ||
![]() | mouseChildren : Boolean [override]
sets the mousechildren value to true or false. | TouchContainer | |
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. | 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 | |
rail : *
Sets the slider's rail element
| Slider | ||
railAlpha : Number
Alpha of default rail
| Slider | ||
railColor : uint
Color of default rail
| Slider | ||
railLineColor : uint
Color of default rail line
| Slider | ||
![]() | 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 | |
releaseInertia : Boolean [override]
Turns gestureReleaseInertia off and on
| Slider | ||
![]() | sound : String | TouchContainer | |
![]() | state : Dictionary | TouchContainer | |
![]() | stateId : *
Returns the current state id. | TouchContainer | |
steps : int
Sets the number of discrete steps used when discrete is true
| Slider | ||
![]() | toBitmap : Boolean | TouchContainer | |
touchKnob : TouchContainer | Slider | ||
value : Number [read-only]
Stores the current value as mapped to the min and max values. | Slider | ||
width : Number [override] | Slider | ||
![]() | 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. | Slider |
Method | Defined By | ||
---|---|---|---|
Slider()
Constructor
| Slider | ||
![]() | 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] | Slider | ||
createEvents():void | Slider | ||
dispose():void [override]
Destructor
| Slider | ||
![]() | 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
| Slider | ||
input(val:Number):void
Sets the value of the slider. | Slider | ||
isHorizontal():Boolean
Convenience orientation flag
| Slider | ||
![]() | 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 | |
reset():void
Resets the knob position
| Slider | ||
![]() | 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 | |
updateLayout():void | Slider | ||
![]() | 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 | Slider | ||
onDrag(event:GWGestureEvent):void | Slider | ||
setupUI():void
Generates default elements
| Slider |
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 true
.
public function get discrete():Boolean
public function set discrete(value:Boolean):void
height | property |
height:Number
[override] public function get height():Number
public function set height(value:Number):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
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
knobPosition | property |
knobPosition:Number
[read-only] Stores the current knobPosition in pixels
The default value is 0
.
public function get knobPosition():Number
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
orientation | property |
orientation:String
Sets the orientation of the slider, choose horizontal or vertical
The default value is horizontal
.
public function get orientation():String
public function set orientation(value:String):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
railLineColor | property |
railLineColor:uint
Color of default rail line
public function get railLineColor():uint
public function set railLineColor(value:uint):void
releaseInertia | property |
releaseInertia:Boolean
[override] Turns gestureReleaseInertia off and on
The default value is false
.
public function get releaseInertia():Boolean
public function set releaseInertia(value:Boolean):void
steps | property |
steps:int
Sets the number of discrete steps used when discrete is true
The default value is 3
.
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
width | property |
width:Number
[override] public function get width():Number
public function set width(value:Number):void
Slider | () | Constructor |
public function Slider()
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
|
isHorizontal | () | method |
public function isHorizontal():Boolean
Convenience orientation flag
ReturnsBoolean — true if horizontal, false otherwise
|
onDownHit | () | method |
protected function onDownHit(event:*):void
Parameters
event:* |
onDrag | () | method |
protected function onDrag(event:GWGestureEvent):void
Parameters
event:GWGestureEvent |
reset | () | method |
public function reset():void
Resets the knob position
setupUI | () | method |
protected function setupUI():void
Generates default elements
updateLayout | () | method |
public function updateLayout():void