Package | mx.preloaders |
Class | public class DownloadProgressBar |
Inheritance | DownloadProgressBar flash.display.Sprite |
Implements | IPreloaderDisplay |
The download progress bar displays information about two different phases of the application: the download phase and the initialization phase.
In the <mx:Application>
tag, 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 DownloadProgressBar class. Do not implement a download progress bar as an MXML component because it loads too slowly.
See also
Property | Defined by | ||
---|---|---|---|
backgroundAlpha : Number
Alpha level of the SWF file or image defined by
the
backgroundImage property, or the color defined by
the backgroundColor property. | DownloadProgressBar | ||
backgroundColor : uint
Background color of a download progress bar.
| DownloadProgressBar | ||
backgroundImage : Object
The background image of the application,
which is passed in by the preloader.
| DownloadProgressBar | ||
backgroundSize : String
Scales the image specified by
backgroundImage
to different percentage sizes. | DownloadProgressBar | ||
initializingLabel : String [static]
The string to display as the label while in the initializing phase.
| DownloadProgressBar | ||
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.
| DownloadProgressBar | ||
stageHeight : Number
The height of the stage,
which is passed in by the Preloader class.
| DownloadProgressBar | ||
stageWidth : Number
The width of the stage,
which is passed in by the Preloader class.
| DownloadProgressBar | ||
visible : Boolean
Specifies whether the download progress bar is visible.
| DownloadProgressBar |
Property | Defined by | ||
---|---|---|---|
barFrameRect : RoundedRectangle
[read-only]
The dimensions of the progress bar border.
| DownloadProgressBar | ||
barRect : RoundedRectangle
[read-only]
The dimensions of the progress bar.
| DownloadProgressBar | ||
borderRect : RoundedRectangle
[read-only]
The dimensions of the border of the display.
| DownloadProgressBar | ||
downloadingLabel : String
The string to display as the label while in the downloading phase.
| DownloadProgressBar | ||
DOWNLOAD_PERCENTAGE : uint = 60
The percentage of the progress bar that the downloading phase
fills when the SWF file is fully downloaded.
| DownloadProgressBar | ||
label : String
Text to display when the progress bar is active.
| DownloadProgressBar | ||
labelFormat : TextFormat [read-only]
The TextFormat object of the TextField component of the label.
| DownloadProgressBar | ||
labelRect : Rectangle [read-only]
The dimensions of the TextField component for the label.
| DownloadProgressBar | ||
MINIMUM_DISPLAY_TIME : uint = 0
The minimum number of milliseconds
that the display should appear visible.
| DownloadProgressBar | ||
percentFormat : TextFormat [read-only]
The TextFormat of the TextField component for displaying the percent.
| DownloadProgressBar | ||
percentRect : Rectangle [read-only]
The dimensions of the TextField component for displaying the percent.
| DownloadProgressBar | ||
showLabel : Boolean
Controls whether to display the label,
true ,
or not, false . | DownloadProgressBar | ||
showPercentage : Boolean
Controls whether to display the percentage,
true ,
or not, false . | DownloadProgressBar |
Method | Defined by | ||
---|---|---|---|
Constructor.
| DownloadProgressBar | ||
initialize():void
Called by the Preloader after the download progress bar
has been added as a child of the Preloader.
| DownloadProgressBar |
Method | Defined by | ||
---|---|---|---|
center(width:Number, height:Number):void
Centers the download progress bar based on the passed in dimensions.
| DownloadProgressBar | ||
completeHandler(event:Event):void
Event listener for the
Event.COMPLETE event. | DownloadProgressBar | ||
createChildren():void
Creates the subcomponents of the display.
| DownloadProgressBar | ||
getPercentLoaded(loaded:Number, total:Number):Number
Returns the percentage value of the application loaded.
| DownloadProgressBar | ||
initProgressHandler(event:Event):void
Event listener for the
FlexEvent.INIT_PROGRESS event. | DownloadProgressBar | ||
progressHandler(event:ProgressEvent):void
Event listener for the
ProgressEvent.PROGRESS event. | DownloadProgressBar | ||
rslCompleteHandler(event:RSLEvent):void
Event listener for the
RSLEvent.RSL_COMPLETE event. | DownloadProgressBar | ||
rslErrorHandler(event:RSLEvent):void
Event listener for the
RSLEvent.RSL_ERROR event. | DownloadProgressBar | ||
rslProgressHandler(event:RSLEvent):void
Event listener for the
RSLEvent.RSL_PROGRESS event. | DownloadProgressBar | ||
setProgress(completed:Number, total:Number):void
Updates the display of the download progress bar
with the current download information.
| DownloadProgressBar | ||
showDisplayForDownloading(elapsedTime:int, event:ProgressEvent):Boolean
Defines the algorithm for determining whether to show
the download progress bar while in the download phase.
| DownloadProgressBar | ||
showDisplayForInit(elapsedTime:int, count:int):Boolean
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.
| DownloadProgressBar |
backgroundAlpha | property |
backgroundAlpha:Number
[read-write]
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.
You can specify either a backgroundColor
or a backgroundImage
, but not both.
The default value is 1.0
.
public function get backgroundAlpha():Number
public function set backgroundAlpha(value:Number):void
backgroundColor | property |
backgroundColor:uint
[read-write]
Background color of a download progress bar.
You can have either a backgroundColor
or a
backgroundImage
, but not both.
public function get backgroundColor():uint
public function set backgroundColor(value:uint):void
backgroundImage | property |
backgroundImage:Object
[read-write]
The background image of the application,
which is passed in by the preloader.
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
.
public function get backgroundImage():Object
public function set backgroundImage(value:Object):void
backgroundSize | property |
backgroundSize:String
[read-write]
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"
.
public function get backgroundSize():String
public function set backgroundSize(value:String):void
barFrameRect | property |
barFrameRect:RoundedRectangle
[read-only]The dimensions of the progress bar border. This is a read-only property which you must override if you need to change it.
Implementation protected function get barFrameRect():RoundedRectangle
barRect | property |
barRect:RoundedRectangle
[read-only]The dimensions of the progress bar. This is a read-only property which you must override if you need to change it.
Implementation protected function get barRect():RoundedRectangle
borderRect | property |
borderRect:RoundedRectangle
[read-only]The dimensions of the border of the display. This is a read-only property which you must override if you need to change it.
Implementation protected function get borderRect():RoundedRectangle
downloadingLabel | property |
downloadingLabel:String
[read-write]The string to display as the label while in the downloading phase.
The default value is "Loading"
.
protected function get downloadingLabel():String
protected function set downloadingLabel(value:String):void
DOWNLOAD_PERCENTAGE | property |
protected var DOWNLOAD_PERCENTAGE:uint = 60
The percentage of the progress bar that the downloading phase fills when the SWF file is fully downloaded. The rest of the progress bar is filled during the initializing phase. This should be a value from 0 to 100.
The default value is 60
.
initializingLabel | property |
initializingLabel:String
[read-write]The string to display as the label while in the initializing phase.
The default value is "Initializing"
.
public static function get initializingLabel():String
public function set initializingLabel(value:String):void
label | property |
label:String
[read-write]Text to display when the progress bar is active. The Preloader class sets this value before displaying the progress bar. Implementing this property in a subclass is optional.
The default value is ""
.
protected function get label():String
protected function set label(value:String):void
labelFormat | property |
labelFormat:TextFormat
[read-only]The TextFormat object of the TextField component of the label. This is a read-only property which you must override if you need to change it.
Implementation protected function get labelFormat():TextFormat
labelRect | property |
labelRect:Rectangle
[read-only]The dimensions of the TextField component for the label. This is a read-only property which you must override if you need to change it.
Implementation protected function get labelRect():Rectangle
MINIMUM_DISPLAY_TIME | property |
protected var MINIMUM_DISPLAY_TIME:uint = 0
The minimum number of milliseconds
that the display should appear visible.
If the downloading and initialization of the application
takes less time than this value, then Flex pauses for this amount
of time before dispatching the complete
event.
The default value is 0
.
percentFormat | property |
percentFormat:TextFormat
[read-only]The TextFormat of the TextField component for displaying the percent. This is a read-only property which you must override if you need to change it.
Implementation protected function get percentFormat():TextFormat
percentRect | property |
percentRect:Rectangle
[read-only]The dimensions of the TextField component for displaying the percent. This is a read-only property which you must override if you need to change it.
Implementation protected function get percentRect():Rectangle
preloader | property |
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.
Implementation public function set preloader(value:Sprite):void
showLabel | property |
showLabel:Boolean
[read-write]
Controls whether to display the label, true
,
or not, false
.
The default value is true
.
protected function get showLabel():Boolean
protected function set showLabel(value:Boolean):void
showPercentage | property |
showPercentage:Boolean
[read-write]
Controls whether to display the percentage, true
,
or not, false
.
The default value is true
.
protected function get showPercentage():Boolean
protected function set showPercentage(value:Boolean):void
stageHeight | property |
stageHeight:Number
[read-write]The height of the stage, which is passed in by the Preloader class.
Implementation public function get stageHeight():Number
public function set stageHeight(value:Number):void
stageWidth | property |
stageWidth:Number
[read-write]The width of the stage, which is passed in by the Preloader class.
Implementation public function get stageWidth():Number
public function set stageWidth(value:Number):void
visible | property |
visible:Boolean
[read-write]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 DownloadProgressBar 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
.
public function get visible():Boolean
public function set visible(value:Boolean):void
DownloadProgressBar | () | constructor |
public function DownloadProgressBar()
Constructor.
center | () | method |
protected function center(width:Number, height:Number):void
Centers the download progress bar based on the passed in dimensions.
Parameterswidth:Number — The width of the area in which to center the download progress bar.
|
|
height:Number — The height of the area in which to center the download progress bar.
|
completeHandler | () | method |
protected function completeHandler(event:Event):void
Event listener for the Event.COMPLETE
event.
The default implementation does nothing.
event:Event — The event object.
|
createChildren | () | method |
protected function createChildren():void
Creates the subcomponents of the display.
getPercentLoaded | () | method |
protected function getPercentLoaded(loaded:Number, total:Number):Number
Returns the percentage value of the application loaded.
Parametersloaded:Number — Number of bytes of the application SWF file
that have been downloaded.
|
|
total:Number — Size of the application SWF file in bytes.
|
Number — The percentage value of the loaded application.
|
initialize | () | method |
public function initialize():void
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
Event listener for the FlexEvent.INIT_PROGRESS
event.
This implementation updates the progress bar
each time the event is dispatched, and changes the text of the label.
event:Event — The event object.
|
progressHandler | () | method |
protected function progressHandler(event:ProgressEvent):void
Event listener for the ProgressEvent.PROGRESS
event.
This implementation updates the progress bar
with the percentage of bytes downloaded.
event:ProgressEvent — The event object.
|
rslCompleteHandler | () | method |
protected function rslCompleteHandler(event:RSLEvent):void
Event listener for the RSLEvent.RSL_COMPLETE
event.
event:RSLEvent — The event object.
|
rslErrorHandler | () | method |
protected function rslErrorHandler(event:RSLEvent):void
Event listener for the RSLEvent.RSL_ERROR
event.
This event listner handles any errors detected when downloading an RSL.
event:RSLEvent — The event object.
|
rslProgressHandler | () | method |
protected function rslProgressHandler(event:RSLEvent):void
Event listener for the RSLEvent.RSL_PROGRESS
event.
The default implementation does nothing.
event:RSLEvent — The event object.
|
setProgress | () | method |
protected function setProgress(completed:Number, total:Number):void
Updates the display of the download progress bar with the current download information. A typical implementation divides the loaded value by the total value and displays a percentage. If you do not implement this method, you should create a progress bar that displays an animation to indicate to the user that a download is occurring.
The setProgress()
method is only called
if the application is being downloaded from a remote server
and the application is not in the browser cache.
completed:Number — Number of bytes of the application SWF file
that have been downloaded.
|
|
total:Number — Size of the application SWF file in bytes.
|
showDisplayForDownloading | () | method |
protected function showDisplayForDownloading(elapsedTime:int, event:ProgressEvent):Boolean
Defines the algorithm for determining whether to show the download progress bar while in the download phase.
ParameterselapsedTime: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
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.
ParameterselapsedTime: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.
|