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

Package | mx.events
Class | public class RSLEvent
Inheritance | RSLEvent flash.events.ProgressEvent

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The RSLEvent class represents an event object used by the DownloadProgressBar class when an RSL is being downloaded by the Preloader class.

See also

mx.preloaders.DownloadProgressBar
mx.preloaders.Preloader

Public Properties

| Property | Defined By
--- | --- | ---
|  | errorText : String The error message if the type is RSL_ERROR; otherwise, it is null; | RSLEvent
|  | isResourceModule : Boolean True if the event is for loading a resourceModule instead of an RSL | RSLEvent
|  | loaderInfo : LoaderInfo The LoaderInfo object associated with this event. | RSLEvent
|  | rslIndex : int The index number of the RSL currently being downloaded. | RSLEvent
|  | rslTotal : int The total number of RSLs being downloaded by the preloader | RSLEvent
|  | url : URLRequest The URLRequest object that represents the location of the RSL being downloaded. | RSLEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | RSLEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:int = -1, bytesTotal:int = -1, rslIndex:int = -1, rslTotal:int = -1, url:URLRequest = null, errorText:String = null, isResourceModule:Boolean = false, loaderInfo:LoaderInfo = null) Constructor. | RSLEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | RSL_ADD_PRELOADED : String = rslAddPreloaded [static] The RSLEvent.RSL_ADD_PRELOADED constant defines the value of the type property of the event object for an rslAddPreloaded event. | RSLEvent
|  | RSL_COMPLETE : String = rslComplete [static] Dispatched when the RSL has finished downloading. | RSLEvent
|  | RSL_ERROR : String = rslError [static] Dispatched when there is an error downloading the RSL. | RSLEvent
|  | RSL_PROGRESS : String = rslProgress [static] Dispatched when the RSL is downloading. | RSLEvent

Property Detail

errorText | property

`public var errorText:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The error message if the type is RSL_ERROR; otherwise, it is null;

isResourceModule | property |

`public var isResourceModule:Boolean`

True if the event is for loading a resourceModule instead of an RSL

loaderInfo | property |

`public var loaderInfo:LoaderInfo`

The LoaderInfo object associated with this event. This is only set in the RSLEvent.RSL_COMPLETE event. Otherwise loaderInfo will be null.

rslIndex | property |

`public var rslIndex:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The index number of the RSL currently being downloaded. This is a number between 0 and `rslTotal - 1`.

rslTotal | property |

`public var rslTotal:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The total number of RSLs being downloaded by the preloader

url | property |

`public var url:URLRequest`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The URLRequest object that represents the location of the RSL being downloaded.

Constructor Detail

RSLEvent | () | Constructor

`public function RSLEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, bytesLoaded:int = -1, bytesTotal:int = -1, rslIndex:int = -1, rslTotal:int = -1, url:URLRequest = null, errorText:String = null, isResourceModule:Boolean = false, loaderInfo:LoaderInfo = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `type:String` — The type of the event. Possible values are: "rslProgress" (`RSLEvent.RSL_PROGRESS`); "rslComplete" (`RSLEvent.RSL_COMPLETE`); "rslError" (`RSLEvent.RSL_ERROR`);
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be cancelled.
| `bytesLoaded:int` (default = `-1`)`` — The number of bytes loaded at the time the listener processes the event.
| `bytesTotal:int` (default = `-1`)`` — The total number of bytes that will ultimately be loaded if the loading process succeeds.
| `rslIndex:int` (default = `-1`)`` — The index number of the RSL relative to the total. This should be a value between 0 and `total - 1`.
| `rslTotal:int` (default = `-1`)`` — The total number of RSLs being loaded.
| `url:URLRequest` (default = `null`)`` — The location of the RSL.
| `errorText:String` (default = `null`)`` — The error message of the error when type is RSLEvent.RSL_ERROR.
| `isResourceModule:Boolean` (default = `false`)`` — True if the event occurred when loading a ResourceModule.
| `loaderInfo:LoaderInfo` (default = `null`)`` — The LoaderInfo object associated with this event.

Constant Detail

RSL_ADD_PRELOADED | Constant

`public static const RSL_ADD_PRELOADED:String = rslAddPreloaded`

Language Version : | ActionScript 3.0

Product Version : | Flex 4.5

Runtime Versions : | Flash Player 10, AIR 1.5

The `RSLEvent.RSL_ADD_PRELOADED` constant defines the value of the `type` property of the event object for an `rslAddPreloaded` event. This event is dispatched from an IFlexModuleFactory after a child IFlexModuleFactory preloads an RSL into its application domain.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`loaderInfo` | The LoaderInfo instance associated with this RSL.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

RSL_COMPLETE | Constant |

`public static const RSL_COMPLETE:String = rslComplete`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when the RSL has finished downloading. The `RSLEvent.RSL_COMPLETE` constant defines the value of the `type` property of the event object for a `rslComplete` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | The number of bytes loaded.
`bytesTotal` | The total number of bytes to load.
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` | Empty
`isResourceModule` | True if we loaded a resourceModule instead of an RSL
`rslIndex` | The index number of the RSL currently being downloaded.
`rslTotal` | The total number of RSLs being downloaded.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`url` | The URLRequest object that represents the location of the RSL being downloaded.

RSL_ERROR | Constant |

`public static const RSL_ERROR:String = rslError`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when there is an error downloading the RSL. The `RSLEvent.RSL_ERROR` constant defines the value of the `type` property of the event object for a `rslError` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | Empty
`bytesTotal` | Empty
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` |
`isResourceModule` | True if we loaded a resourceModule instead of an RSL
`rslIndex` | The index number of the RSL currently being downloaded.
`rslTotal` | The total number of RSLs being downloaded.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`url` | The URLRequest object that represents the location of the RSL being downloaded.

RSL_PROGRESS | Constant |

`public static const RSL_PROGRESS:String = rslProgress`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Dispatched when the RSL is downloading. The `RSLEvent.RSL_PROGRESS` constant defines the value of the `type` property of the event object for a `rslProgress` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`bytesLoaded` | The number of bytes loaded.
`bytesTotal` | The total number of bytes to load.
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`errorText` |
`isResourceModule` | True if we loaded a resourceModule instead of an RSL
`rslIndex` | The index number of the RSL currently being downloaded.
`rslTotal` | The total number of RSLs being downloaded.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`url` | The URLRequest object that represents the location of the RSL being downloaded.

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