org.openPyro.controls.Slider

Public Properties

	Property		Defined by
		backgroundPainter : IPainter UIControls can have a backgroundPainter object attached that is triggered everytime updateDisplayList is called.	UIControl
		creationCompleteFired : Boolean	MeasurableControl
		direction : String [read-only]	Slider
		displayListInvalidated : Boolean = true Flag to mark a dirty displaylist.	MeasurableControl
		dragData : Object	UIControl
		dragEnabled : Boolean	UIControl
		dropEnabled : Boolean	UIControl
		explicitWidth : Number The height set in terms of actual pixels.	MeasurableControl
		forceInvalidateDisplayList : Boolean = false	MeasurableControl
		height : Number Set/get the height of the control.	MeasurableControl
		includeInLayout : Boolean Specifies whether this control participates in the layout system in OpenPyro.	MeasurableControl
		initialized : Boolean = false Property indicates whether a control has been initialized or not.	MeasurableControl
		isThumbPressed : Boolean [read-only] Returns a boolean value indicating whether the thumb button is currently pressed or not	Slider
		maximum : Number Returns the maximum value for the slider	Slider
		maximumHeight : Number	MeasurableControl
		maximumWidth : Number	MeasurableControl
		measuredHeight : Number Overrides the set measuredHeight property from `MeasurableControl` to invalidate children (UIControl acknowledges that it can have children whose dimensions are based on its own)	UIControl
		measuredWidth : Number Overrides the set measuredWidth property from `MeasurableControl` to invalidate children (UIControl acknowledges that it can have children whose dimensions are based on its own)	UIControl
		minimum : Number Returns the minimum value for the slider	Slider
		minThumbHeight : Number [write-only]	Slider
		mouseActionsDisabled : Boolean	MeasurableControl
		needsMeasurement : Boolean = true Only setting percent width/heights changes the needsMeasurement flag which makes its parent container call measure on it.	MeasurableControl
		padding : Padding Paddings define the unusable space within UIContainers that should not be used for measurement and layout.	UIControl
		parentContainer : UIControl	MeasurableControl
		percentHeight : Number	MeasurableControl
		percentUnusedHeight : Number Set/get the percent height.	MeasurableControl
		percentUnusedWidth : Number Set/get the percent width.	MeasurableControl
		percentWidth : Number	MeasurableControl
		sizeInvalidated : Boolean = false The flag to mark that the control's size has been invalidated.	MeasurableControl
		skin : ISkin [write-only]	Slider
		skinnedControl : UIControl	UIControl
		styleName : String Defines the skin this component is registered to.	UIControl
		thumbButton : Button	Slider
		thumbButtonHeight : Number	Slider
		thumbButtonWidth : Number	Slider
		thumbSkin : ISkin [write-only]	Slider
		toolTip : *	UIControl
		trackSkin : DisplayObject [write-only]	Slider
		usesMeasurementStrategy : Boolean This property defines whether measure() will be called during validateSize() or not.	MeasurableControl
		value : Number	Slider
		visible : Boolean	MeasurableControl
		width : Number Set/get the width of the control.	MeasurableControl

	Property	Defined by
		_backgroundPainter : IPainter	UIControl
		boundsRect : Rectangle	Slider
		_creationCompleteFired : Boolean = false	MeasurableControl
		_dimensionsChanged : Boolean = true	MeasurableControl
		_direction : String	Slider
		_dragEnabled : Boolean = false	UIControl
		_dropEnabled : Boolean = false	UIControl
		_explicitHeight : Number = NaN	MeasurableControl
		_explicitWidth : Number = NaN	MeasurableControl
		isMouseDown : Boolean = false	UIControl
		_isThumbPressed : Boolean = false	Slider
		_maximumHeight : Number = NaN	MeasurableControl
		_maximumWidth : Number = NaN	MeasurableControl
		_measuredHeight : Number = NaN	MeasurableControl
		_measuredWidth : Number = NaN	MeasurableControl
		_minThumbHeight : Number = 50	Slider
		_mouseActionsDisabled : Boolean = false	MeasurableControl
		_padding : Padding	UIControl
		_parentContainer : UIControl	MeasurableControl
		_percentHeight : Number	MeasurableControl
		_percentUnusedHeight : Number	MeasurableControl
		_percentUnusedWidth : Number	MeasurableControl
		_percentWidth : Number	MeasurableControl
		_skin : ISkin	UIControl
		_skinnedControl : UIControl	UIControl
		_styleName : String	UIControl
		_thumbButton : Button	Slider
		_thumbButtonHeight : Number = 20	Slider
		_thumbButtonWidth : Number = 20	Slider
		thumbButtonX : Number = 0	Slider
		thumbButtonY : Number = 0	Slider
		_thumbSkin : ISkin	Slider
		_toolTipData : *	UIControl
		toolTipRenderer : Class	UIControl
		_trackSkin : DisplayObject	Slider

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		Slider(direction:String)	Slider
		addChild(child:DisplayObject):DisplayObject	UIControl
		addChildAt(child:DisplayObject, index:int):DisplayObject	UIControl
		cancelMouseEvents():void	MeasurableControl
		checkDisplayListValidation():void Calls the queueValidateDisplayList if measure causes _dimensionsChanged to change to true.	UIControl
		dispatchScrollEvent():void	Slider
		dispose():void	UIControl
		doLayoutChildren():void	UIControl
		doOnAdded():void [Temp] This function is called automatically by a parent UIControl if this is created as a child of a UIControl.	MeasurableControl
		enableMouseEvents():void	MeasurableControl
		getExplicitOrMeasuredHeight():Number Returns the explicitly defined height or the measured height computed by the `measure` function.	MeasurableControl
		getExplicitOrMeasuredWidth():Number Returns the explicitly defined width or the measured number computed by the `measure` function.	MeasurableControl
		heightForMeasurement():Number When measure is called, it uses the widthForMeasurement and heightForMeasurement to calculate the sizes for percent-dimension based children	UIControl
		initialize():void	Slider
		invalidateSize(event:PyroEvent = null):void Marks itself dirty and waits till either the container to validateSize or validates itself at the next enterframe if it has no parent container.	MeasurableControl
		isMouseOver(event:MouseEvent):Boolean Utility function to check if a mouseEvent happened while the mouse was over the displayObject	MeasurableControl
		measure():void Measure is called during the validateSize if the needsmeasurement flag is set.	UIControl
		onTrackSkinClick(event:MouseEvent):void	Slider
		position(x:Number, y:Number):UIControl	UIControl
		queueValidateDisplayList(event:PyroEvent = null):void This function is called if the framework determines that dimensions of the control have changed.	MeasurableControl
		removeBackgroundPainter():void	UIControl
		removeChild(d:DisplayObject):DisplayObject	UIControl
		resizeHandler():void	MeasurableControl
		setRange(min:Number, max:Number):Slider Utility function for setting the range of the Slider that returns reference to the slider instance itself for method chaining purposes.	Slider
		setValue(v:Number):Slider Utility function for setting the value of the slider and returning reference to the instance itself for chaining purposes.	Slider
		size(w:, h:):UIControl Convinience function for setting width and height in one call.	UIControl
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void	Slider
		validateDisplayList(event:Event = null):void validateDisplayList is called as a response to invalidateDisplayList.	MeasurableControl
		validateSize():void	Slider
		widthForMeasurement():Number When measure is called, it uses the widthForMeasurement and heightForMeasurement to calculate the sizes for percent-dimension based children	UIControl

	Method	Defined by
		calculateMeasuredHeight():void Calculates the measuredHeight property.	MeasurableControl
		calculateMeasuredWidth():void Calculates the measuredWidth property.	MeasurableControl
		createChildren():void This is where the new children should be created and then added to the displaylist.	MeasurableControl
		disableEvent(event:Event):void	MeasurableControl
		dispatchDragStart(event:MouseEvent):void	UIControl
		dispatchUpdateComplete():void Dispatches the UpdateComplete event	MeasurableControl
		doChildBasedValidation():void While UIControls can be sized based on the dimensions of the parent container, if the explicit or percent dimension values are not specified, the UIControl can look at its children's dimensions and base its sizing off them.	UIControl
		doQueuedValidateSize(event:Event):void doQueueValidateSize is executed by the top level UIControl.	MeasurableControl
		handlePreDragMouseDown(event:Event):void This function is called if the UIControl instance is drag enabled and the user clicks the mouse down.	UIControl
		invalidateDisplayList():void	MeasurableControl
		onAddedToParent(event:Event):void The event listener executed when this component has been added to the parent.	MeasurableControl
		onSkinnedControlResize(event:Event):void Event handler for when the UIControl is applied as a Skin and the control it is skinning is resized.	UIControl

Property detail

boundsRect

property

protected var boundsRect:Rectangle

_direction

property

protected var _direction:String

direction

property

direction:String [read-only]Implementation
public function get direction():String

_isThumbPressed

property

protected var _isThumbPressed:Boolean = false

isThumbPressed

property

isThumbPressed:Boolean [read-only]

Returns a boolean value indicating whether the thumb button is currently pressed or not

Implementation
public function get isThumbPressed():Boolean

maximum

property

maximum:Number [read-write]

Returns the maximum value for the slider

Implementation
public function get maximum():Number
public function set maximum(value:Number):void

minimum

property

minimum:Number [read-write]

Returns the minimum value for the slider

Implementation
public function get minimum():Number
public function set minimum(value:Number):void

_minThumbHeight

property

protected var _minThumbHeight:Number = 50

minThumbHeight

property

minThumbHeight:Number [write-only]Implementation
public function set minThumbHeight(value:Number):void

skin

property

skin:ISkin [write-only]Implementation
public function set skin(value:ISkin):void

_thumbButton

property

protected var _thumbButton:Button

thumbButton

property

thumbButton:Button  [read-write]Implementation
    public function get thumbButton():Button
    public function set thumbButton(value:Button):void

_thumbButtonHeight

property

protected var _thumbButtonHeight:Number = 20

thumbButtonHeight

property

thumbButtonHeight:Number  [read-write]Implementation
    public function get thumbButtonHeight():Number
    public function set thumbButtonHeight(value:Number):void

_thumbButtonWidth

property

protected var _thumbButtonWidth:Number = 20

thumbButtonWidth

property

thumbButtonWidth:Number  [read-write]Implementation
    public function get thumbButtonWidth():Number
    public function set thumbButtonWidth(value:Number):void

thumbButtonX

property

protected var thumbButtonX:Number = 0

thumbButtonY

property

protected var thumbButtonY:Number = 0

_thumbSkin

property

protected var _thumbSkin:ISkin

thumbSkin

property

thumbSkin:ISkin [write-only]Implementation
public function set thumbSkin(value:ISkin):void

_trackSkin

property

protected var _trackSkin:DisplayObject

trackSkin

property

trackSkin:DisplayObject [write-only]Implementation
public function set trackSkin(value:DisplayObject):void

value

property

value:Number  [read-write]Implementation
    public function get value():Number
    public function set value(value:Number):void

Constructor detail

Slider

()

constructor

public function Slider(direction:String)Parameters

direction:String

Method detail

dispatchScrollEvent

()

method

public function dispatchScrollEvent():void

initialize

()

method

public override function initialize():void

onTrackSkinClick

()

method

public function onTrackSkinClick(event:MouseEvent):voidParameters

event:MouseEvent

setRange

()

method

public function setRange(min:Number, max:Number):Slider

Utility function for setting the range of the Slider that returns reference to the slider instance itself for method chaining purposes.

Parameters

	`min:Number`

	`max:Number`

Returns

Slider

setValue

()

method

public function setValue(v:Number):Slider

Utility function for setting the value of the slider and returning reference to the instance itself for chaining purposes.

Parameters

v:Number

Returns

Slider

updateDisplayList

()

method

public override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):voidParameters

	`unscaledWidth:Number`

	`unscaledHeight:Number`

validateSize

()

method

public override function validateSize():void

Event detail

change

event

Event object type: org.openPyro.controls.events.SliderEvent

thumbDrag

event

Event object type: org.openPyro.controls.events.SliderEvent

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class Slider	Properties \| Methods \| Events

Package	org.openPyro.controls
Class	public class Slider
Inheritance	Slider UIControl MeasurableControl flash.display.Sprite

	Event		Summary	Defined by
		change		Slider
		dragDrop		UIControl
		initialize		MeasurableControl
		preInitialize		MeasurableControl
		propertyChange		MeasurableControl
		resize		MeasurableControl
		sizeChanged		MeasurableControl
		sizeInvalidated		MeasurableControl
		sizeValidated		MeasurableControl
		thumbDrag		Slider
		updateComplete		MeasurableControl