Packagecom.ghostwire.ui.controls
Classpublic class uiScrollBar
InheritanceuiScrollBar Inheritance uiStepper Inheritance uiComponent Inheritance flash.display.Sprite
SubclassesuiVScrollBar

The uiScrollBar component is used to implement horizontal scrolling. The component consists of a slider track with a thumb and arrow buttons on opposite ends of the track. The user can modify the value of the component by dragging the thumb or by pressing on the arrow buttons or on the slider track.

You cannot change the orientation of a uiScrollBar instance - it is always horizontal. If you need a vertical scrollbar, use the uiVScrollBar class.

The value of a uiScrollBar moves from lower to higher values as the thumb moves from left-to-right (ie the minimum is at the left, maximum is at the right).

"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 "ScrollBar" and the asset(s) used are:

 ScrollBarDown.png
 ScrollBarUp.png
 ScrollBarTrack.png
 ScrollBarTrackThumb.png
 

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

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

See also

com.ghostwire.ui.controls.uiVScrollBar
com.ghostwire.ui.data.uiRange


Public Properties
 PropertyDefined by
 InheritedactionOnMouseOver : Boolean
Indicates whether value changes should occur once the mouse is over the stepper button instead of only when the mouse is pressed down on the stepper button.
uiStepper
 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
 InheriteddisableOnMinMax : Boolean
Indicates whether the stepper buttons should be individually disabled when the value is at maximum/minimum.
uiStepper
 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 left-hand-side button increments (inverted set to true) or decrements (inverted set to false) the value.
uiStepper
 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
  minThumbSize : uint
Indicates the minimum size of the slider thumb.
uiScrollBar
 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 stepper.
uiStepper
 InheritedrepeatDelay : uint
Indicates the number of milliseconds to wait after a button is pressed down before the value is changed.
uiStepper
 InheritedrepeatInterval : uint
Indicates how often the value will change while a button is being pressed down.
uiStepper
 InheritedrepeatSteps : int
Indicates the number of step value changes before the increment/decrement starts using page value instead.
uiStepper
 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
 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
  
uiScrollBar(range:uiRange = null)
Constructor - creates a new uiScrollBar instance.
uiScrollBar
 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.uiStepper
 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
Property detail
minThumbSizeproperty
minThumbSize:uint  [read-write]

Indicates the minimum size of the slider thumb. Normally, the size of the thumb reflects the percentage of the content that is currently viewable. The thumb size will therefore grow or shrink depending on the size of the content and the viewable area. This property indicates the lower limit for the thumb size.

If you set the value to zero, the thumb size will be the same as the original size of the skin for the thumb and will not change.

The default value is 8.

Implementation
    public function get minThumbSize():uint
    public function set minThumbSize(value:uint):void
Constructor detail
uiScrollBar()constructor
public function uiScrollBar(range:uiRange = null)

Constructor - creates a new uiScrollBar instance.

Parameters
range:uiRange (default = null)