| Package | fl.containers |
| Class | public class BaseScrollPane |
| Inheritance | BaseScrollPane  UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Subclasses | ScrollPane, SelectableList |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
By default, the BaseScrollPane class is extended by the ScrollPane and SelectableList classes, for all list-based components. This means that any component that uses horizontal or vertical scrolling does not need to implement any scrolling, masking or layout logic, except for behavior that is specific to the component.
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 | |
| 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
Gets or sets a value that indicates whether the component can accept user interaction. | UIComponent | |
| 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. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalLineScrollSize : Number
Gets or sets a value that describes the amount of content to be scrolled,
horizontally, when a scroll arrow is clicked. | BaseScrollPane | ||
| horizontalPageScrollSize : Number
Gets or sets the count of pixels by which to move the scroll thumb
on the horizontal scroll bar when the scroll bar track is pressed. | BaseScrollPane | ||
| horizontalScrollBar : ScrollBar [read-only]
Gets a reference to the horizontal scroll bar. | BaseScrollPane | ||
| horizontalScrollPolicy : String
Gets or sets a value that indicates the state of the horizontal scroll
bar. | BaseScrollPane | ||
| horizontalScrollPosition : Number
Gets or sets a value that describes the horizontal position of the
horizontal scroll bar in the scroll pane, in pixels. | BaseScrollPane | ||
| 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 | |
| maxHorizontalScrollPosition : Number [read-only]
Gets the maximum horizontal scroll position for the current content, in pixels. | BaseScrollPane | ||
| maxVerticalScrollPosition : Number [read-only]
Gets the maximum vertical scroll position for the current content, in pixels. | BaseScrollPane | ||
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| useBitmapScrolling : Boolean
When set to true, the cacheAsBitmap property for the scrolling content is set
to true; when set to false this value is turned off. | BaseScrollPane | ||
| 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 | |
| verticalLineScrollSize : Number
Gets or sets a value that describes how many pixels to scroll vertically when a scroll arrow is clicked. | BaseScrollPane | ||
| verticalPageScrollSize : Number
Gets or sets the count of pixels by which to move the scroll thumb
on the vertical scroll bar when the scroll bar track is pressed. | BaseScrollPane | ||
| verticalScrollBar : ScrollBar [read-only]
Gets a reference to the vertical scroll bar. | BaseScrollPane | ||
| verticalScrollPolicy : String
Gets or sets a value that indicates the state of the vertical scroll
bar. | BaseScrollPane | ||
| verticalScrollPosition : Number
Gets or sets a value that describes the vertical position of the
vertical scroll bar in the scroll pane, in pixels. | BaseScrollPane | ||
| 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. | UIComponent | |
| 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
| Method | Defined By | ||
|---|---|---|---|
Creates a new BaseScrollPane component instance. | BaseScrollPane | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
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 | |
|
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 | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Shows or hides the focus indicator on this component. | UIComponent | |
|
Initiates an immediate draw operation, without invalidating everything as invalidateNow does. | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Retrieves the object that currently has focus. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
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 | |
|
Retrieves a style property that is set in the style lookup
chain of the component. | UIComponent | |
[static]
Retrieves the default style map for the current component. | BaseScrollPane | ||
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
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 | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Marks a property as invalid and redraws the component on the
next frame unless otherwise specified. | UIComponent | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
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 | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
| [static]
Merges the styles from multiple classes into one object. | UIComponent | |
|
Moves the component to the specified position within its parent. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets the component to the specified width and height. | UIComponent | |
|
Sets a style property on this component instance. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Validates and updates the properties and layout of this object, redrawing it
if necessary. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| 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 | ||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| 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 | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| Dispatched after the component visibility changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched after the component is moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| 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 | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| 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 | ||
| 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 | ||
| 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 | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| 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 | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched after the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user scrolls content by using the scroll bars on the component or the wheel on a mouse device. | BaseScrollPane | |||
| 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 | ||
| Dispatched after the component visibility changes from invisible to visible. | UIComponent | ||
| Dispatched immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| 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 | ||
| 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 | ||
| Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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 | ||
| 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
| Style | Description | Defined By | ||
|---|---|---|---|---|
contentPadding | Type: Number Format: Length Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 Padding between the content (the component and scroll bar), and the outside edge of the background, in pixels. The default value is 0. | BaseScrollPane | ||
disabledAlpha | Type: Number Format: Length Language Version: ActionScript 3.0 Product Version: Flash CS3 Runtime Versions: Flash9.0.28.0, AIR 1.0 When the enabled property is set to false,
interaction with the component is prevented and a white overlay is
displayed over the component, dimming the component contents. The
disabledAlpha style specifies the level of transparency
that is applied to this overlay. Valid values range from 0, for an
overlay that is completely transparent, to 1 for an overlay that is opaque.
The default value is 0.5. | BaseScrollPane | ||
| 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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
| 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 | ||
| 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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
skin | 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 as the background of the scroll pane. The default value is ScrollPane_upSkin. | BaseScrollPane | ||
| 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_upSkin. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
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. | BaseScrollPane | ||
Public Constants
Property Detail
horizontalLineScrollSize | property |
horizontalLineScrollSize: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 describes the amount of content to be scrolled, horizontally, when a scroll arrow is clicked. This value is measured in pixels.
The default value is 4.
Implementation
public function get horizontalLineScrollSize():Number public function set horizontalLineScrollSize(value:Number):voidRelated API Elements
horizontalPageScrollSize | property |
horizontalPageScrollSize: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 count of pixels by which to move the scroll thumb on the horizontal scroll bar when the scroll bar track is pressed. When this value is 0, this property retrieves the available width of the component.
The default value is 0.
Implementation
public function get horizontalPageScrollSize():Number public function set horizontalPageScrollSize(value:Number):voidRelated API Elements
horizontalScrollBar | property |
horizontalScrollPolicy | property |
horizontalScrollPolicy: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 the state of the horizontal scroll
bar. A value of ScrollPolicy.ON indicates that the horizontal
scroll bar is always on; a value of ScrollPolicy.OFF indicates
that the horizontal scroll bar is always off; and a value of ScrollPolicy.AUTO
indicates that its state automatically changes. This property is used with
other scrolling properties to set the setScrollProperties() method
of the scroll bar.
The default value is ScrollPolicy.AUTO.
Implementation
public function get horizontalScrollPolicy():String public function set horizontalScrollPolicy(value:String):voidRelated API Elements
horizontalScrollPosition | property |
horizontalScrollPosition: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 describes the horizontal position of the horizontal scroll bar in the scroll pane, in pixels.
The default value is 0.
Implementation
public function get horizontalScrollPosition():Number public function set horizontalScrollPosition(value:Number):voidRelated API Elements
Example ( How to use this example )
The following example creates a ScrollPane component instance that listens for the
scroll event and traces the horizontal and vertical scroll positions:
import fl.events.ScrollEvent;
import fl.containers.ScrollPane;
import fl.controls.ScrollBarDirection;
var myScrollPane:ScrollPane = new ScrollPane();
myScrollPane.source = "http://www.helpexamples.com/flash/images/image1.jpg";
myScrollPane.scrollDrag = true;
myScrollPane.move(10, 10);
myScrollPane.addEventListener(ScrollEvent.SCROLL, scrollHandler);
addChild(myScrollPane);
function scrollHandler(event:ScrollEvent):void {
var sp:ScrollPane = event.target as ScrollPane;
switch (event.direction) {
case ScrollBarDirection.HORIZONTAL:
trace(event.direction + ":", sp.horizontalScrollPosition, "of", sp.maxHorizontalScrollPosition);
break;
case ScrollBarDirection.VERTICAL:
trace(event.direction + ":", sp.verticalScrollPosition, "of", sp.maxVerticalScrollPosition);
break;
}
}
maxHorizontalScrollPosition | property |
maxHorizontalScrollPosition:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Gets the maximum horizontal scroll position for the current content, in pixels.
Implementation
public function get maxHorizontalScrollPosition():NumberRelated API Elements
maxVerticalScrollPosition | property |
maxVerticalScrollPosition:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Gets the maximum vertical scroll position for the current content, in pixels.
Implementation
public function get maxVerticalScrollPosition():NumberRelated API Elements
useBitmapScrolling | property |
useBitmapScrolling:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
When set to true, the cacheAsBitmap property for the scrolling content is set
to true; when set to false this value is turned off.
Note: Setting this property to true increases scrolling performance.
The default value is false.
Implementation
public function get useBitmapScrolling():Boolean public function set useBitmapScrolling(value:Boolean):voidverticalLineScrollSize | property |
verticalLineScrollSize: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 describes how many pixels to scroll vertically when a scroll arrow is clicked.
The default value is 4.
Implementation
public function get verticalLineScrollSize():Number public function set verticalLineScrollSize(value:Number):voidRelated API Elements
verticalPageScrollSize | property |
verticalPageScrollSize: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 count of pixels by which to move the scroll thumb on the vertical scroll bar when the scroll bar track is pressed. When this value is 0, this property retrieves the available height of the component.
The default value is 0.
Implementation
public function get verticalPageScrollSize():Number public function set verticalPageScrollSize(value:Number):voidRelated API Elements
verticalScrollBar | property |
verticalScrollPolicy | property |
verticalScrollPolicy: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 the state of the vertical scroll
bar. A value of ScrollPolicy.ON indicates that the vertical
scroll bar is always on; a value of ScrollPolicy.OFF indicates
that the vertical scroll bar is always off; and a value of ScrollPolicy.AUTO
indicates that its state automatically changes. This property is used with
other scrolling properties to set the setScrollProperties() method
of the scroll bar.
The default value is ScrollPolicy.AUTO.
Implementation
public function get verticalScrollPolicy():String public function set verticalScrollPolicy(value:String):voidRelated API Elements
verticalScrollPosition | property |
verticalScrollPosition: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 describes the vertical position of the vertical scroll bar in the scroll pane, in pixels.
The default value is 0.
Implementation
public function get verticalScrollPosition():Number public function set verticalScrollPosition(value:Number):voidRelated API Elements
Example ( How to use this example )
The following example creates a ScrollPane component instance that listens for the
scroll event and traces the horizontal and vertical scroll positions:
import fl.events.ScrollEvent;
import fl.containers.ScrollPane;
import fl.controls.ScrollBarDirection;
var myScrollPane:ScrollPane = new ScrollPane();
myScrollPane.source = "http://www.helpexamples.com/flash/images/image1.jpg";
myScrollPane.scrollDrag = true;
myScrollPane.move(10, 10);
myScrollPane.addEventListener(ScrollEvent.SCROLL, scrollHandler);
addChild(myScrollPane);
function scrollHandler(event:ScrollEvent):void {
var sp:ScrollPane = event.target as ScrollPane;
switch (event.direction) {
case ScrollBarDirection.HORIZONTAL:
trace(event.direction + ":", sp.horizontalScrollPosition, "of", sp.maxHorizontalScrollPosition);
break;
case ScrollBarDirection.VERTICAL:
trace(event.direction + ":", sp.verticalScrollPosition, "of", sp.maxVerticalScrollPosition);
break;
}
}
Constructor Detail
BaseScrollPane | () | Constructor |
public function BaseScrollPane()| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS3 |
| Runtime Versions: | Flash Player 9.0.28.0, AIR 1.0 |
Creates a new BaseScrollPane 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:
componentInstance.setStyle("disabledTextFormat", new TextFormat());Object — Default styles object.
|
Related API Elements
Example ( How to use this example )
The following example creates a style browser for several component classes:
import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;
var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane", data:BaseScrollPane } );
dp.addItem( { label: "Button", data:Button } );
dp.addItem( { label: "CellRenderer", data:CellRenderer } );
dp.addItem( { label: "CheckBox", data:CheckBox } );
dp.addItem( { label: "ColorPicker", data:ColorPicker } );
dp.addItem( { label: "ComboBox", data:ComboBox } );
dp.addItem( { label: "DataGrid", data:DataGrid } );
dp.addItem( { label: "HeaderRenderer", data:HeaderRenderer } );
dp.addItem( { label: "ImageCell", data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label", data:Label } );
dp.addItem( { label: "List", data:List } );
dp.addItem( { label: "NumericStepper", data:NumericStepper } );
dp.addItem( { label: "ProgressBar", data:ProgressBar } );
dp.addItem( { label: "RadioButton", data:RadioButton } );
dp.addItem( { label: "ScrollPane", data:ScrollPane } );
dp.addItem( { label: "Slider", data:Slider } );
dp.addItem( { label: "TextArea", data:TextArea } );
dp.addItem( { label: "TextInput", data:TextInput } );
dp.addItem( { label: "TileList", data:TileList } );
dp.addItem( { label: "UILoader", data:UILoader } );
dp.addItem( { label: "UIComponent", data:UIComponent } );
var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);
var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);
function showStyleDefinition(e:Event):void {
var componentClass:Class = e.target.selectedItem.data as Class;
var styles:Object = componentClass["getStyleDefinition"].call(this);
trace(styles.toString());
var styleData:DataProvider = new DataProvider();
for(var i:* in styles) {
trace(i + " : " + styles[i]);
styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
}
styleData.sortOn("StyleName");
dg.dataProvider = styleData;
}
Event Detail
scroll | Event |
Event Object Type:
property ScrollEvent.type =
Example ( How to use this example )
fl.events.ScrollEventproperty 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 user scrolls content by using the scroll bars on the component or the wheel on a mouse device.
Defines the value of thetype 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. |
Example ( How to use this example )
The following example listens for the
scroll event
and uses the direction property of the ScrollEvent class to
determine if the content was scrolled horizontally or vertically:
import fl.containers.ScrollPane;
import fl.events.ScrollEvent;
import fl.controls.ScrollBarDirection;
var myScrollPane:ScrollPane = new ScrollPane();
myScrollPane.scrollDrag = true;
myScrollPane.source = "http://www.helpexamples.com/flash/images/image1.jpg";
myScrollPane.addEventListener(ScrollEvent.SCROLL, scrollHandler);
addChild(myScrollPane);
function scrollHandler(event:ScrollEvent):void {
switch (event.direction) {
case ScrollBarDirection.HORIZONTAL:
trace("horizontal scroll", event.position, "of", event.currentTarget.maxHorizontalScrollPosition);
break;
case ScrollBarDirection.VERTICAL:
trace("vertical scroll", event.position, "of", event.currentTarget.maxVerticalScrollPosition);
break;
}
}
Mon Apr 10 2017, 12:28 PM -07:00