Holds a reference to added listeners.

A reference to window.localStorage for faster access.

Current user namespace. The namespace is optional.

The isEnabled property is used to keep track of the enabled state of the object.

Indicates the object that contains a child object. Uses the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy and helps facilitate event bubbling.

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

Example:

this._localStorageController = new LocalStorageService();
this._localStorageController.set('someName', { value: 'something'});

Parameters:

• event StorageEvent

  The native browser event for Web Storage.

Registers an event listener object with an EventDispatcher object so the listener receives notification of an event.

Parameters:

• type String

  The type of event.

• callback Function

  The listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing, as this example shows. @example function(event:Event):void

• scope Any

  Binds the scope to a particular object (scope is basically what "this" refers to in your function). This can be very useful in JavaScript because scope isn't generally maintained.

• [priority=0] Int optional

  Influences the order in which the listeners are called. Listeners with lower priorities are called after ones with higher priorities.

Example:

 this.addEventListener(BaseEvent.CHANGE, this._handlerMethod, this);
 _handlerMethod(event) {
 console.log(event.target + " sent the event.");
 console.log(event.type, event.data);
 }

Registers an event listener object once with an EventDispatcher object so the listener will receive the notification of an event.

Parameters:

• type String

  The type of event.

• callback Function

  The listener function that processes the event. This function must accept an Event object as its only parameter and must return nothing, as this example shows. @example function(event:Event):void

• scope Any

  Binds the scope to a particular object (scope is basically what "this" refers to in your function). This can be very useful in JavaScript because scope isn't generally maintained.

• [priority=0] Int optional

  Influences the order in which the listeners are called. Listeners with lower priorities are called after ones with higher priorities.

Example:

 this.addEventListenerOnce(BaseEvent.CHANGE, this._handlerMethod, this);
 _handlerMethod(event) {
 console.log(event.target + " sent the event.");
 console.log(event.type, event.data);
 }

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

The disable method is responsible for disabling event listeners and/or children of the containing objects.

Example:

 disable() {
 if (this.isEnabled === false) { return; }
 this._childInstance.removeEventListener(BaseEvent.CHANGE, this.handlerMethod, this);
 this._childInstance.disable();
 super.disable();
 }

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.

Parameters:

• event String | BaseEvent

  The Event object or event type string you want to dispatch. You can create custom events, the only requirement is all events must extend BaseEvent.

• [data=null] Any optional

  The optional data you want to send with the event. Do not use this parameter if you are passing in a BaseEvent.

Example:

 this.dispatchEvent('change');
 // Example: Sending data with the event:
 this.dispatchEvent('change', {some: 'data'});
 // Example: With an event object
 // (event type, bubbling set to true, cancelable set to true and passing data) :
 let event = new BaseEvent(BaseEvent.CHANGE, true, true, {some: 'data'});
 this.dispatchEvent(event);
 // Here is a common inline event object being dispatched:
 this.dispatchEvent(new BaseEvent(BaseEvent.CHANGE));

The enable method is responsible for enabling event listeners and/or children of the containing objects.

Example:

enable() {
 if (this.isEnabled === true) { return; }
 this._childInstance.addEventListener(BaseEvent.CHANGE, this.handlerMethod, this);
 this._childInstance.enable();
 super.enable();
}

Retrieves the current value associated with the Local Storage key.

Parameters:

• key String
• [useNamespace=false] String optional

Returns:

Example:

this._localStorageController.setNamespace('myNamespace~');

Returns all items in local storage as an Object with key and value properties or returns all items with a certain namespace.

Parameters:

• [namespace=null] String optional

  The namespace that is used to items.

Returns:

Example:

this._localStorageController.getAll();
this._localStorageController.getAll('myNamespace~');

Returns and array of all current event types and there current listeners.

Returns:

Example:

 this.getEventListeners();

Returns the number of items storage in local storage.

Returns:

Example:

const numberOfItemsInLocalStorage = this._localStorageController.getLength();

Get storage namespace

Returns:

Example:

const currentSetNamespace = this._localStorageController.getNamespace();

Returns the fully qualified class name of an object.

Returns:

Example:

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

Returns the size of the Local Storage.

Returns:

Example:

const sizeOfLocalStorage = this._localStorageController.getSize();

Check if an object has a specific event listener already added.

Parameters:

• type String

  The type of event.

• callback Function

  The listener method to call.

• scope Any

  The scope of the listener object.

Returns:

Example:

 this.hasEventListener(BaseEvent.CHANGE, this._handlerMethod, this);

Prints out each event listener in the console.log

Returns:

Example:

 this.printEventListeners();
 // [ClassName] is listening for the 'BaseEvent.change' event.
 // [AnotherClassName] is listening for the 'BaseEvent.refresh' event.

Deletes a key/value pair from the Local Storage collection.

Parameters:

• key String
• [useNamespace=false] String optional

Returns:

Example:

this._localStorageController.remove('someName');
// If you set a namespace you would pass 'true' into the second parameter.
this._localStorageController.remove('someName', true);

Removes all key/value pairs from the Local Storage area.

Parameters:

• [namespace=null] String optional

Example:

this._localStorageController.removeAll();
this._localStorageController.removeAll('myNamespace~');

Removes a specified listener from the EventDispatcher object.

Parameters:

• type String

  The type of event.

• callback Function

  The listener object to remove.

• scope Any

  The scope of the listener object to be removed.

Example:

 this.removeEventListener(BaseEvent.CHANGE, this._handlerMethod, this);

Deletes all key/value pairs with a certain namespace.

Parameters:

• namespace String

Add a key/value pair to localStorage.

Parameters:

• key String
• data Object
• [useNamespace=false] Boolean optional

Returns:

Example:

this._localStorageController.set('someName', { value: 'something'});
// If you set a namespace you would pass 'true' into the third parameter.
this._localStorageController.set('someName', { value: 'something'}, true);

Set storage namespace

Parameters:

• namespace Object

Returns:

Example:

this._localStorageController.setNamespace('myNamespace~');