class ScrollSlider

package minimalcomps.components

extends Slider › Component

Base class for HScrollBar and VScrollBar

Constructor

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

Constructor

Parameters:

orientation

Whether this is a vertical or horizontal slider.

parent

The parent DisplayObjectContainer on which to add this Slider.

xpos

The x position to place this component.

ypos

The y position to place this component.

defaultHandler

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

Variables

pageSize:Int

Sets / gets the amount the value will change when the back is clicked.

read onlythumbPercent:Float

Methods

get_pageSize ():Int

get_thumbPercent ():Float

setThumbPercent (value:Float):Void

Sets the percentage of the size of the thumb button.

set_pageSize (value:Int):Int

Inherited Variables

Defined by Slider

backClick:Bool

Sets / gets whether or not a click on the background of the slider will move the handler to that position.

maximum:Float

Gets / sets the maximum value of this slider.

minimum:Float

Gets / sets the minimum value of this slider.

read onlyrawValue:Float

Gets the value of the slider without rounding it per the tick value.

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.

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 Slider

draw ():Void

Draws the visual ui of the component.

get_backClick ():Bool

get_maximum ():Float

get_minimum ():Float

get_rawValue ():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_backClick (value:Bool):Bool

set_maximum (value:Float):Float

set_minimum (value:Float):Float

set_tick (value:Float):Float

set_value (value:Float):Float

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.