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.

ApplicationCacheEvent Class

Extends BaseEvent
Module: event
Parent Module: StructureJS

The ApplicationCacheEvent ....

Index

Show:

Events

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

CHANGE String static

Provided by the StructureJS module.

Defined in ts/event/native/WindowEvents.ts:3

TODO: YUIDoc_comment

CLICK String static

Provided by the StructureJS module.

Defined in ts/event/native/MouseEvents.ts:3

The event occurs when the user clicks on an element.

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

DBL_CLICK String static

Provided by the StructureJS module.

Defined in ts/event/native/MouseEvents.ts:12

The event occurs when the user double-clicks on an element.

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

MOUSE_DOWN String static

Provided by the StructureJS module.

Defined in ts/event/native/MouseEvents.ts:21

The event occurs when a user presses a mouse button over an element.

MOUSE_MOVE String static

Provided by the StructureJS module.

Defined in ts/event/native/MouseEvents.ts:30

The event occurs when the pointer is moving while it is over an element.

MOUSE_OUT String static

Provided by the StructureJS module.

Defined in ts/event/native/MouseEvents.ts:48

The event occurs when a user moves the mouse pointer out of an element.

MOUSE_OVER String static

Provided by the StructureJS module.

Defined in ts/event/native/MouseEvents.ts:39

The event occurs when the pointer is moved onto an element.

MOUSE_UP String static

Provided by the StructureJS module.

Defined in ts/event/native/MouseEvents.ts:57

The event occurs when a user releases a mouse button over an element

sjsId Int public

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

Default: null

TAP String static

Provided by the StructureJS module.

Defined in ts/event/native/MouseEvents.ts:66

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

ApplicationCacheEvent
(
  • 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

CACHED

String static

The resources listed in the manifest have been fully downloaded, and the application is now cached locally.

CHECKING

String static

The browser is checking for an update, or is attempting to download the cache manifest for the first time. This is always the first event in the sequence.

DOWNLOADING

String static

The browser has started to download the cache manifest, either for the first time or because changes have been detected.

ERROR

String static

An error occurred at some point - this could be caused by a number of things. This will always be the last event in the sequence.

NO_UPDATE

String static

The cache manifest hadn't changed.

OBSOLETE

String static

The cache manifest file could not be found, indicating that the cache is no longer needed. The application cache is being deleted.

OFFLINE

String static

Provided by the StructureJS module.

Defined in ts/event/native/NavigatorEvents.ts:12

TODO: YUIDoc_comment

ONLINE

String static

Provided by the StructureJS module.

Defined in ts/event/native/NavigatorEvents.ts:3

TODO: YUIDoc_comment

PROGRESS

String static

The browser had downloaded and cached an asset. This is fired once for every file that is downloaded (including the current page which is cached implicitly).

UPDATE_READY

String static

The resources listed in the manifest have been newly re-downloaded, and the script can use swapCache() to switch to the new cache.

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