| Package | mx.events |
| Class | public class RSLEvent |
| Inheritance | RSLEvent  flash.events.ProgressEvent |
See also
| Property | Defined by | ||
|---|---|---|---|
| errorText : String
The error message if the type is RSL_ERROR; otherwise, it is null;
| 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 | ||
| 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)
Constructor.
| RSLEvent | ||
| Constant | Defined by | ||
|---|---|---|---|
| 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 | ||
| errorText | property |
public var errorText:StringThe error message if the type is RSL_ERROR; otherwise, it is null;
| rslIndex | property |
public var rslIndex:int
The index number of the RSL currently being downloaded.
This is a number between 0 and rslTotal - 1.
| rslTotal | property |
public var rslTotal:intThe total number of RSLs being downloaded by the preloader
| url | property |
public var url:URLRequestThe URLRequest object that represents the location of the RSL being downloaded.
| 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)Constructor.
Parameterstype:String — The type of the event. Possible values are:
|
|
bubbles:Boolean (default = false) |
|
cancelable:Boolean (default = false) |
|
bytesLoaded:int (default = -1) |
|
bytesTotal:int (default = -1) |
|
rslIndex:int (default = -1)total - 1.
|
|
rslTotal:int (default = -1) |
|
url:URLRequest (default = null) |
|
errorText:String (default = null) |
| RSL_COMPLETE | constant |
public static const RSL_COMPLETE:String = "rslComplete"
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 |
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"
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 | An error message.|
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"
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 | Empty|
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. |