| Package | com.gestureworks.cml.element |
| Class | public class Slider |
| Inheritance | Slider  Container ContainerFactory ElementFactory flash.display.Sprite |
| Subclasses | ProgressBar |
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number [override] [write-only]
sets the alpha for display objects
| ElementFactory | |
| 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] | Slider | ||
| 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 | |
| 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] | Slider | ||
| widthPercent : String
sets the percent of width of display object
| ElementFactory | |
| Property | Defined By | ||
|---|---|---|---|
| defaultKnob : DisplayObject [read-only]
Provides default knob graphic when one is not provided. | Slider | ||
| Method | Defined By | ||
|---|---|---|---|
Slider()
Constructor
| Slider | ||
| 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]
Initializes the slider object
| Slider | ||
input(val:Number):void
Sets the value of the slider. | Slider | ||
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 | Slider | ||
onDrag(event:GWGestureEvent):void | Slider | ||
setupUI():void
Generates default elements
| Slider | ||
| defaultKnob | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdefaultKnob: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:BooleanSets the slider's mode
The default value is true.
public function get discrete():Boolean public function set discrete(value:Boolean):void| gestureReleaseInertia | property |
gestureReleaseInertia:BooleanTurns gestureReleaseInertia off and on
The default value is false.
public function get gestureReleaseInertia():Boolean public function set gestureReleaseInertia(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:uintColor 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:NumberRadius of default knob
public function get knobRadius():Number public function set knobRadius(value:Number):void| max | property |
max:NumberSets the max output value
The default value is 100.
public function get max():Number public function set max(value:Number):void| min | property |
min:NumberSets the min output value
The default value is 0.
public function get min():Number public function set min(value:Number):void| orientation | property |
orientation:StringSets 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:NumberAlpha of default rail
public function get railAlpha():Number public function set railAlpha(value:Number):void| railColor | property |
railColor:uintColor of default rail
public function get railColor():uint public function set railColor(value:uint):void| steps | property |
steps:intSets 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():voidDispose methods and remove listeners
| init | () | method |
override public function init():voidInitializes the slider object
| input | () | method |
public function input(val:Number):voidSets 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():BooleanConvenience orientation flag
ReturnsBoolean — true if horizontal, false otherwise
|
| onDownHit | () | method |
protected function onDownHit(event:*):voidParameters
event:* |
| onDrag | () | method |
| reset | () | method |
public function reset():voidResets the knob position
| setupUI | () | method |
protected function setupUI():voidGenerates default elements
| updateLayout | () | method |
public function updateLayout():void