com.sencha.gxt.data.client.loader

Class StorageReadProxy<C>

java.lang.Object

com.sencha.gxt.data.client.loader.StorageReadProxy<C>

Type Parameters:

C - the type of load configuration

All Implemented Interfaces:

DataProxy<C,String>

public class StorageReadProxy<C>
extends Object
implements DataProxy<C,String>

A DataProxy that retrieves data from HTML5 browser based storage.

Constructor Summary

Constructors

Constructor and Description
StorageReadProxy(boolean session) Creates a storage read proxy that retrieves data from HTML5 browser based storage.
StorageReadProxy(Storage storage) Creates a storage read proxy that retrieves data from the given HTML5 browser based storage.

Method Summary

Modifier and Type	Method and Description
protected String	getKeyFromConfig(C loadConfig) Generates a storage key from the given load config.
DataWriter<C,String>	getWriter()
void	load(C loadConfig, <any> callback) Data should be retrieved using the specified load config.
void	save(C saveConfig, String data) Save a value in the HTML5 browser based storage.
void	setWriter(DataWriter<C,String> writer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StorageReadProxy

public StorageReadProxy(boolean session)

Creates a storage read proxy that retrieves data from HTML5 browser based storage.

Parameters:

session - true to use session storage, false to use local storage

StorageReadProxy

public StorageReadProxy(Storage storage)

Creates a storage read proxy that retrieves data from the given HTML5 browser based storage.

Parameters:

storage - the browser based storage

Method Detail

getWriter

public DataWriter<C,String> getWriter()

setWriter

public void setWriter(DataWriter<C,String> writer)

load

public void load(C loadConfig,
                 <any> callback)

Description copied from interface: DataProxy

Data should be retrieved using the specified load config. When specified, the DataReader can be used to "process" the raw data.

Specified by:

load in interface DataProxy<C,String>

Parameters:

loadConfig - the load config object to be passed to server

callback - the data callback

save

public void save(C saveConfig,
                 String data)

Save a value in the HTML5 browser based storage.

Parameters:

saveConfig - provides the source of the storage key (see getKeyFromConfig(Object)).

data - the value to save, associated with saveConfig

getKeyFromConfig

protected String getKeyFromConfig(C loadConfig)

Generates a storage key from the given load config. By default, this is the value returned by the load config's toString method.

Parameters:

loadConfig - the load config

Returns:

the key that associates load config with its storage