Packageimpression.events
Classpublic class SimulationObjectErrorEvent
InheritanceSimulationObjectErrorEvent Inheritance SimulationObjectEvent Inheritance flash.events.Event

A simulation object dispatches a SimulationObjectErrorEvent object when a simulation-related error occurs.



Public Properties
 PropertyDefined By
  errorData : *
[read-only] Additional data associated with the error.
SimulationObjectErrorEvent
  message : String
[read-only] The message associated with the error.
SimulationObjectErrorEvent
Public Methods
 MethodDefined By
  
SimulationObjectErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:String, errorData:* = null)
Creates a new instance of a SimulationObjectErrorEvent object.
SimulationObjectErrorEvent
  
clone():Event
[override] Duplicates an instance of the event object.
SimulationObjectErrorEvent
  
toString():String
[override] Returns a string containing all the properties of the SimulationObjectErrorEvent object.
SimulationObjectErrorEvent
Public Constants
 ConstantDefined By
  ERROR : String = simulationObjectError
[static] The SimulationObjectErrorEvent.ERROR constant defines the value of the type property of a simulation error event object.
SimulationObjectErrorEvent
 InheritedINITIALIZATION_COMPLETE : String = initializationComplete
[static] The SimulationObjectEvent.INITIALIZATION_COMPLETE constant defines the value of the type property of a simulation object initialization complete event object.
SimulationObjectEvent
 InheritedSTATE_READY : String = simulationStateReady
[static] The SimulationObjectEvent.STATE_READY constant defines the value of the type property of a simulation object state ready event object.
SimulationObjectEvent
Property Detail
errorDataproperty
errorData:*  [read-only]

Additional data associated with the error. The specific data and format are project defined.


Implementation
    public function get errorData():*
messageproperty 
message:String  [read-only]

The message associated with the error.


Implementation
    public function get message():String
Constructor Detail
SimulationObjectErrorEvent()Constructor
public function SimulationObjectErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:String, errorData:* = null)

Creates a new instance of a SimulationObjectErrorEvent object.

Parameters
type: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.
 
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.
Method Detail
clone()method
override public function clone():Event

Duplicates an instance of the event object.

Returns a new SimulationObjectErrorEvent object that is a copy of the original instance of the SimulationObjectErrorEvent 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.

Returns
Event — A new SimulationObjectErrorEvent object that is identical to the original.
toString()method 
override public function toString():String

Returns a string containing all the properties of the SimulationObjectErrorEvent object. The string is in the following format:

[SimulationObjectErrorEvent type=value bubbles=value cancelable=value eventPhase=value message=value errorData=value]

Returns
String — A string containing all the properties of the SimulationObjectErrorEvent object.
Constant Detail
ERRORConstant
public static const ERROR:String = simulationObjectError

The SimulationObjectErrorEvent.ERROR constant defines the value of the type property of a simulation error event object. This event has the following properties:

PropertyValue
bubblesfalse
cancelabletrue; cancelling the event will, when dispatched from a SimulationPlayer object, will cause the cancel() method to be invoked on the player's snapshot loader, sequencer, and rules engine objects. If the SimulationPlayer object's loading property value is true, loading finalization occurs after the cancel methods have been invoked.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
messageThe message associated with the error.
errorDataAdditional data associated with the error.