Packagecom.bit101.components
Classpublic class Knob
InheritanceKnob Inheritance Component Inheritance flash.display.Sprite



Public Properties
 PropertyDefined by
 Inheritedheight : Number
Component
  label : String
Knob
  labelPrecision : int
Knob
  maximum : Number
Knob
  minimum : Number
Knob
  mouseRange : Number
Knob
  showValue : Boolean
Knob
  value : Number
Knob
 Inheritedwidth : Number
Component
 Inheritedx : Number
Overrides the setter for x to always place the component on a whole pixel.
Component
 Inheritedy : Number
Overrides the setter for y to always place the component on a whole pixel.
Component
Protected Properties
 PropertyDefined by
 Inherited_height : Number = 0
Component
 Inherited_width : Number = 0
Component
Public Methods
 MethodDefined by
  
Knob(parent:DisplayObjectContainer = null, xpos:Number = 0, ypos:Number = 0, label:String = "", defaultHandler:Function = null)
Constructor
Knob
  
draw():void
Draws the visual ui of the component.
Knob
 Inherited
initStage(stage:Stage):void
[static] Utility method to set up usual stage align and scaling.
Component
 Inherited
move(xpos:Number, ypos:Number):void
Moves the component to the specified position.
Component
 Inherited
setSize(w:Number, h:Number):void
Sets the size of the component.
Component
Protected Methods
 MethodDefined by
  
addChildren():void
Creates the children for this component
Knob
  
Formats the value of the knob to a string based on the current level of precision.
Knob
 Inherited
getShadow(dist:Number, knockout:Boolean = false):DropShadowFilter
DropShadowFilter factory method, used in many of the components.
Component
  
init():void
Initializes the component.
Knob
 Inherited
invalidate():void
Marks the component to be redrawn on the next frame.
Component
Public Constants
 ConstantDefined by
 InheritedDRAW : String = "draw"
[static]
Component
Property detail
labelproperty
label:String  [read-write]Implementation
    public function get label():String
    public function set label(value:String):void
labelPrecisionproperty 
labelPrecision:int  [read-write]Implementation
    public function get labelPrecision():int
    public function set labelPrecision(value:int):void
maximumproperty 
maximum:Number  [read-write]Implementation
    public function get maximum():Number
    public function set maximum(value:Number):void
minimumproperty 
minimum:Number  [read-write]Implementation
    public function get minimum():Number
    public function set minimum(value:Number):void
mouseRangeproperty 
mouseRange:Number  [read-write]Implementation
    public function get mouseRange():Number
    public function set mouseRange(value:Number):void
showValueproperty 
showValue:Boolean  [read-write]Implementation
    public function get showValue():Boolean
    public function set showValue(value:Boolean):void
valueproperty 
value:Number  [read-write]Implementation
    public function get value():Number
    public function set value(value:Number):void
Constructor detail
Knob()constructor
public function Knob(parent:DisplayObjectContainer = null, xpos:Number = 0, ypos:Number = 0, label:String = "", defaultHandler:Function = null)

Constructor

Parameters
parent:DisplayObjectContainer (default = null) — The parent DisplayObjectContainer on which to add this Knob.
 
xpos:Number (default = 0) — The x position to place this component.
 
ypos:Number (default = 0) — The y position to place this component.
 
label:String (default = "") — String containing the label for this component.
 
defaultHandler:Function (default = null) — The event handling function to handle the default event for this component (change in this case).
Method detail
addChildren()method
protected override function addChildren():void

Creates the children for this component

draw()method 
public override function draw():void

Draws the visual ui of the component.

formatValueLabel()method 
protected function formatValueLabel():void

Formats the value of the knob to a string based on the current level of precision.

init()method 
protected override function init():void

Initializes the component.