Package | impression.events |
Class | public class SimulationPlayerErrorEvent |
Inheritance | SimulationPlayerErrorEvent ![]() ![]() |
Property | Defined By | ||
---|---|---|---|
errorData : * [read-only]
Additional data associated with the error. | SimulationPlayerErrorEvent | ||
loading : Boolean [read-only]
Indicates whether or not the event occurred during the loading phase of the storyboard. | SimulationPlayerErrorEvent | ||
message : String [read-only]
The message associated with the error. | SimulationPlayerErrorEvent | ||
![]() | sb : Storyboard [read-only]
The Storyboard object assigned to the target. | StoryboardEvent | |
source : String [read-only]
The type of object that initially raised the error. | SimulationPlayerErrorEvent |
Method | Defined By | ||
---|---|---|---|
SimulationPlayerErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, loading:Boolean = false, message:String, errorData:* = null, source:* = null)
Creates a new instance of a SimulationPlayerErrorEvent object. | SimulationPlayerErrorEvent | ||
clone():Event [override]
Duplicates an instance of the event object. | SimulationPlayerErrorEvent | ||
toString():String [override]
Returns a string containing all the properties of the SimulationPlayerErrorEvent object. | SimulationPlayerErrorEvent |
Constant | Defined By | ||
---|---|---|---|
![]() | COMPLETE : String = complete [static]
The StoryboardEvent.COMPLETE constant defines the value of the
type property of a complete event object. | StoryboardEvent | |
![]() | CONTENT_LOAD_BEGIN : String = contentLoadBegin [static]
The StoryboardEvent.CONTENT_LOAD_BEGIN constant defines the value of the
type property of a content load begin event object. | StoryboardEvent | |
![]() | CONTENT_LOAD_END : String = contentLoadEnd [static]
The StoryboardEvent.CONTENT_LOAD_END constant defines the value of the
type property of a content load end event object. | StoryboardEvent | |
ERROR : String = simulationPlayerError [static]
The SimulationPlayerErrorEvent.ERROR constant defines the value of the
type property of an error event object. | SimulationPlayerErrorEvent | ||
![]() | INITIALIZE : String = initialize [static]
The StoryboardEvent.INITIALIZE constant defines the value of the
type property of a initialize event object. | StoryboardEvent | |
![]() | LOAD_COMPLETE : String = loadComplete [static]
The StoryboardEvent.LOAD_COMPLETE constant defines the value of the
type property of a load event object. | StoryboardEvent | |
![]() | LOAD_START : String = loadStart [static]
The StoryboardEvent.LOAD_START constant defines the value of the
type property of an load start event object. | StoryboardEvent | |
![]() | UNLOAD : String = unload [static]
The StoryboardEvent.UNLOAD constant defines the value of the
type property of an unload event object. | StoryboardEvent |
errorData | property |
errorData:*
[read-only] Additional data associated with the error. The specific data and format are project defined.
public function get errorData():*
loading | property |
loading:Boolean
[read-only] Indicates whether or not the event occurred during the loading phase of the storyboard.
public function get loading():Boolean
message | property |
message:String
[read-only] The message associated with the error.
public function get message():String
source | property |
source:String
[read-only]
The type of object that initially raised the error. When dispatched by the SimulationPlayer, this value will be one of the
SimulationObjectTypes
constant values.
public function get source():String
SimulationPlayerErrorEvent | () | Constructor |
public function SimulationPlayerErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, sb:Storyboard = null, loading:Boolean = false, message:String, errorData:* = null, source:* = null)
Creates a new instance of a SimulationPlayerErrorEvent object.
Parameterstype:String — The type of the event. Event listeners can access this information through the inherited type property.
| |
bubbles:Boolean (default = false ) — Determines whether the event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inheritied bubbles property.
| |
cancelable:Boolean (default = false ) — Determines whether the event object can be canceled. Event listeners can access this information through the inherited cancelable property.
| |
sb:Storyboard (default = null ) — The Storyboard object assigned to the target. Event listeners can access this information through the inherited sb property.
| |
loading:Boolean (default = false ) — Indicates whether or not the event occurred during the loading phase of the storyboard. Event listeners can access this information through the loading property.
| |
message:String — The message associated with the error. Event listeners can access this information through the message property.
| |
errorData:* (default = null ) — Additional data associated with the error. Event listeners can access this information through the errorData property.
| |
source:* (default = null ) — The type of object that initially raised the error. Event listeners can access this information through the source property.
|
clone | () | method |
override public function clone():Event
Duplicates an instance of the event object.
Returns a new SimulationPlayerErrorEvent object that is a copy of the original instance of the SimulationPlayerErrorEvent object.
You do not normally call clone()
; the EventDispatcher class calls it automatically when you redispatch
an event--that is, when you call dispatchEvent(event)
from a handler that is handling event
.
Event — A new SimulationPlayerErrorEvent object that is identical to the original.
|
toString | () | method |
override public function toString():String
Returns a string containing all the properties of the SimulationPlayerErrorEvent object. The string is in the following format:
[SimulationPlayerErrorEvent type=value bubbles=value cancelable=value eventPhase=value sb=value loading=value message=value errorData=value source=value]
String — A string containing all the properties of the SimulationPlayerErrorEvent object.
|
ERROR | Constant |
public static const ERROR:String = simulationPlayerError
The SimulationPlayerErrorEvent.ERROR constant defines the value of the type property of an error event object. This event has the following properties:
Property | Value |
---|---|
bubbles | false |
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 object that raised the event. |
sb | The Storyboard object assigned to the target. |
loading | Indicates whether or not the event occurred during the loading phase of the storyboard. |
message | The message associated with the error. |
errorData | Additional data associated with the error. |
source | The type of object that initially raised the error. |