Packagecom.ghostwire.ui.controls
Classpublic class uiVSlider
InheritanceuiVSlider Inheritance uiSlider Inheritance uiComponent Inheritance flash.display.Sprite

The uiVSlider component allows the user to select a value within a range by sliding a thumb along a vertical track.

You cannot change the orientation of a uiVSlider instance - it is always vertical. If you need a horizontal slider, use the uiSlider class.

The value of a uiVSlider moves from lower to higher values as the thumb moves from bottom-to-top (ie the minimum is at the bottom, maximum is at the top). You may set the inverted property to true if you wish to reverse the positions of the minimum and maximum values.

"padding" Property
Always 0 - attempting to set this property will throw an error.

"range" Property
You need to access the values represented by the component via the range property. For example, range.value, range.minimum, range.maximum, etc.

"skin" Property
The default value is "VSlider" and the asset(s) used are:

 VSlider.png
 VSliderThumb.png
 

Events
The slider itself will not dispatch events related to the range values. Listen for events that are dispatched by the uiRange object instead.

Key Navigation
While the component has focus, the user may use the END key to move the thumb to the range.maximum position and the HOME key to the range.minimum position. The arrow keys can also be used to increment/decrement the value. Holding down the SHIFT key uses the range.page value for increment/decrement.

~ This class is available in Aspire UI Components Lite Edition ~

See also

com.ghostwire.ui.controls.uiSlider
com.ghostwire.ui.data.uiRange


Public Properties
 PropertyDefined by
 InheritedalignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
uiComponent
 InheritedalignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
uiComponent
 Inheritedbackground : Object
Indicates the style of the background for this component.
uiComponent
 Inheritedcontainer : uiComponent
Indicates the uiComponent instance that contains this instance.
uiComponent
 Inheriteddepth : int
Indicates how deep the component is in the containment hierarchy.
uiComponent
 InheriteddesiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
uiComponent
 InheriteddesiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
uiComponent
 Inheritedenabled : Boolean
Indicates whether the component is enabled for user interaction.
uiComponent
 InheritedfillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated horizontal space.
uiComponent
 InheritedfillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated vertical space.
uiComponent
 InheritedfocusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus rectangle.
uiComponent
 InheritedfocusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it is in focus.
uiComponent
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
 Inheritedinverted : Boolean
Indicates whether the positions of the maximum and minimum values are reversed.
uiSlider
 Inheritedmargin : Object
Indicates the thickness of the space surrounding the component.
uiComponent
 InheritedmaxHeight : int
Indicates the upper limit for height.
uiComponent
 InheritedmaxWidth : int
Indicates the upper limit for width.
uiComponent
 InheritedminHeight : int
Indicates the lower limit for height.
uiComponent
 InheritedminWidth : int
Indicates the lower limit for width.
uiComponent
 Inheritedpadding : Object
Indicates the thickness of the interior space from the edge of the component to the content area, which is where child components, if any, are contained.
uiComponent
 Inheritedrange : uiRange
Indicates the uiRange object used to determine the bounds of this slider.
uiSlider
 InheritedrepeatDelay : uint = 500
Indicates the number of milliseconds to wait after the slider track is first pressed down before the thumb is automatically moved repeatedly over time towards the pressed location.
uiSlider
 InheritedrepeatInterval : uint = 35
Indicates how often the thumb movement will repeat while the track is being pressed down.
uiSlider
 Inheritedskin : String
Indicates the name of the skin to use for this component instance.
uiComponent
 Inheritedstretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this component.
uiComponent
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
 InheritedtoolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers over this control.
uiComponent
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
 InheritedupdateDelay : int
Indicates the time in milliseconds that must pass where no slider thumb motion occurs before the value property is updated.
uiSlider
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
Public Methods
 MethodDefined by
  
uiVSlider(range:uiRange = null)
Constructor - creates a new uiVSlider instance.
uiVSlider
 Inherited
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
uiComponent
 Inherited
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
uiComponent
 Inherited
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
uiComponent
 Inherited
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its tabEnabled property set to true, otherwise this method will fail silently.
uiComponent
 Inherited
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified width and height.
uiComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
uiComponent
 Inherited
validateNow():void
Validates and render the component instance, and any component instances with depth higher than itself in the validation queue, immediately.
uiComponent
Events
 EventSummaryDefined by
 Inherited Dispatched when the range.value has changed.uiSlider
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
 Inherited Dispatched when the component's position within its parent container has changed via calling the move() method.uiComponent
 Inherited Dispatched when the component's size has changed via calling the setSize() method.uiComponent
 Inherited Dispatched when the component's visible property is changed from false to true via calling the setVisible() method.uiComponent
Constructor detail
uiVSlider()constructor
public function uiVSlider(range:uiRange = null)

Constructor - creates a new uiVSlider instance.

Parameters
range:uiRange (default = null) — [Optional] A uiRange object specifying the initial value and limits of the slider