Packagecom.worlize.api.event
Classpublic class StateHistoryEvent
InheritanceStateHistoryEvent Inheritance flash.events.Event

Product Version : Worlize APIv.1

Event representing a change to the object's state history.

See also

com.worlize.api.data.StateHistory


Public Properties
 PropertyDefined By
  entry : Object
The state data being added or removed.
StateHistoryEvent
  index : int
The entry object's zero-based index in the list of state history entries.
StateHistoryEvent
Public Methods
 MethodDefined By
  
StateHistoryEvent(type:String)
Constructor.
StateHistoryEvent
Public Constants
 ConstantDefined By
  CLEARED : String = cleared
[static] The StateHistoryEvent.CLEARED constant defines the value of the type property of the event object for a cleared event.
StateHistoryEvent
  ENTRY_ADDED : String = entryAdded
[static] The StateHistoryEvent.ENTRY_ADDED constant defines the value of the type property of the event object for a entryAdded event.
StateHistoryEvent
  ENTRY_REMOVED : String = entryRemoved
[static] The StateHistoryEvent.ENTRY_REMOVED constant defines the value of the type property of the event object for a entryRemoved event.
StateHistoryEvent
Property Detail
entryproperty
public var entry:Object

Product Version : Worlize API.v1

The state data being added or removed.

indexproperty 
public var index:int

Product Version : Worlize API.v1

The entry object's zero-based index in the list of state history entries.

Constructor Detail
StateHistoryEvent()Constructor
public function StateHistoryEvent(type:String)

Product Version : Worlize API.v1

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
Constant Detail
CLEAREDConstant
public static const CLEARED:String = cleared

Product Version : Worlize APIv.1

The StateHistoryEvent.CLEARED constant defines the value of the type property of the event object for a cleared event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
targetThe 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.

ENTRY_ADDEDConstant 
public static const ENTRY_ADDED:String = entryAdded

Product Version : Worlize APIv.1

The StateHistoryEvent.ENTRY_ADDED constant defines the value of the type property of the event object for a entryAdded event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
entryThe object representing the state data being added.
indexAn integer indicating the zero-based position of the state data being added.
targetThe 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.

ENTRY_REMOVEDConstant 
public static const ENTRY_REMOVED:String = entryRemoved

Product Version : Worlize APIv.1

The StateHistoryEvent.ENTRY_REMOVED constant defines the value of the type property of the event object for a entryRemoved event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
entryThe object representing the state data being removed.
indexAn integer indicating the zero-based position of the state data being removed.
targetThe 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.