Packagemx.preloaders
Interfacepublic interface IPreloaderDisplay extends flash.events.IEventDispatcher
Implementors DownloadProgressBar, SparkDownloadProgressBar, SplashScreen

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 9, AIR 1.1

Defines the interface that a class must implement to be used as a download progress bar. The IPreloaderDisplay receives events from the Preloader class and is responsible for visualizing that information to the user.

See also

mx.preloaders.DownloadProgressBar
mx.preloaders.Preloader


Public Properties
 PropertyDefined By
  backgroundAlpha : Number
Alpha level of the SWF file or image defined by the backgroundImage property, or the color defined by the backgroundColor property.
IPreloaderDisplay
  backgroundColor : uint
Background color of a download progress bar.
IPreloaderDisplay
  backgroundImage : Object
The background image of the application, which is passed in by the preloader.
IPreloaderDisplay
  backgroundSize : String
Scales the image specified by backgroundImage to different percentage sizes.
IPreloaderDisplay
  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.
IPreloaderDisplay
  stageHeight : Number
The height of the stage, which is passed in by the Preloader class.
IPreloaderDisplay
  stageWidth : Number
The width of the stage, which is passed in by the Preloader class.
IPreloaderDisplay
Public Methods
 MethodDefined By
  
initialize():void
Called by the Preloader after the download progress bar has been added as a child of the Preloader.
IPreloaderDisplay
Property Detail
backgroundAlphaproperty
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.


Implementation
    public function get backgroundAlpha():Number
    public function set backgroundAlpha(value:Number):void
backgroundColorproperty 
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
backgroundImageproperty 
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.


Implementation
    public function get backgroundImage():Object
    public function set backgroundImage(value:Object):void
backgroundSizeproperty 
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.


Implementation
    public function get backgroundSize():String
    public function set backgroundSize(value:String):void
preloaderproperty 
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
stageHeightproperty 
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
stageWidthproperty 
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
Method Detail
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.