Indicates whether an event is a bubbling event.

Indicates whether the behavior associated with the event can be prevented.

The currentTarget property always points to the DisplayObjectContainer that the event is currently processing (i.e. bubbling at).

Used to pass any type of data with the event.

Indicates if the stopImmediatePropagation was called on the event object.

Indicates if the stopPropagation was called on the event object.

The sjsId (StructureJS ID) is a unique identifier automatically assigned to most StructureJS objects upon instantiation.

A reference to the object that originally dispatched the event.

The type of event.

Parameters:

• type String

  The type of event. The type is case-sensitive.

• [bubbles=false] Boolean optional

  Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false. Note: With event-bubbling you can let one Event subsequently call on every ancestor (parent) (containers of containers of etc.) of the DisplayObjectContainer that originally dispatched the Event, all the way up to the surface (Stage). Any classes that do not have a parent cannot bubble.

• [cancelable=false] Boolean optional

  Indicates whether the behavior associated with the event can be prevented. If the behavior can be canceled, this value is true; otherwise it is false.

• [data=null] Any optional

  Use to pass any type of data with the event.

Example:

// Example: how to create a custom event by extending BaseEvent.
class CountryEvent extends BaseEvent {
 CHANGE_COUNTRY = 'CountryEvent.changeCountry';
 constructor(type, bubbles = false, cancelable = false, data = null) {
 super(type, bubbles, cancelable, data);
 this.countryName = null;
 }
 }
// Example: how to use the custom event.
let event = new CountryEvent(CountryEvent.CHANGE_COUNTRY);
event.countryName = 'Canada';
this.dispatchEvent(event);

Duplicates an instance of an BaseEvent subclass.

Returns a new BaseEvent object that is a copy of the original instance of the BaseEvent object.

The new BaseEvent object includes all the properties of the original.

Returns:

Example:

let cloneOfEvent = event.clone();

The purpose of the destroy method is to make an object ready for garbage collection. This should be thought of as a one way function. Once destroy is called no further methods should be called on the object or properties accessed. It is the responsibility of those who implement this function to stop all running Timers, all running Sounds, and take any other steps necessary to make an object eligible for garbage collection.

By default the destroy method will null out all properties of the class automatically. You should call destroy on other objects before calling the super.

Returns:

Example:

destroy() {
 this.disable();
 this._childInstance.destroy();
 super.destroy();
}

Returns the fully qualified class name of an object.

Returns:

Example:

let someClass = new SomeClass();
someClass.getQualifiedClassName();
// SomeClass

Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. This method takes effect immediately, and it affects event listeners in the current node. In contrast, the stopPropagation method doesn't take effect until all the event listeners in the current node finish processing.

Example:

event.stopImmediatePropagation();

Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect.

Example:

event.stopPropagation();

The BaseEvent.ACTIVATE constant defines the value of the type property of an activate event object.

The BaseEvent.ADDED constant defines the value of the type property of an added event object.

The BaseEvent.ADDED_TO_STAGE constant defines the value of the type property of an addedToStage event object.

The BaseEvent.CANCEL constant defines the value of the type property of a cancel event object.

The BaseEvent.CHANGE constant defines the value of the type property of a change event object.

The BaseEvent.CLEAR constant defines the value of the type property of a clear event object.

The BaseEvent.CLOSE constant defines the value of the type property of a close event object.

The BaseEvent.CLOSING constant defines the value of the type property of a closing event object.

The BaseEvent.COMPLETE constant defines the value of the type property of a complete event object.

The BaseEvent.CONNECT constant defines the value of the type property of a connect event object.

Defines the value of the type property of a copy event object.

Defines the value of the type property of a cut event object.

The BaseEvent.DEACTIVATE constant defines the value of the type property of a deactivate event object.

The BaseEvent.DISPLAYING constant defines the value of the type property of a displaying event object.

The BaseEvent.ENTER_FRAME constant defines the value of the type property of an enterFrame event object.

The BaseEvent.EXIT_FRAME constant defines the value of the type property of an exitFrame event object.

The BaseEvent.EXITING constant defines the value of the type property of an exiting event object.

The BaseEvent.FULL_SCREEN constant defines the value of the type property of a fullScreen event object.

The BaseEvent.INIT constant defines the value of the type property of an init event object.

The BaseEvent.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object.

The BaseEvent.OPEN constant defines the value of the type property of an open event object.

The BaseEvent.PASTE constant defines the value of the type property of a paste event object.

The BaseEvent.PREPARING constant defines the value of the type property of a preparing event object.

The BaseEvent.REMOVED constant defines the value of the type property of a removed event object.

The BaseEvent.RENDER constant defines the value of the type property of a render event object.

The BaseEvent.RESIZE constant defines the value of the type property of a resize event object.

The BaseEvent.SELECTED constant defines the value of the type property of a selected event object.