Class Index | File Index

Classes


Class R.storage.AbstractStorage


Extends R.engine.PooledObject.
R.storage.AbstractStorage is the base class of all storage objects.
Defined in: abstractstorage.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
This base class is considered abstract and should not be instantiated directly.
Method Summary
Method Attributes Method Name and Description
 
Destroy the object, cleaning up any events that have been attached to this object.
 
[ABSTRACT] Finalize any pending storage requests.
 
Get the class name of this object
 
Get the storage object
 
[ABSTRACT] Initialize the storage object which holds the data
 
[ABSTRACT] Load data from the storage object.
 
Release the object back into the object pool.
 
saveData(data)
[ABSTRACT] Save the data to the storage object
 
setStorageObject(storageObject)
Set the storage object
Methods borrowed from class R.engine.PooledObject:
clearObjectDataModel, getId, getName, getObjectDataModel, getProperties, isDestroyed, setName, setObjectDataModel, toString, toXML
Class Detail
R.storage.AbstractStorage(name)
This base class is considered abstract and should not be instantiated directly. See R.storage.TransientStorage, R.storage.PersistentStorage, or R.storage.IndexedStorage for implementations.
Parameters:
name
{String} The name of the object
Method Detail
destroy()
Destroy the object, cleaning up any events that have been attached to this object.

flush()
[ABSTRACT] Finalize any pending storage requests.

{String} getClassName()
Get the class name of this object
Defined in: abstractdbstorage.js.
Returns:
{String} "R.storage.AbstractStorage"

{Object} getStorageObject()
Get the storage object
Returns:
{Object} The DOM object being used to store data

{Object} initStorageObject()
[ABSTRACT] Initialize the storage object which holds the data
Returns:
{Object} The storage object

loadData()
[ABSTRACT] Load data from the storage object.

release()
Release the object back into the object pool.

saveData(data)
[ABSTRACT] Save the data to the storage object
Parameters:
data

setStorageObject(storageObject)
Set the storage object
Parameters:
storageObject
{Object} The DOM object to use to store data

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Mar 18 2013 16:09:20 GMT-0400 (EDT)