Class: LocalHash

conbo.LocalHash(options)

new LocalHash(options)

A persistent Hash that stores data in LocalStorage or Session
Parameters:
Name Type Description
options Object Object containing initialisation options, including 'name' (string), 'session' (Boolean) and 'source' (object) containing default values; see Hash for other options
Author:
  • Neil Rackett
Source:
Fires:

Extends

Members

supro

Similar to `super` in ActionScript or Java, this property enables you to access properties and methods of the super class prototype, which is the case of JavaScript is the next prototype up the chain
Inherited From:
Source:

Methods

addEventListener(type, handler, scopeopt, priorityopt, onceopt) → {conbo.EventDispatcher}

Add a listener for a particular event type
Parameters:
Name Type Attributes Default Description
type string Type of event ('change') or events ('change blur')
handler function Function that should be called
scope Object <optional>
 Options object (recommended) or the scope in which to run the event handler (deprecated)
priority number <optional>
 0 The event handler's priority when the event is dispatached (deprecated)
once boolean <optional>
 false Should the event listener automatically be removed after it has been called once? (deprecated)
Inherited From:
Source:
Returns:
A reference to this class instance
Type
conbo.EventDispatcher

bindAll(…methodNameopt) → {this}

Scope all methods of this class instance to this class instance
Parameters:
Name Type Attributes Description
methodName string <optional>
<repeatable>
 Specific method names to bind (all will be bound if none specified)
Inherited From:
Source:
Returns:
Type
this

clear()

[Web Storage API] When invoked, will empty all keys out of the Hash (or set them to undefined if they cannot be deleted)
Inherited From:
Source:

declarations() → {void}

Declarations is used to declare instance properties used by this class
Parameters:
Type Attributes Description
* <repeatable>
Inherited From:
Source:
Returns:
Type
void

destroy() → {void}

Clean everything up ready for garbage collection (you should override in your own classes)
Inherited From:
Source:
Returns:
Type
void

dispatchChange(propName) → {conbo.EventDispatcher}

Dispatch a change event for one or more changed properties
Parameters:
Name Type Description
propName string The name of the property that has changed
Inherited From:
Source:
Returns:
A reference to this class instance
Type
conbo.EventDispatcher

dispatchEvent(event) → {conbo.EventDispatcher}

Dispatch the event to listeners
Parameters:
Name Type Description
event conbo.Event The event to dispatch
Inherited From:
Source:
Returns:
A reference to this class instance
Type
conbo.EventDispatcher

flush()

Immediately writes all data to local storage. If you don't use this method, Conbo writes the data the next time it detects a change to a bindable property.
Source:

getItem(keyName)

[Web Storage API] When passed a key name, will return that key's value
Parameters:
Name Type Description
keyName string
Inherited From:
Source:

hasEventListener(type, handleropt, scopeopt) → {boolean}

Does this object have an event listener of the specified type?
Parameters:
Name Type Attributes Description
type string Type of event (e.g. 'change')
handler function <optional>
 Function that should be called
scope Object <optional>
 Options object (recommended) or the scope in which to run the event handler (deprecated)
Inherited From:
Source:
Returns:
True if this object has the specified event listener, false if it does not
Type
boolean

initialize() → {void}

Initialize (entry point) is called immediately after the constructor has completed
Parameters:
Type Attributes Description
* <repeatable>
Inherited From:
Source:
Returns:
Type
void

key(index)

[Web Storage API] When passed a number n, this method will return the name of the nth key in the Hash
Parameters:
Name Type Description
index number
Inherited From:
Source:

preinitialize() → {void}

Preinitialize is called before any code in the constructor has been run
Parameters:
Type Attributes Description
* <repeatable>
Inherited From:
Source:
Returns:
Type
void

removeEventListener(typeopt, handleropt, scopeopt) → {conbo.EventDispatcher}

Remove a listener for a particular event type
Parameters:
Name Type Attributes Description
type string <optional>
 Type of event ('change') or events ('change blur'), if not specified, all listeners will be removed
handler function <optional>
 Function that should be called, if not specified, all listeners of the specified type will be removed
scope Object <optional>
 Options object (recommended) or the scope in which to run the event handler (deprecated)
Inherited From:
Source:
Returns:
A reference to this class instance
Type
conbo.EventDispatcher

removeItem(keyName)

[Web Storage API] When passed a key name, will remove that key from the Hash (or set it to undefined if it cannot be deleted)
Parameters:
Name Type Description
keyName string
Inherited From:
Source:

setItem(keyName, keyValue)

[Web Storage API] When passed a key name and value, will add that key to the Hash, or update that key's value if it already exists
Parameters:
Name Type Description
keyName string
keyValue *
Inherited From:
Source:

toJSON() → {Object}

Returns a version of this object that can easily be converted into JSON
Inherited From:
Source:
Returns:
Type
Object

toString() → {string}

String representation of the current class
Overrides:
Source:
Returns:
Type
string