A Slider with a label and value label. Abstract base class for VUISlider and HUISlider

Constructor

new (?parent:DisplayObjectContainer, ?xpos:Float, ?ypos:Float, ?label:String, ?defaultHandler:Dynamic)

Constructor

Parameters:

parent

The parent DisplayObjectContainer on which to add this UISlider.

xpos

The x position to place this component.

ypos

The y position to place this component.

label

The initial string to display as this component's label.

defaultHandler

The event handling function to handle the default event for this component (change in this case).

Variables

label:String

Gets / sets the text shown in this component's label.

labelPrecision:Int

Gets / sets the number of decimals to format the value label. Does not affect the actual value of the slider, just the number shown.

maximum:Float

Gets / sets the maximum value of this slider.

minimum:Float

Gets / sets the minimum value of this slider.

tick:Float

Gets / sets the tick value of this slider. This round the value to the nearest multiple of this number.

value:Float

Sets / gets the current value of this slider.

Methods

draw ():Void

Draws the visual ui of this component.

get_label ():String

get_maximum ():Float

get_minimum ():Float

get_tick ():Float

get_value ():Float

setSliderParams (min:Float, max:Float, value:Float):Void

Convenience method to set the three main parameters in one shot.

Parameters:

min

The minimum value of the slider.

max

The maximum value of the slider.

value

The value of the slider.

set_label (value:String):String

set_labelPrecision (value:Int):Int

set_maximum (value:Float):Float

set_minimum (value:Float):Float

set_tick (value:Float):Float

set_value (value:Float):Float

Inherited Variables

Defined by Component

enabled:Bool

Sets/gets whether this component is enabled or not.

tag:Int

Sets/gets in integer that can identify the component.

Inherited Methods

Defined by Component

get_enabled ():Bool

get_height ():Float

get_tag ():Int

get_width ():Float

move (xpos:Float, ypos:Float):Void

Moves the component to the specified position.

Parameters:

xpos

the x position to move the component

ypos

the y position to move the component

setSize (w:Float, h:Float):Void

Sets the size of the component.

Parameters:

w

The width of the component.

h

The height of the component.

set_enabled (value:Bool):Bool

set_height (value:Float):Void

Sets/gets the height of the component.

set_tag (value:Int):Int

set_width (value:Float):Void

Sets/gets the width of the component.

set_x (value:Float):Void

Overrides the setter for x to always place the component on a whole pixel.

set_y (value:Float):Void

Overrides the setter for y to always place the component on a whole pixel.