mx.preloaders.DownloadProgressBar (Flex™ 2.0.1 Language Reference)

Public Properties

	Property		Defined by
		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
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to `true`, Flash Player 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 : ContextMenu Specifies the context menu associated with this object.	InteractiveObject
		doubleClickEnabled : Boolean Specifies whether the object receives `doubleClick` events.	InteractiveObject
		dropTarget : DisplayObject 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 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 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 Indicates the x coordinate of the mouse position, in pixels.	DisplayObject
		mouseY : Number Indicates the y coordinate of the mouse position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		numChildren : int 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 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 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
		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
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		soundTransform : SoundTransform Controls sound within this sprite.	Sprite
		stage : Stage 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 : TextSnapshot Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		transform : 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 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

	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

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
		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 display object to see if it overlaps or intersects with 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
		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
		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

	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

Summary	Defined by
activate	Dispatched when Flash Player 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
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
deactivate	Dispatched when Flash Player loses operating 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	Dispatched when the playhead is entering a new frame.	DisplayObject
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance in the Flash Player window.	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 in the Flash Player window.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance in the Flash Player window.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance in the Flash Player window.	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	Dispatched when the display list is about to be updated and rendered.	DisplayObject
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
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

Property detail

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.

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

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

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

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

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

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

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

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

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

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

Constructor detail

DownloadProgressBar

()

constructor

public function DownloadProgressBar()

Constructor

Method detail

center

()

method

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

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

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

Parameters

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.

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.

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.

Parameters

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.

Parameters

event:ProgressEvent — The event object.

rslCompleteHandler

()

method

protected function rslCompleteHandler(event:RSLEvent):void

Event listener for the RSLEvent.RSL_COMPLETE event.

Parameters

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.

Parameters

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.

Parameters

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.

Parameters

completed:

Adobe^® Flex™ 2.0.1 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class DownloadProgressBar	Properties \| Methods \| Events

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