| Package | fl.events |
| Class | public class RSLErrorEvent |
| Inheritance | RSLErrorEvent  ErrorEvent TextEvent Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS5 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
RSLPreloader. This event
indicates that the download of RSLs has failed, and provides information on the files that have failed
and the number of files, both attempted and failed. When a custom event preloading loop is used, and the
RSLPreloader code is generated automatically by Flash authoring, this event is
dispatched by the main timeline. In this case, use addEventListener without needing to
reference the RSLPreloader.
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 | |
| 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 | |
| errorID : int [read-only]
Contains the reference number associated with the specific error. | ErrorEvent | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| failedURLs : Array [read-only]
Returns an array of files that have failed to download. | RSLErrorEvent | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| rslsFailed : int [read-only]
Returns the number of files that have failed to download. | RSLErrorEvent | ||
| rslsLoaded : int [read-only]
Returns the number of files that have downloaded successfully. | RSLErrorEvent | ||
| rslsTotal : int [read-only]
Returns the total number of files that have downloaded, successfully or not. | RSLErrorEvent | ||
| target : Object [read-only]
The event target. | Event | |
| text : String
For a textInput event, the character or sequence of characters
entered by the user. | TextEvent | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
RSLErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, rslsLoaded:int = 0, rslsFailed:int = 0, rslsTotal:int = 0, failedURLs:Array = null)
Creates an RSLErrorEvent object that contains information about RSLError events. | RSLErrorEvent | ||
| [override]
Creates a copy of the ErrorEvent object and sets the value of each property to match that of the original. | ErrorEvent | |
|
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 ErrorEvent object. | ErrorEvent | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ACTIVATE : String = "activate" [static]
The ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
| ADDED : String = "added" [static]
The Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
| ADDED_TO_STAGE : String = "addedToStage" [static]
The Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
| CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
| CHANGE : String = "change" [static]
The Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
| CLEAR : String = "clear" [static]
The Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | |
| CLOSE : String = "close" [static]
The Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
| CLOSING : String = "closing" [static]
The Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
| COMPLETE : String = "complete" [static]
The Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
| CONNECT : String = "connect" [static]
The Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
| CONTEXT3D_CREATE : String = "context3DCreate" [static]
The Event.CONTEXT3D_CREATE constant defines the value of the type
property of a context3Dcreate event object. | Event | |
| COPY : String = "copy" [static]
Defines the value of the type property of a copy event object. | Event | |
| CUT : String = "cut" [static]
Defines the value of the type property of a cut event object. | Event | |
| DEACTIVATE : String = "deactivate" [static]
The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
| DISPLAYING : String = "displaying" [static]
The Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
| ENTER_FRAME : String = "enterFrame" [static]
The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
| ERROR : String = "error" [static]
Defines the value of the type property of an error event object. | ErrorEvent | |
| EXIT_FRAME : String = "exitFrame" [static]
The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
| EXITING : String = "exiting" [static]
The Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
| FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
| FULLSCREEN : String = "fullScreen" [static]
The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
| HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | |
| HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | |
| HTML_RENDER : String = "htmlRender" [static]
The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
| ID3 : String = "id3" [static]
The Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
| INIT : String = "init" [static]
The Event.INIT constant defines the value of the type property of an init event object. | Event | |
| LINK : String = "link" [static]
Defines the value of the type property of a link event object. | TextEvent | |
| LOCATION_CHANGE : String = "locationChange" [static]
The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
| MOUSE_LEAVE : String = "mouseLeave" [static]
The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
| NETWORK_CHANGE : String = "networkChange" [static]
The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
| OPEN : String = "open" [static]
The Event.OPEN constant defines the value of the type property of an open event object. | Event | |
| PASTE : String = "paste" [static]
The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| PREPARING : String = "preparing" [static]
The Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
| REMOVED : String = "removed" [static]
The Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
| REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
| RENDER : String = "render" [static]
The Event.RENDER constant defines the value of the type property of a render event object. | Event | |
| RESIZE : String = "resize" [static]
The Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
| RSL_LOAD_FAILED : String = "rslLoadFailed" [static]
Error dispatched by RSLPreloader when all RSLs have finished
downloading and one or more have failed. | RSLErrorEvent | ||
| SCROLL : String = "scroll" [static]
The Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | |
| SELECT : String = "select" [static]
The Event.SELECT constant defines the value of the type property of a select event object. | Event | |
| SELECT_ALL : String = "selectAll" [static]
The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
| SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
| STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | |
| STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | |
| STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | |
| TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
| TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
| TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
| TEXT_INPUT : String = "textInput" [static]
Defines the value of the type property of a textInput event object. | TextEvent | |
| TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of an interaction mode event object. | Event | |
| UNLOAD : String = "unload" [static]
The Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
| USER_IDLE : String = "userIdle" [static]
The Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
| USER_PRESENT : String = "userPresent" [static]
The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | |
Property Detail
failedURLs | property |
rslsFailed | property |
rslsLoaded | property |
rslsTotal | property |
Constructor Detail
RSLErrorEvent | () | Constructor |
public function RSLErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, rslsLoaded:int = 0, rslsFailed:int = 0, rslsTotal:int = 0, failedURLs:Array = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS5 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
Creates an RSLErrorEvent object that contains information about RSLError events. RSLErrorEvent objects are passed as parameters to event listeners.
Parameterstype:String — The type of the event. Possible values are: RSLEvent.RSL_LOAD_COMPLETE and RSLEvent.RSL_PROGRESS.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
rslsLoaded:int (default = 0) | |
rslsFailed:int (default = 0) | |
rslsTotal:int (default = 0) | |
failedURLs:Array (default = null) |
Constant Detail
RSL_LOAD_FAILED | Constant |
public static const RSL_LOAD_FAILED:String = "rslLoadFailed"| Language Version: | ActionScript 3.0 |
| Product Version: | Flash CS5 |
| Runtime Versions: | Flash Player 10.1, AIR 2 |
Error dispatched by RSLPreloader when all RSLs have finished
downloading and one or more have failed. When preloading with a custom event loop, user
content MUST listen for this event to determine when to exit the loading animation loop.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | true |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The DisplayObject instance being added to the display list.
The target is not always the object in the display list
that registered the event listener. Use the currentTarget
property to access the object in the display list that is currently processing the event. |
rslsLoaded | The number of files that have downloaded successfully. |
rslsFailed | the number of files that have failed to download. |
rslsTotal | the total number of files that have downloaded, successfully or not. |
failedURLs | An array of files that have failed to download. |
import fl.events.RSLErrorEvent;
myPreloader.addEventListener(RSLErrorEvent.RSL_LOAD_FAILED, rslLoadFailedHandler);
function rslLoadFailedHandler(e:RSLErrorEvent) {
gotoAndPlay('rslLoadFailure');
}
Related API Elements
Mon Nov 28 2011, 06:48 AM -08:00