| Package | feathers.controls |
| Class | public class SimpleScrollBar |
| Inheritance | SimpleScrollBar  FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object |
| Implements | IScrollBar |
ScrollBar component.
See also
| Property | Defined By | ||
|---|---|---|---|
 | alpha : Number The opacity of the object. | DisplayObject | |
| base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject | |
| blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject | |
| bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject | |
| clampToRange : Boolean = false
Determines if the value should be clamped to the range between the
minimum and maximum. | SimpleScrollBar | ||
| clipRect : Rectangle [override] | FeathersControl | |
| customThumbName : String
A name to add to the scroll bar's thumb sub-component. | SimpleScrollBar | ||
| defaultTextEditorFactory : Function [static]
A function used by all UI controls that support text editor to
create an ITextEditor instance. | FeathersControl | |
| defaultTextRendererFactory : Function [static]
A function used by all UI controls that support text renderers to
create an ITextRenderer instance. | FeathersControl | |
| direction : String
Determines if the scroll bar's thumb can be dragged horizontally or
vertically. | SimpleScrollBar | ||
| filter : FragmentFilter The filter that is attached to the display object. | DisplayObject | |
| focusManager : IFocusManager
The current focus manager for this component. | FeathersControl | |
| hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject | |
| height : Number [override]
The height of the component, in pixels. | FeathersControl | |
| includeInLayout : Boolean
Determines if the ILayout should use this object or ignore it. | FeathersControl | |
| isEnabled : Boolean
Indicates whether the control is interactive or not. | FeathersControl | |
| isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite | |
| isFocusEnabled : Boolean
Determines if this component can receive focus. | FeathersControl | |
| isInitialized : Boolean [read-only]
Determines if the component has been initialized yet. | FeathersControl | |
| isQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list. | FeathersControl | |
| layoutData : ILayoutData
Extra parameters associated with this display object that will be
used by the layout algorithm. | FeathersControl | |
| liveDragging : Boolean = true
Determines if the scroll bar dispatches the Event.CHANGE
event every time the thumb moves, or only once it stops moving. | SimpleScrollBar | ||
| maxHeight : Number
The maximum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| maximum : Number
The maximum value of the scroll bar. | SimpleScrollBar | ||
| maxWidth : Number
The maximum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minHeight : Number
The minimum recommended height to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| minimum : Number
The minimum value of the scroll bar. | SimpleScrollBar | ||
| minTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's
height is smaller than this value, it will be expanded. | FeathersControl | |
| minTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's
width is smaller than this value, it will be expanded. | FeathersControl | |
| minWidth : Number
The minimum recommended width to be used for self-measurement and,
optionally, by any code that is resizing this component. | FeathersControl | |
| name : String [override]
The concatenated nameList, with each name separated by
spaces. | FeathersControl | |
| nameList : TokenList [read-only]
Contains a list of all "names" assigned to this control. | FeathersControl | |
| nextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed. | FeathersControl | |
| numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer | |
| padding : Number
Quickly sets all padding properties to the same value. | SimpleScrollBar | ||
| paddingBottom : Number
The minimum space, in pixels, below the thumb. | SimpleScrollBar | ||
| paddingLeft : Number
The minimum space, in pixels, to the left of the thumb. | SimpleScrollBar | ||
| paddingRight : Number
The minimum space, in pixels, to the right of the thumb. | SimpleScrollBar | ||
| paddingTop : Number
The minimum space, in pixels, above the thumb. | SimpleScrollBar | ||
| page : Number
The amount the scroll bar value must change to get from one "page" to
the next. | SimpleScrollBar | ||
| parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject | |
| pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject | |
| repeatDelay : Number
The time, in seconds, before actions are repeated. | SimpleScrollBar | ||
| root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject | |
| rotation : Number The rotation of the object in radians. | DisplayObject | |
| scaleX : Number The horizontal scale factor. | DisplayObject | |
| scaleY : Number The vertical scale factor. | DisplayObject | |
| skewX : Number The horizontal skew angle in radians. | DisplayObject | |
| skewY : Number The vertical skew angle in radians. | DisplayObject | |
| stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected
to the stage. | DisplayObject | |
| step : Number
The amount the scroll bar value must change to increment or
decrement. | SimpleScrollBar | ||
| thumbFactory : Function
A function used to generate the scroll bar's thumb sub-component. | SimpleScrollBar | ||
| thumbProperties : Object
A set of key/value pairs to be passed down to the scroll bar's thumb
sub-component. | SimpleScrollBar | ||
| touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject | |
| transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject | |
| useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject | |
| value : Number
The current value of the scroll bar. | SimpleScrollBar | ||
| visible : Boolean The visibility of the object. | DisplayObject | |
| width : Number [override]
The width of the component, in pixels. | FeathersControl | |
| x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject | |
| Property | Defined By | ||
|---|---|---|---|
| actualHeight : Number = 0
The final height value that should be used for layout. | FeathersControl | |
| actualWidth : Number = 0
The final width value that should be used for layout. | FeathersControl | |
| explicitHeight : Number = NaN
The height value explicitly set by calling the height setter or
setSize(). | FeathersControl | |
| explicitWidth : Number = NaN
The width value explicitly set by calling the width setter or
setSize(). | FeathersControl | |
| thumb : Button
The thumb sub-component. | SimpleScrollBar | ||
| thumbName : String = feathers-simple-scroll-bar-thumb
The value added to the nameList of the thumb. | SimpleScrollBar | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | SimpleScrollBar | ||
| Adds a child to the container. | DisplayObjectContainer | |
| Adds a child to the container at a certain index. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| alignPivot(hAlign:String = center, vAlign:String = center):void Moves the pivot point to a certain position within the local coordinate system
of the object. | DisplayObject | |
| broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer | |
| broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer | |
| contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| dispose():void [override] Disposes the resources of all children. | Sprite | |
| flatten():void Optimizes the sprite for optimal rendering performance. | Sprite | |
| getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another
coordinate system. | Sprite | |
| getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer | |
| getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer | |
| getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer | |
| getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle Returns the bounds of the container's clipRect in the given coordinate space, or
null if the sprite doens't have a clipRect. | Sprite | |
| getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system
to another. | DisplayObject | |
| globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject | |
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
| hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject [override] Returns the object that is found topmost beneath a point in local coordinates, or nil if
the test fails. | Sprite | |
| invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending. | FeathersControl | |
| isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not. | FeathersControl | |
| localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject | |
| Removes a child from the container. | DisplayObjectContainer | |
| removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer | |
| removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer | |
| removeEventListener(type:String, listener:Function):void [override] | DisplayObject | |
| removeEventListeners(type:String = null):void [override] | DisplayObject | |
| removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject | |
| render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite | |
| setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer | |
| setSize(width:Number, height:Number):void
Sets both the width and the height of the control. | FeathersControl | |
| sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function
of the Vector class). | DisplayObjectContainer | |
| Swaps the indexes of two children. | DisplayObjectContainer | |
| swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer | |
| unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite | |
| validate():void
Immediately validates the control, which triggers a redraw, if one
is pending. | FeathersControl | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an object is added to a parent. | DisplayObject | ||
| Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject | ||
| Dispatched when the user starts dragging the scroll bar's thumb. | SimpleScrollBar | |||
| Dispatched when the scroll bar's value changes. | SimpleScrollBar | |||
| Dispatched when the user stops dragging the scroll bar's thumb. | SimpleScrollBar | |||
| Dispatched once every frame on every object that is connected to the stage. | DisplayObject | ||
| Dispatched on all children when the object is flattened. | Sprite | ||
| Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl | ||
| Dispatched when a key on the keyboard is pressed. | DisplayObject | ||
| Dispatched when a key on the keyboard is released. | DisplayObject | ||
| Dispatched when an object is removed from its parent. | DisplayObject | ||
| Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject | ||
| Dispatched when the width or height of the control changes. | FeathersControl | ||
| Dispatched when an object is touched. | DisplayObject | ||
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_CHILD_NAME_THUMB : String = feathers-simple-scroll-bar-thumb [static]
The default value added to the nameList of the thumb. | SimpleScrollBar | ||
| DIRECTION_HORIZONTAL : String = horizontal [static]
The scroll bar's thumb may be dragged horizontally (on the x-axis). | SimpleScrollBar | ||
| DIRECTION_VERTICAL : String = vertical [static]
The scroll bar's thumb may be dragged vertically (on the y-axis). | SimpleScrollBar | ||
| INVALIDATION_FLAG_ALL : String = all [static]
Flag to indicate that everything is invalid and should be redrawn. | FeathersControl | |
| INVALIDATION_FLAG_DATA : String = data [static]
Invalidation flag to indicate that the primary data displayed by the
UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_LAYOUT : String = layout [static]
Invalidation flag to indicate that the layout of the UI control has
changed. | FeathersControl | |
| INVALIDATION_FLAG_SCROLL : String = scroll [static]
Invalidation flag to indicate that the scroll position of the UI
control has changed. | FeathersControl | |
| INVALIDATION_FLAG_SELECTED : String = selected [static]
Invalidation flag to indicate that the selection of the UI control
has changed. | FeathersControl | |
| INVALIDATION_FLAG_SIZE : String = size [static]
Invalidation flag to indicate that the dimensions of the UI control
have changed. | FeathersControl | |
| INVALIDATION_FLAG_SKIN : String = skin [static]
Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl | |
| INVALIDATION_FLAG_STATE : String = state [static]
Invalidation flag to indicate that the state has changed. | FeathersControl | |
| INVALIDATION_FLAG_STYLES : String = styles [static]
Invalidation flag to indicate that the styles or visual appearance of
the UI control has changed. | FeathersControl | |
| clampToRange | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var clampToRange:Boolean = falseDetermines if the value should be clamped to the range between the minimum and maximum. If false and the value is outside of the range, the thumb will shrink as if the range were increasing.
| customThumbName | property |
customThumbName:StringA name to add to the scroll bar's thumb sub-component. Typically used by a theme to provide different skins to different scroll bars.
public function get customThumbName():String public function set customThumbName(value:String):voidSee also
| direction | property |
direction:StringDetermines if the scroll bar's thumb can be dragged horizontally or vertically. When this value changes, the scroll bar's width and height values do not change automatically.
public function get direction():String public function set direction(value:String):void| liveDragging | property |
public var liveDragging:Boolean = true
Determines if the scroll bar dispatches the Event.CHANGE
event every time the thumb moves, or only once it stops moving.
| maximum | property |
maximum:NumberThe maximum value of the scroll bar.
public function get maximum():Number public function set maximum(value:Number):void| minimum | property |
minimum:NumberThe minimum value of the scroll bar.
public function get minimum():Number public function set minimum(value:Number):void| padding | property |
padding:Number
Quickly sets all padding properties to the same value. The
padding getter always returns the value of
paddingTop, but the other padding values may be
different.
public function get padding():Number public function set padding(value:Number):void| paddingBottom | property |
paddingBottom:NumberThe minimum space, in pixels, below the thumb.
public function get paddingBottom():Number public function set paddingBottom(value:Number):void| paddingLeft | property |
paddingLeft:NumberThe minimum space, in pixels, to the left of the thumb.
public function get paddingLeft():Number public function set paddingLeft(value:Number):void| paddingRight | property |
paddingRight:NumberThe minimum space, in pixels, to the right of the thumb.
public function get paddingRight():Number public function set paddingRight(value:Number):void| paddingTop | property |
paddingTop:NumberThe minimum space, in pixels, above the thumb.
public function get paddingTop():Number public function set paddingTop(value:Number):void| page | property |
page:NumberThe amount the scroll bar value must change to get from one "page" to the next.
public function get page():Number public function set page(value:Number):void| repeatDelay | property |
repeatDelay:NumberThe time, in seconds, before actions are repeated. The first repeat happens after a delay that is five times longer than the following repeats.
public function get repeatDelay():Number public function set repeatDelay(value:Number):void| step | property |
step:NumberThe amount the scroll bar value must change to increment or decrement.
public function get step():Number public function set step(value:Number):void| thumb | property |
protected var thumb:ButtonThe thumb sub-component.
| thumbFactory | property |
thumbFactory:Function
A function used to generate the scroll bar's thumb sub-component.
This can be used to change properties on the thumb when it is first
created. For instance, if you are skinning Feathers components
without a theme, you might use thumbFactory to set
skins and text styles on the thumb.
The function should have the following signature:
function():Button
public function get thumbFactory():Function public function set thumbFactory(value:Function):voidSee also
| thumbName | property |
protected var thumbName:String = feathers-simple-scroll-bar-thumb
The value added to the nameList of the thumb.
| thumbProperties | property |
thumbProperties:Object
A set of key/value pairs to be passed down to the scroll bar's thumb
sub-component. The thumb is a feathers.controls.Button
instance.
If the subcomponent has its own subcomponents, their properties
can be set too, using attribute @ notation. For example,
to set the skin on the thumb of a SimpleScrollBar
which is in a Scroller which is in a List,
you can use the following syntax:
list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);
public function get thumbProperties():Object public function set thumbProperties(value:Object):voidSee also
| value | property |
value:NumberThe current value of the scroll bar.
public function get value():Number public function set value(value:Number):void| SimpleScrollBar | () | Constructor |
public function SimpleScrollBar()Constructor.
| beginInteraction | Event |
starling.events.Eventfeathers.events.FeathersEventType.BEGIN_INTERACTIONDispatched when the user starts dragging the scroll bar's thumb.
TheFeathersEventType.BEGIN_INTERACTION event type is
used by many UI controls where a drag or other interaction happens
over time. An example is a Slider control where the
user touches the thumb to begin dragging.
| change | Event |
starling.events.Eventstarling.events.Event.CHANGEDispatched when the scroll bar's value changes.
An event type to be utilized in custom events. Not used by Starling right now.| endInteraction | Event |
starling.events.Eventfeathers.events.FeathersEventType.END_INTERACTIONDispatched when the user stops dragging the scroll bar's thumb.
TheFeathersEventType.END_INTERACTION event type is
used by many UI controls where a drag or other interaction happens
over time. An example is a Slider control where the
user stops touching the thumb after dragging.
| DEFAULT_CHILD_NAME_THUMB | Constant |
public static const DEFAULT_CHILD_NAME_THUMB:String = feathers-simple-scroll-bar-thumb
The default value added to the nameList of the thumb.
| DIRECTION_HORIZONTAL | Constant |
public static const DIRECTION_HORIZONTAL:String = horizontalThe scroll bar's thumb may be dragged horizontally (on the x-axis).
| DIRECTION_VERTICAL | Constant |
public static const DIRECTION_VERTICAL:String = verticalThe scroll bar's thumb may be dragged vertically (on the y-axis).