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 |
See also
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 associated with this event. | RSLEvent | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
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 |
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)
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 |
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 efines 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 | ||
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 | ||
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 | ||
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 | ||
PROGRESS : String = "progress" [static]
Defines the value of the type property of a progress event object. | ProgressEvent | ||
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_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 | ||
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 | ||
SOCKET_DATA : String = "socketData" [static]
Defines the value of the type property of a socketData event object. | ProgressEvent | ||
SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete 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 | ||
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 |
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 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.
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)
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 ) — 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.
|
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. |
Fri Mar 19 2010, 02:45 AM -07:00