mx.preloaders.DownloadProgressBar - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.preloaders
Class	public class DownloadProgressBar
Inheritance	DownloadProgressBar Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements	IPreloaderDisplay

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The DownloadProgressBar class displays download progress. It is used by the Preloader control to provide user feedback while the application is downloading and loading.

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 DownloadProgressBar class. Do not implement a download progress bar as an MXML component because it loads too slowly.

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.	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
		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 Player or Adobe AIR caches an internal bitmap representation of the display object.	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
		initializingLabel : String [static] The string to display as the label while in the initializing phase.	DownloadProgressBar
		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
		mouseChildren : Boolean Determines whether or not the children of the object are mouse enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse messages.	InteractiveObject
		mouseX : Number [read-only] Indicates the x coordinate of the mouse position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		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.	DownloadProgressBar
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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
		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.	DownloadProgressBar
		stageWidth : Number The width of the stage, which is passed in by the Preloader class.	DownloadProgressBar
		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 mouse 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.	DownloadProgressBar
		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
		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
		initProgressTotal : uint = 6 The total number of validation events you expect to get in the initializing phase.	DownloadProgressBar
		label : String Text to display when the progress bar is active.	DownloadProgressBar
		labelFormat : flash.text: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 : flash.text: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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		DownloadProgressBar() Constructor.	DownloadProgressBar
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	DisplayObject
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		initialize():void Called by the Preloader after the download progress bar has been added as a child of the Preloader.	DownloadProgressBar
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.	DisplayObject
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		stopDrag():void Ends the startDrag() method.	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

	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
		initCompleteHandler(event:Event):void Event listener for the FlexEvent.INIT_COMPLETE event.	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

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
cut	Dispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.	InteractiveObject
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().	InteractiveObject
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
paste	Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
selectAll	Dispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.	InteractiveObject
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject

Property Detail

backgroundAlpha

property

backgroundAlpha:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

Implementation
public function get backgroundAlpha():Number
public function set backgroundAlpha(value:Number):void

backgroundColor

property

backgroundColor:uint

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Background color of a download progress bar. You can have either a backgroundColor or a backgroundImage, but not both.

Implementation
public function get backgroundColor():uint
public function set backgroundColor(value:uint):void

backgroundImage

property

backgroundImage:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

Implementation
public function get backgroundImage():Object
public function set backgroundImage(value:Object):void

backgroundSize

property

backgroundSize:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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):void

barFrameRect

property

barFrameRect:RoundedRectangle [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

DOWNLOAD_PERCENTAGE

property

protected var DOWNLOAD_PERCENTAGE:uint = 60

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

downloadingLabel

property

downloadingLabel:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The string to display as the label while in the downloading phase.

The default value is "Loading".

Implementation
protected function get downloadingLabel():String
protected function set downloadingLabel(value:String):void

initializingLabel

property

initializingLabel:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The string to display as the label while in the initializing phase.

The default value is "Initializing".

Implementation
public static function get initializingLabel():String
public static function set initializingLabel(value:String):void

initProgressTotal

property

protected var initProgressTotal:uint = 6

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 9, AIR 1.1

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.

label

property

label:String

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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 "".

Implementation
protected function get label():String
protected function set label(value:String):void

labelFormat

property

labelFormat:flash.text:TextFormat [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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():flash.text:TextFormat

labelRect

property

labelRect:Rectangle [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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:flash.text:TextFormat [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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():flash.text:TextFormat

percentRect

property

percentRect:Rectangle [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Controls whether to display the label, true, or not, false.

The default value is true.

Implementation
protected function get showLabel():Boolean
protected function set showLabel(value:Boolean):void

showPercentage

property

showPercentage:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Controls whether to display the percentage, true, or not, false.

The default value is true.

Implementation
protected function get showPercentage():Boolean
protected function set showPercentage(value:Boolean):void

stageHeight

property

stageHeight:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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[override]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

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

Constructor Detail

DownloadProgressBar

()

Constructor

public function DownloadProgressBar()

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Method Detail

center

()

method

protected function center(width:Number, height:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Centers the download progress bar based on the passed in dimensions.

Parameters

	`width: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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Event listener for the Event.COMPLETE event. The default implementation does nothing.

Parameters

event:Event — The event object.

createChildren

()

method

protected function createChildren():void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Creates the subcomponents of the display.

getPercentLoaded

()

method

protected function getPercentLoaded(loaded:Number, total:Number):Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Returns the percentage value of the application loaded.

Parameters

	`loaded:Number` — Number of bytes of the application SWF file that have been downloaded.

	`total:Number` — Size of the application SWF file in bytes.

Returns

Number — The percentage value of the loaded application.

initCompleteHandler

()

method

protected function initCompleteHandler(event:Event):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Event listener for the FlexEvent.INIT_COMPLETE event.

Parameters

event:Event — The event object.

initialize

()

method

public function initialize():void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

Parameters

event:Event — The event object.

progressHandler

()

method

protected function progressHandler(event:ProgressEvent):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

protected function rslCompleteHandler(event:RSLEvent):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Event listener for the RSLEvent.RSL_COMPLETE event.

Parameters

event:RSLEvent — The event object.

rslErrorHandler

()

method

protected function rslErrorHandler(event:RSLEvent):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

protected function rslProgressHandler(event:RSLEvent):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Event listener for the RSLEvent.RSL_PROGRESS event. The default implementation does nothing.

Parameters

event:RSLEvent — The event object.

setProgress

()

method

protected function setProgress(completed:Number, total:Number):void

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

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.

showDisplayForDownloading

()

method

protected function showDisplayForDownloading(elapsedTime:int, event:ProgressEvent):Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

Returns

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 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

Returns

Boolean — If true, then show the download progress bar.