fl.controls

# ScrollBar - AS3 Flash

Package | fl.controls
Class | public class ScrollBar
Inheritance | ScrollBar UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Subclasses | UIScrollBar

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

The ScrollBar component provides the end user with a way to control the portion of data that is displayed when there is too much data to fit in the display area. The scroll bar consists of four parts: two arrow buttons, a track, and a thumb. The position of the thumb and display of the buttons depends on the current state of the scroll bar. The scroll bar uses four parameters to calculate its display state: a minimum range value; a maximum range value; a current position that must be within the range values; and a viewport size that must be equal to or less than the range and represents the number of items in the range that can be displayed at the same time.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance. | InteractiveObject
|  | accessibilityProperties : AccessibilityProperties The current accessibility options for this display object. | DisplayObject
|  | alpha : Number Indicates the alpha transparency value of the object specified. | DisplayObject
|  | blendMode : String A value from the BlendMode class that specifies which blend mode to use. | DisplayObject
|  | blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background. | DisplayObject
|  | buttonMode : Boolean Specifies the button mode of this sprite. | Sprite
|  | cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object. | DisplayObject
|  | cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. | DisplayObject
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | contextMenu : NativeMenu Specifies the context menu associated with this object. | InteractiveObject
|  | direction : String Gets or sets a value that indicates whether the scroll bar scrolls horizontally or vertically. | ScrollBar
|  | doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events. | InteractiveObject
|  | dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped. | Sprite
|  | enabled : Boolean [override] Gets or sets a Boolean value that indicates whether the scroll bar is enabled. | ScrollBar
|  | filters : Array An indexed array that contains each filter object currently associated with the display object. | DisplayObject
|  | focusEnabled : Boolean Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it. | UIComponent
|  | focusManager : IFocusManager Gets or sets the FocusManager that controls focus for this component and its peers. | UIComponent
|  | focusRect : Object Specifies whether this object displays a focus rectangle. | InteractiveObject
|  | graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur. | Sprite
|  | height : Number [override] Gets or sets the height of the component, in pixels. | ScrollBar
|  | hitArea : Sprite Designates another sprite to serve as the hit area for a sprite. | Sprite
|  | lineScrollSize : Number Gets or sets a value that represents the increment by which to scroll the page when the scroll bar track is pressed. | ScrollBar
|  | loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs. | DisplayObject
|  | mask : DisplayObject The calling display object is masked by the specified mask object. | DisplayObject
|  | maxScrollPosition : Number Gets or sets a number that represents the maximum scroll position. | ScrollBar
|  | metaData : Object Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject
|  | minScrollPosition : Number Gets or sets a number that represents the minimum scroll position. | ScrollBar
|  | mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer
|  | mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject
|  | mouseFocusEnabled : Boolean Gets or sets a value that indicates whether the component can receive focus after the user clicks it. | UIComponent
|  | mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject
|  | mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject
|  | name : String Indicates the instance name of the DisplayObject. | DisplayObject
|  | needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus. | InteractiveObject
|  | numChildren : int [read-only] Returns the number of children of this object. | DisplayObjectContainer
|  | opaqueBackground : Object Specifies whether the display object is opaque with a certain background color. | DisplayObject
|  | pageScrollSize : Number Gets or sets a value that represents the increment by which the page is scrolled when the scroll bar track is pressed. | ScrollBar
|  | pageSize : Number Gets or sets the number of lines that a page contains. | ScrollBar
|  | parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject
|  | root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject
|  | rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject
|  | rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject
|  | rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject
|  | rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject
|  | scale9Grid : Rectangle The current scaling grid that is in effect. | DisplayObject
|  | scaleX : Number [override] Multiplies the current width of the component by a scale factor. | UIComponent
|  | scaleY : Number [override] Multiplies the current height of the component by a scale factor. | UIComponent
|  | scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject
|  | scrollPosition : Number Gets or sets the current scroll position and updates the position of the thumb. | ScrollBar
|  | scrollRect : Rectangle The scroll rectangle bounds of the display object. | DisplayObject
|  | softKeyboard : String Controls the appearance of the soft keyboard. | InteractiveObject
|  | softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject
|  | soundTransform : flash.media:SoundTransform Controls sound within this sprite. | Sprite
|  | stage : Stage [read-only] The Stage of the display object. | DisplayObject
|  | tabChildren : Boolean Determines whether the children of the object are tab enabled. | DisplayObjectContainer
|  | tabEnabled : Boolean Specifies whether this object is in the tab order. | InteractiveObject
|  | tabIndex : int Specifies the tab ordering of objects in a SWF file. | InteractiveObject
|  | textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer
|  | transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject
|  | useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true. | Sprite
|  | visible : Boolean [override] Gets or sets a value that indicates whether the current component instance is visible. | UIComponent
|  | width : Number [override] Gets or sets the width of the component, in pixels. | ScrollBar
|  | x : Number [override] Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container. | UIComponent
|  | y : Number [override] Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container. | UIComponent
|  | z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container. | DisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ScrollBar() Creates a new ScrollBar component instance. | ScrollBar
|  | addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer
|  | addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point. | DisplayObjectContainer
|  | clearStyle(style:String):void Deletes a style property from this component instance. | UIComponent
|  | contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself. | DisplayObjectContainer
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | drawFocus(focused:Boolean):void Shows or hides the focus indicator on this component. | UIComponent
|  | drawNow():void Initiates an immediate draw operation, without invalidating everything as invalidateNow does. | UIComponent
|  | getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. | DisplayObject
|  | getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index. | DisplayObjectContainer
|  | getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name. | DisplayObjectContainer
|  | getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance. | DisplayObjectContainer
|  | getFocus():InteractiveObject Retrieves the object that currently has focus. | UIComponent
|  | getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer
|  | getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes. | DisplayObject
|  | getStyle(style:String):Object Retrieves a style property that is set in the style lookup chain of the component. | UIComponent
|  | getStyleDefinition():Object [static] Retrieves the default style map for the current component. | ScrollBar
|  | globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates. | DisplayObject
|  | globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates. | DisplayObject
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object. | DisplayObject
|  | hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters. | DisplayObject
|  | invalidate(property:String, callLater:Boolean = true):void Marks a property as invalid and redraws the component on the next frame unless otherwise specified. | UIComponent
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject
|  | localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates. | DisplayObject
|  | mergeStyles(... list):Object [static] Merges the styles from multiple classes into one object. | UIComponent
|  | move(x:Number, y:Number):void Moves the component to the specified position within its parent. | UIComponent
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer
|  | removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer. | DisplayObjectContainer
|  | removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | requestSoftKeyboard():Boolean Raises a virtual keyboard. | InteractiveObject
|  | setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container. | DisplayObjectContainer
|  | setFocus():void Sets the focus to this component. | UIComponent
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void Sets the range and viewport size of the ScrollBar component. | ScrollBar
|  | setSize(width:Number, height:Number):void [override] Sets the component to the specified width and height. | ScrollBar
|  | setStyle(style:String, value:Object):void Sets a style property on this component instance. | UIComponent
|  | startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite. | Sprite
|  | startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device. | Sprite
|  | stopAllMovieClips():void Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer
|  | stopDrag():void Ends the startDrag() method. | Sprite
|  | stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite
|  | swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer
|  | swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list. | DisplayObjectContainer
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | validateNow():void Validates and updates the properties and layout of this object, redrawing it if necessary. | UIComponent
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | getStyleValue(name:String):Object Returns the specified style for a component, considering all styles set on the global level, component level and instance level. | UIComponent

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | added | Dispatched when a display object is added to the display list. | DisplayObject
|  | addedToStage | Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject
|  | clear | Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject
|  | click | Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | contextMenu | Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject
|  | copy | Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject
|  | cut | Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | doubleClick | Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject
|  | enterFrame | [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject
|  | exitFrame | [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject
|  | focusIn | Dispatched after a display object gains focus. | InteractiveObject
|  | focusOut | Dispatched after a display object loses focus. | InteractiveObject
|  | frameConstructed | [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject
|  | gestureDirectionalTap | Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well. | InteractiveObject
|  | gestureLongPress | Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gesturePan | Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureRotate | Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureSwipe | Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureTap | Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureZoom | Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | hide | Dispatched after the component visibility changes from visible to invisible. | UIComponent
|  | imeStartComposition | This event is dispatched to any client app that supports inline input with an IME | InteractiveObject
|  | keyDown | Dispatched when the user presses a key. | InteractiveObject
|  | keyFocusChange | Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject
|  | keyUp | Dispatched when the user releases a key. | InteractiveObject
|  | middleClick | Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | middleMouseDown | Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject
|  | middleMouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseDown | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseFocusChange | Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject
|  | mouseMove | Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject
|  | mouseOut | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject
|  | mouseOver | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject
|  | mouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseWheel | Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject
|  | move | Dispatched after the component is moved. | UIComponent
|  | nativeDragComplete | Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject
|  | nativeDragDrop | Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject
|  | nativeDragEnter | Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject
|  | nativeDragExit | Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject
|  | nativeDragOver | Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject
|  | nativeDragStart | Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject
|  | nativeDragUpdate | Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject
|  | paste | Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject
|  | proximityBegin | Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject
|  | proximityEnd | Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject
|  | proximityMove | Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject
|  | proximityOut | Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityOver | Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityRollOut | Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityRollOver | Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject
|  | releaseOutside | Dispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance. | InteractiveObject
|  | removed | Dispatched when a display object is about to be removed from the display list. | DisplayObject
|  | removedFromStage | Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject
|  | render | [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject
|  | resize | Dispatched after the component is resized. | UIComponent
|  | rightClick | Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | rightMouseDown | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | rightMouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | rollOut | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject
|  | rollOver | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject
|  | scroll | Dispatched when the ScrollBar instance's scrollPosition property changes. | ScrollBar
|  | selectAll | Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject
|  | show | Dispatched after the component visibility changes from invisible to visible. | UIComponent
|  | softKeyboardActivate | Dispatched immediately after the soft keyboard is raised. | InteractiveObject
|  | softKeyboardActivating | Dispatched immediately before the soft keyboard is raised. | InteractiveObject
|  | softKeyboardDeactivate | Dispatched immediately after the soft keyboard is lowered. | InteractiveObject
|  | tabChildrenChange | Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject
|  | tabEnabledChange | Dispatched when the object's tabEnabled flag changes. | InteractiveObject
|  | tabIndexChange | Dispatched when the value of the object's tabIndex property changes. | InteractiveObject
|  | textInput | Dispatched when a user enters one or more characters of text. | InteractiveObject
|  | touchBegin | Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchEnd | Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchMove | Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject
|  | touchOut | Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchOver | Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchRollOut | Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchRollOver | Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchTap | Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject

Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles
Click for more information on styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | disabledTextFormat | Type: flash.text.TextFormat Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The TextFormat object to use to render the component label when the button is disabled. | UIComponent
|  | downArrowDisabledSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the down arrow button of the scroll bar when it is disabled. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal scroll bars) or width (for vertical scroll bars) as the track. The default value is`ScrollArrowDown_disabledSkin`. | ScrollBar
|  | downArrowDownSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the down arrow button of the scroll bar when you click the arrow button. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal scroll bars) or width (for vertical scroll bars) as the track. The default value is`ScrollArrowDown_downSkin`. | ScrollBar
|  | downArrowOverSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the down arrow button of the scroll bar when the mouse pointer is over the arrow button. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal scroll bars) or width (for vertical scroll bars) as the track. The default value is`ScrollArrowDown_overSkin`. | ScrollBar
|  | downArrowUpSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the down arrow button of the scroll bar. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal scroll bars) or width (for vertical scroll bars) as the track. The default value is`ScrollArrowDown_upSkin`. | ScrollBar
|  | focusRectPadding | Type: Number Format: Length Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels. | UIComponent
|  | focusRectSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The skin to be used to display focus indicators. | UIComponent
|  | repeatDelay | Type: Number Format: Time Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The number of milliseconds to wait after the `buttonDown` event is first dispatched before sending a second `buttonDown` event. The default value is`500`. | ScrollBar
|  | repeatInterval | Type: Number Format: Time Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The interval, in milliseconds, between `buttonDown` events that are dispatched after the delay that is specified by the `repeatDelay` style. The default value is`35`. | ScrollBar
|  | textFormat | Type: flash.text.TextFormat Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The TextFormat object to use to render the component label. | UIComponent
|  | thumbDisabledSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The skin that is used to indicate the disabled state of the thumb. The default value is`ScrollThumb_disabledSkin`. | ScrollBar
|  | thumbDownSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the thumb of the scroll bar when you click the thumb. The default value is`ScrollThumb_downSkin`. | ScrollBar
|  | thumbIcon | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the icon for the thumb of the scroll bar. The default value is`ScrollBar_thumbIcon`. | ScrollBar
|  | thumbOverSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the thumb of the scroll bar when the mouse pointer is over the thumb. The default value is`ScrollThumb_overSkin`. | ScrollBar
|  | thumbUpSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin used for the thumb of the scroll bar. The default value is`ScrollThumb_upSkin`. | ScrollBar
|  | trackDisabledSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The skin that is used to indicate a disabled track. The default value is`ScrollTrack_Skin`. | ScrollBar
|  | trackDownSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The skin that is used to indicate the down state of a disabled skin. The default value is`ScrollTrack_Skin`. | ScrollBar
|  | trackOverSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The skin that is used to indicate the mouseover state for the scroll track. The default value is`ScrollTrack_Skin`. | ScrollBar
|  | trackUpSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 The skin used to indicate the mouse up state for the scroll track. The default value is`ScrollTrack_Skin`. | ScrollBar
|  | upArrowDisabledSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the up arrow button of the scroll bar when it is disabled. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal scroll bars) or width (for vertical scroll bars) as the track. The default value is`ScrollArrowUp_disabledSkin`. | ScrollBar
|  | upArrowDownSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the up arrow button of the scroll bar when you click the arrow button. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal scroll bars) or width (for vertical scroll bars) as the track. The default value is`ScrollArrowUp_downSkin`. | ScrollBar
|  | upArrowOverSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the up arrow button of the scroll bar when the mouse pointer is over the arrow button. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal scroll bars) or width (for vertical scroll bars) as the track. The default value is`ScrollArrowUp_overSkin`. | ScrollBar
|  | upArrowUpSkin | Type: Class Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Name of the class to use as the skin for the up arrow button of the scroll bar. If you change the skin, either graphically or programmatically, you should ensure that the new skin is the same height (for horizontal scroll bars) or width (for vertical scroll bars) as the track. The default value is`ScrollArrowUp_upSkin`. | ScrollBar

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | version : String = "3.0.3.1" The version number of the components. | UIComponent

Property Detail

### direction

property

`direction:String`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets a value that indicates whether the scroll bar scrolls horizontally or vertically. Valid values are `ScrollBarDirection.HORIZONTAL` and `ScrollBarDirection.VERTICAL`.

The default value is `ScrollBarDirection.VERTICAL.`

Implementation
`public function get direction():String`
`public function set direction(value:String):void`

Related API Elements

ScrollBarDirection

### enabled

property

`enabled:Boolean`[override]

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets a Boolean value that indicates whether the scroll bar is enabled. A value of `true` indicates that the scroll bar is enabled; a value of `false` indicates that it is not.

The default value is `true.`

Implementation
`override public function get enabled():Boolean`
`override public function set enabled(value:Boolean):void`

### height

property

`height:Number`[override]

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets the height of the component, in pixels.

Setting this property causes a `resize` event to be dispatched. See the `resize` event for detailed information about when it is dispatched.

If the `scaleY` property of the component is not 1.0, the height of the component that is obtained from its internal coordinates will not match the height value from the parent coordinates. For example, a component that is 100 pixels in height and has a `scaleY` of 2 has a value of 100 pixels in the parent, but internally stores a value indicating that it is 50 pixels in height.

Implementation
`override public function get height():Number`
`override public function set height(value:Number):void`

Related API Elements

setSize()
width

### lineScrollSize

property

`lineScrollSize:Number`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets a value that represents the increment by which to scroll the page when the scroll bar track is pressed. The `pageScrollSize` is measured in increments between the `minScrollPosition` and the `maxScrollPosition` values. If this value is set to 0, the value of the `pageSize` property is used.

The default value is `0.`

Implementation
`public function get lineScrollSize():Number`
`public function set lineScrollSize(value:Number):void`

Related API Elements

maxScrollPosition
minScrollPosition

### maxScrollPosition

property

`maxScrollPosition:Number`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets a number that represents the maximum scroll position. The `scrollPosition` value represents a relative position between the `minScrollPosition` and the `maxScrollPosition` values. This property is set by the component that contains the scroll bar, and is the maximum value. Usually this property describes the number of pixels between the bottom of the component and the bottom of the content, but this property is often set to a different value to change the behavior of the scrolling. For example, the TextArea component sets this property to the `maxScrollH` value of the text field, so that the scroll bar scrolls appropriately by line of text.

The default value is `0.`

Implementation
`public function get maxScrollPosition():Number`
`public function set maxScrollPosition(value:Number):void`

Related API Elements

setScrollProperties()
minScrollPosition
scrollPosition

### minScrollPosition

property

`minScrollPosition:Number`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets a number that represents the minimum scroll position. The `scrollPosition` value represents a relative position between the `minScrollPosition` and the `maxScrollPosition` values. This property is set by the component that contains the scroll bar, and is usually zero.

The default value is `0.`

Implementation
`public function get minScrollPosition():Number`
`public function set minScrollPosition(value:Number):void`

Related API Elements

setScrollProperties()
maxScrollPosition
scrollPosition

### pageScrollSize

property

`pageScrollSize:Number`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets a value that represents the increment by which the page is scrolled when the scroll bar track is pressed. The `pageScrollSize` value is measured in increments between the `minScrollPosition` and the `maxScrollPosition` values. If this value is set to 0, the value of the `pageSize` property is used.

The default value is `0.`

Implementation
`public function get pageScrollSize():Number`
`public function set pageScrollSize(value:Number):void`

Related API Elements

maxScrollPosition
minScrollPosition

### pageSize

property

`pageSize:Number`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets the number of lines that a page contains. The `lineScrollSize` is measured in increments between the `minScrollPosition` and the `maxScrollPosition`. If this property is 0, the scroll bar will not scroll.

The default value is `10.`

Implementation
`public function get pageSize():Number`
`public function set pageSize(value:Number):void`

Related API Elements

maxScrollPosition
minScrollPosition
setScrollProperties()

### scrollPosition

property

`scrollPosition:Number`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets the current scroll position and updates the position of the thumb. The `scrollPosition` value represents a relative position between the `minScrollPosition` and `maxScrollPosition` values.

The default value is `0.`

Implementation
`public function get scrollPosition():Number`
`public function set scrollPosition(value:Number):void`

Related API Elements

setScrollProperties()
minScrollPosition
maxScrollPosition

### width

property

`width:Number`[override]

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Gets or sets the width of the component, in pixels.

Setting this property causes a `resize` event to be dispatched. See the `resize` event for detailed information about when it is dispatched.

If the `scaleX` property of the component is not 1.0, the width of the component that is obtained from its internal coordinates will not match the width value from the parent coordinates. For example, a component that is 100 pixels in width and has a `scaleX` of 2 has a value of 100 pixels in the parent, but internally stores a value indicating that it is 50 pixels wide.

Implementation
`override public function get width():Number`
`override public function set width(value:Number):void`

Related API Elements

height
setSize()
Constructor Detail

### ScrollBar

()
Constructor

`public function ScrollBar()`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Creates a new ScrollBar component instance.

Method Detail

### getStyleDefinition

()
method

`public static function getStyleDefinition():Object`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Retrieves the default style map for the current component. The style map contains the type that is appropriate for the component, depending on the style that the component uses. For example, the `disabledTextFormat` style contains a value of `null` or a TextFormat object. You can use these styles and call `setStyle()` on the current component. The following code overrides the default `disabledTextFormat` style on the specified component:

Copy

    componentInstance.setStyle("disabledTextFormat", new TextFormat());

Returns

| `Object` — Default styles object.

Related API Elements

fl.core.UIComponent.getStyle()
fl.core.UIComponent.setStyle()
fl.managers.StyleManager

### setScrollProperties

()
method

`public function setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Sets the range and viewport size of the ScrollBar component. The ScrollBar component updates the state of the arrow buttons and size of the scroll thumb accordingly. All of the scroll properties are relative to the scale of the `minScrollPosition` and the `maxScrollPosition`. Each number between the maximum and minumum values represents one scroll position.

Parameters

| `pageSize:Number` — Size of one page. Determines the size of the thumb, and the increment by which the scroll bar moves when the arrows are clicked.
| `minScrollPosition:Number` — Bottom of the scrolling range.
| `maxScrollPosition:Number` — Top of the scrolling range.
| `pageScrollSize:Number` (default = `0`)`` — Increment to move when a track is pressed, in pixels.

Related API Elements

maxScrollPosition
minScrollPosition
pageScrollSize
pageSize

### setSize

()
method

`override public function setSize(width:Number, height:Number):void`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Sets the component to the specified width and height.

Parameters

| `width:Number` — The width of the component, in pixels.
| `height:Number` — The height of the component, in pixels.

Related API Elements

height
width
Event Detail

### scroll

Event

Event Object Type: `fl.events.ScrollEvent`
property ScrollEvent.type = `fl.events.ScrollEvent.SCROLL`

Language Version: | ActionScript 3.0

Product Version: | Flash CS3

Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0

Dispatched when the ScrollBar instance's `scrollPosition` property changes.

Defines the value of the `type` property of a `scroll` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the event object with an event listener.
`delta` | `1`; a value that indicates how much scrolling was done.
`direction` | `vertical`; the direction of the ScrollBar.
`position` | `0`; the position of the Scrollbar thumb after it was moved.
`target` | The object that dispatched the event. The target is not always the object listening for the event. Use the `currentTarget` property to access the object that is listening for the event.

Related API Elements

scrollPosition

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00