Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
Preloader

Package | mx.preloaders
Class | public class Preloader
Inheritance | Preloader flash.display.Sprite

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The Preloader class is used by the SystemManager to monitor the download and initialization status of a Flex application. It is also responsible for downloading the runtime shared libraries (RSLs).

The Preloader class instantiates a download progress bar, which must implement the IPreloaderDisplay interface, and passes download and initialization events to the download progress bar.

See also

mx.preloaders.DownloadProgressBar
mx.preloaders.Preloader

Public Methods

| Method | Defined By
--- | --- | ---
|  | Preloader() Constructor. | Preloader
|  | initialize(showDisplay:Boolean, displayClassName:Class, backgroundColor:uint, backgroundAlpha:Number, backgroundImage:Object, backgroundSize:String, displayWidth:Number, displayHeight:Number, libs:Array = null, sizes:Array = null, rslList:Array = null, resourceModuleURLs:Array = null, applicationDomain:ApplicationDomain = null):void Called by the SystemManager to initialize a Preloader object. | Preloader
|  | registerApplication(app:IEventDispatcher):void Called by the SystemManager after it has finished instantiating an instance of the application class. | Preloader

Constructor Detail

Preloader | () | Constructor

`public function Preloader()`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Method Detail

initialize | () | method

`public function initialize(showDisplay:Boolean, displayClassName:Class, backgroundColor:uint, backgroundAlpha:Number, backgroundImage:Object, backgroundSize:String, displayWidth:Number, displayHeight:Number, libs:Array = null, sizes:Array = null, rslList:Array = null, resourceModuleURLs:Array = null, applicationDomain:ApplicationDomain = null):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Called by the SystemManager to initialize a Preloader object.

Parameters

| `showDisplay:Boolean` — Determines if the display class should be displayed.
| `displayClassName:Class` — The IPreloaderDisplay class to use for displaying the preloader status.
| `backgroundColor:uint` — Background color of the application.
| `backgroundAlpha:Number` — Background alpha of the application.
| `backgroundImage:Object` — Background image of the application.
| `backgroundSize:String` — Background size of the application.
| `displayWidth:Number` — Width of the application.
| `displayHeight:Number` — Height of the application.
| `libs:Array` (default = `null`)`` — Array of string URLs for the runtime shared libraries.
| `sizes:Array` (default = `null`)`` — Array of uint values containing the byte size for each URL in the libs argument
| `rslList:Array` (default = `null`)`` — Array of object of type RSLItem and CdRSLItem. This array describes all the RSLs to load. The libs and sizes parameters are ignored and must be set to null.
| `resourceModuleURLs:Array` (default = `null`)`` — Array of Strings specifying URLs from which to preload resource modules.
| `applicationDomain:ApplicationDomain` (default = `null`)`` — The application domain in which your code is executing.

registerApplication | () | method |

`public function registerApplication(app:IEventDispatcher):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Called by the SystemManager after it has finished instantiating an instance of the application class. Flex calls this method; you do not call it yourself.

Parameters

| `app:IEventDispatcher` — The application object.

Sun Mar 5 2017, 03:42 PM +11:00