(Preview)
| Package | mx.preloaders |
| Class | public class SparkDownloadProgressBar |
| Inheritance | SparkDownloadProgressBar  Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IPreloaderDisplay |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The download progress bar displays information about two different phases of the application: the download phase and the initialization phase.
In the Application container, use the
the preloader property to specify the name of your subclass.
You can implement a custom download progress bar component by creating a subclass of the SparkDownloadProgressBar class. Do not implement a download progress bar as an MXML component because it loads too slowly.
More examples
Related API Elements
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 | |
| backgroundAlpha : Number
Alpha level of the SWF file or image defined by
the backgroundImage property, or the color defined by
the backgroundColor property. | SparkDownloadProgressBar | ||
| backgroundColor : uint
Background color of a download progress bar. | SparkDownloadProgressBar | ||
| backgroundImage : Object
The background image of the application,
which is passed in by the preloader. | SparkDownloadProgressBar | ||
| backgroundSize : String
Scales the image specified by backgroundImage
to different percentage sizes. | SparkDownloadProgressBar | ||
| 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 | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| 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
Indicates the height of the display object, in pixels. | DisplayObject | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| 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 | |
| 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 | |
| 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 | |
| preloader : Sprite [write-only]
The Preloader class passes in a reference to itself to the display class
so that it can listen for events from the preloader. | SparkDownloadProgressBar | ||
| 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
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | DisplayObject | |
| scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | DisplayObject | |
| 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 | |
| stageHeight : Number
The height of the stage,
which is passed in by the Preloader class. | SparkDownloadProgressBar | ||
| stageWidth : Number
The width of the stage,
which is passed in by the Preloader class. | SparkDownloadProgressBar | ||
| 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]
Specifies whether the download progress bar is visible. | SparkDownloadProgressBar | ||
| width : Number
Indicates the width of the display object, in pixels. | DisplayObject | |
| x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | |
| y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | DisplayObject | |
| z : Number
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | DisplayObject | |
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| initProgressTotal : uint = 6
The total number of validation events you expect to get
in the initializing phase. | SparkDownloadProgressBar | ||
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | SparkDownloadProgressBar | ||
|
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 | |
|
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 | |
|
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 | |
|
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 | |
|
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 | |
Called by the Preloader after the download progress bar
has been added as a child of the Preloader. | SparkDownloadProgressBar | ||
|
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 | |
|
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 availability of a dynamic property for loop operations. | Object | |
|
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 | |
|
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
| Method | Defined By | ||
|---|---|---|---|
Event listener for the Event.COMPLETE event. | SparkDownloadProgressBar | ||
Creates the subcomponents of the display. | SparkDownloadProgressBar | ||
Event listener for the FlexEvent.INIT_COMPLETE event. | SparkDownloadProgressBar | ||
Event listener for the FlexEvent.INIT_PROGRESS event. | SparkDownloadProgressBar | ||
Event listener for the ProgressEvent.PROGRESS event. | SparkDownloadProgressBar | ||
Event listener for the RSLEvent.RSL_COMPLETE event. | SparkDownloadProgressBar | ||
Event listener for the RSLEvent.RSL_ERROR event. | SparkDownloadProgressBar | ||
Event listener for the RSLEvent.RSL_PROGRESS event. | SparkDownloadProgressBar | ||
Updates the outer portion of the download progress bar to
indicate download progress. | SparkDownloadProgressBar | ||
Updates the inner portion of the download progress bar to
indicate initialization progress. | SparkDownloadProgressBar | ||
Defines the algorithm for determining whether to show
the download progress bar while in the download phase. | SparkDownloadProgressBar | ||
Defines the algorithm for determining whether to show the download progress bar
while in the initialization phase, assuming that the display
is not currently visible. | SparkDownloadProgressBar | ||
Property Detail
backgroundAlpha | property |
backgroundAlpha:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Alpha level of the SWF file or image defined by
the backgroundImage property, or the color defined by
the backgroundColor property.
Valid values range from 0 to 1.0.
Override this property to set your own value in a custom class.
You can specify either a backgroundColor
or a backgroundImage, but not both.
The default value is 1.0.
Implementation
public function get backgroundAlpha():Number public function set backgroundAlpha(value:Number):voidbackgroundColor | property |
backgroundColor:uint| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Background color of a download progress bar. Override this property to set your own value in a custom class.
You can specify either a backgroundColor
or a backgroundImage, but not both.
Implementation
public function get backgroundColor():uint public function set backgroundColor(value:uint):voidbackgroundImage | property |
backgroundImage:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The background image of the application, which is passed in by the preloader. Override this property to set your own value in a custom class.
You can specify either a backgroundColor
or a backgroundImage, but not both.
A value of null means "not set".
If this style and the backgroundColor style are undefined,
the component has a transparent background.
The preloader does not display embedded images. You can only use images loaded at runtime.
The default value is null.
Implementation
public function get backgroundImage():Object public function set backgroundImage(value:Object):voidbackgroundSize | property |
backgroundSize:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Scales the image specified by backgroundImage
to different percentage sizes.
A value of "100%" stretches the image
to fit the entire component.
To specify a percentage value, you must include the percent sign (%).
A value of "auto", maintains
the original size of the image.
The default value is "auto".
Implementation
public function get backgroundSize():String public function set backgroundSize(value:String):voidinitProgressTotal | property |
protected var initProgressTotal:uint = 6| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The total number of validation events you expect to get in the initializing phase. This should be an integer greater or equal to 4 (and note that if it is greater than 4 you might have an inefficiency in your initialization code)
The default value is 6.
preloader | property |
preloader:Sprite [write-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The Preloader class passes in a reference to itself to the display class so that it can listen for events from the preloader.
Implementation
public function set preloader(value:Sprite):voidstageHeight | property |
stageWidth | property |
visible | property |
visible:Boolean[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the download progress bar is visible.
When the Preloader control determines that the progress bar should be displayed,
it sets this value to true. When the Preloader control determines that
the progress bar should be hidden, it sets the value to false.
A subclass of the SparkDownloadProgressBar class should never modify this property. Instead, you can override the setter method to recognize when the Preloader control modifies it, and perform any necessary actions.
The default value is false.
Implementation
override public function get visible():Boolean override public function set visible(value:Boolean):voidConstructor Detail
SparkDownloadProgressBar | () | Constructor |
public function SparkDownloadProgressBar()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
Method Detail
completeHandler | () | method |
createChildren | () | method |
protected function createChildren():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Creates the subcomponents of the display.
initCompleteHandler | () | method |
protected function initCompleteHandler(event:Event):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Event listener for the FlexEvent.INIT_COMPLETE event.
This implementation dispatches a Event.COMPLETE event.
Parameters
event:Event — The event object
|
initialize | () | method |
public function initialize():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Called by the Preloader after the download progress bar has been added as a child of the Preloader. This should be the starting point for configuring your download progress bar.
initProgressHandler | () | method |
protected function initProgressHandler(event:Event):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Event listener for the FlexEvent.INIT_PROGRESS event.
This implementation updates the progress bar
each time the event is dispatched.
Parameters
event:Event — The event object.
|
progressHandler | () | method |
protected function progressHandler(event:ProgressEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Event listener for the ProgressEvent.PROGRESS event.
This implementation updates the progress bar
with the percentage of bytes downloaded.
Parameters
event:ProgressEvent — The event object.
|
rslCompleteHandler | () | method |
rslErrorHandler | () | method |
protected function rslErrorHandler(event:RSLEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Event listener for the RSLEvent.RSL_ERROR event.
This event listner handles any errors detected when downloading an RSL.
Parameters
event:RSLEvent — The event object.
|
rslProgressHandler | () | method |
setDownloadProgress | () | method |
protected function setDownloadProgress(completed:Number, total:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Updates the outer portion of the download progress bar to indicate download progress.
Parameters
completed:Number — Number of bytes of the application SWF file
that have been downloaded.
| |
total:Number — Size of the application SWF file in bytes.
|
setInitProgress | () | method |
protected function setInitProgress(completed:Number, total:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Updates the inner portion of the download progress bar to indicate initialization progress.
Parameters
completed:Number — Number of initialization steps that
have been completed
| |
total:Number — Total number of initialization steps
|
showDisplayForDownloading | () | method |
protected function showDisplayForDownloading(elapsedTime:int, event:ProgressEvent):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Defines the algorithm for determining whether to show the download progress bar while in the download phase.
Parameters
elapsedTime:int — Number of milliseconds that have elapsed
since the start of the download phase.
| |
event:ProgressEvent — The ProgressEvent object that contains
the bytesLoaded and bytesTotal properties.
|
Boolean — If the return value is true, then show the
download progress bar.
The default behavior is to show the download progress bar
if more than 700 milliseconds have elapsed
and if Flex has downloaded less than half of the bytes of the SWF file.
|
showDisplayForInit | () | method |
protected function showDisplayForInit(elapsedTime:int, count:int):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Defines the algorithm for determining whether to show the download progress bar while in the initialization phase, assuming that the display is not currently visible.
Parameters
elapsedTime:int — Number of milliseconds that have elapsed
since the start of the download phase.
| |
count:int — number of times that the initProgress event
has been received from the application.
|
Boolean — If true, then show the download progress bar.
|
Wed Nov 21 2018, 06:34 AM -08:00