Package | com.ghostwire.ui.controls |
Class | public class uiScrollBar |
Inheritance | uiScrollBar ![]() ![]() ![]() |
Subclasses | uiVScrollBar |
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
Property | Defined by | ||
---|---|---|---|
![]() | actionOnMouseOver : 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 | |
![]() | alignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
| uiComponent | |
![]() | alignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
| uiComponent | |
![]() | background : Object
Indicates the style of the background for this component.
| uiComponent | |
![]() | container : uiComponent
Indicates the
uiComponent instance that contains this instance. | uiComponent | |
![]() | depth : int
Indicates how deep the component is in the containment hierarchy.
| uiComponent | |
![]() | desiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
| uiComponent | |
![]() | desiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
| uiComponent | |
![]() | disableOnMinMax : Boolean
Indicates whether the stepper buttons should be individually disabled when the value is at
maximum/minimum.
| uiStepper | |
![]() | enabled : Boolean
Indicates whether the component is enabled for user interaction.
| uiComponent | |
![]() | fillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
horizontal space.
| uiComponent | |
![]() | fillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
vertical space.
| uiComponent | |
![]() | focusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus
rectangle.
| uiComponent | |
![]() | focusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it
is in focus.
| uiComponent | |
![]() | height : Number
Indicates the current
height of the component. | uiComponent | |
![]() | inverted : Boolean
Indicates whether the left-hand-side button increments (
inverted set to
true ) or decrements (inverted set to false ) the value. | uiStepper | |
![]() | margin : Object
Indicates the thickness of the space surrounding the component.
| uiComponent | |
![]() | maxHeight : int
Indicates the upper limit for
height . | uiComponent | |
![]() | maxWidth : int
Indicates the upper limit for
width . | uiComponent | |
![]() | minHeight : int
Indicates the lower limit for
height . | uiComponent | |
minThumbSize : uint
Indicates the minimum size of the slider thumb.
| uiScrollBar | ||
![]() | minWidth : int
Indicates the lower limit for
width . | uiComponent | |
![]() | padding : 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 | |
![]() | range : uiRange
Indicates the
uiRange object used to determine the bounds of this stepper. | uiStepper | |
![]() | repeatDelay : uint
Indicates the number of milliseconds to wait after a button is pressed down before the value is
changed.
| uiStepper | |
![]() | repeatInterval : uint
Indicates how often the value will change while a button is being pressed down.
| uiStepper | |
![]() | repeatSteps : int
Indicates the number of
step value changes before the increment/decrement starts using
page value instead. | uiStepper | |
![]() | skin : String
Indicates the name of the skin to use for this component instance.
| uiComponent | |
![]() | stretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this
component.
| uiComponent | |
![]() | textStyle : String
Indicates the style to use for
uiText instances contained in this component. | uiComponent | |
![]() | toolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers
over this control.
| uiComponent | |
![]() | uiskin : uiBitmapImage
Returns the
uiBitmapImage rendered as the skin - for advanced users only. | uiComponent | |
![]() | visible : Boolean
Indicates whether or not the component is visible within its container.
| uiComponent | |
![]() | width : Number
Indicates the current
width of the component. | uiComponent |
Method | Defined by | ||
---|---|---|---|
uiScrollBar(range:uiRange = null)
Constructor - creates a new
uiScrollBar instance. | uiScrollBar | ||
![]() |
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
| uiComponent | |
![]() |
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
| uiComponent | |
![]() |
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
| uiComponent | |
![]() |
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 | |
![]() |
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified
width and height . | uiComponent | |
![]() |
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
| uiComponent | |
![]() |
validateNow():void
Validates and render the component instance, and any component instances with
depth higher than itself in the validation queue, immediately. | uiComponent |
minThumbSize | property |
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
.
public function get minThumbSize():uint
public function set minThumbSize(value:uint):void
uiScrollBar | () | constructor |
public function uiScrollBar(range:uiRange = null)
Constructor - creates a new uiScrollBar
instance.
range:uiRange (default = null )
|