| Package | mx.events |
| Class | public class RSLEvent |
| Inheritance | RSLEvent  ProgressEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
More examples
Learn more
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| bytesLoaded : Number
The number of items or bytes loaded when the listener processes the event. | ProgressEvent | |
| bytesTotal : Number
The total number of items or bytes that will be loaded if the loading process succeeds. | ProgressEvent | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| errorText : String
The error message if the type is RSL_ERROR; otherwise, it is null;
| RSLEvent | ||
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| 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 | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
| 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 | ||
| [override]
Creates a copy of the ProgressEvent object and sets each property's value to match that of the original. | ProgressEvent | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string that contains all the properties of the ProgressEvent object. | ProgressEvent | |
|
Returns the primitive value of the specified object. | Object | |
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:BooleanTrue if the event is for loading a resourceModule instead of an RSL
loaderInfo | property |
public var loaderInfo:LoaderInfoThe 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.
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) | |
isResourceModule:Boolean (default = false) | |
loaderInfo:LoaderInfo (default = null) |
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. |
Thu Dec 6 2018, 01:12 PM -08:00