StructureJS

0.15.2

A class based utility library for building modular and scalable web platform applications. Features opt-in classes and utilities which provide a solid foundation and toolset to build your next project.

RouterEvent Class

Extends BaseEvent
Module: event
Parent Module: StructureJS

The RouterEvent is used in the Router class and gets passed to the callback in the Route class.

Properties

bubbles Boolean public

Indicates whether an event is a bubbling event.

Default: false

cancelable Boolean public

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

Default: false

currentTarget Any public

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

Default: null

data Any public

Used to pass any type of data with the event.

Default: null

isImmediatePropagationStopped Boolean public

Indicates if the stopImmediatePropagation was called on the event object.

Default: false

isPropagationStopped Boolean public

Indicates if the stopPropagation was called on the event object.

Default: false

newURL String public

The new URL to which the window is navigating.

oldURL String public

The previous URL from which the window was navigated.

params Array. public

An array containing the parameters captured from the Route.match being called with the routePattern property.

query Any public

A query object the represents the query string in the hash url.

route String public

The route that was matched against routePattern property.

routePattern String public

The route pattern that matched the route property.

sjsId Int public

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

Default: null

target Any public

A reference to the object that originally dispatched the event.

Default: null

type String public

The type of event.

Default: null

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Constructor

RouterEvent
(
  • type
  • [bubbles=false]
  • [cancelable=false]
  • [data=null]
)

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.

Methods

clone () BaseEvent public

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();

destroy () Void public

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:

Void:

Example:

destroy() {
     this.disable();

     this._childInstance.destroy();

     super.destroy();
}

getQualifiedClassName () String public

Returns the fully qualified class name of an object.

Returns:

String:

Returns the class name.

Example:

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

// SomeClass

stopImmediatePropagation () public

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();

stopPropagation () public

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();

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index

Events

CHANGE

String static

The RouterEvent.CHANGE constant defines the value of the type property of an change route event object.

There are no events that match your current filter settings. You can change your filter settings in the index section on this page. index