Upgrade to ExtJS 4.0.0 - Released 04/26/2011

[extjs.git] / docs / source / SessionStorage.html
diff --git a/docs/source/SessionStorage.html b/docs/source/SessionStorage.html

new file mode 100644 (file)

index 0000000..9434b70
--- /dev/null
+++ b/docs/source/SessionStorage.html
@@ -0,0 +1,48 @@
+<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-data.proxy.SessionStorage'>/**
+</span> * @author Ed Spencer
+ * @class Ext.data.proxy.SessionStorage
+ * @extends Ext.data.proxy.WebStorage
+ * 
+ * &lt;p&gt;Proxy which uses HTML5 session storage as its data storage/retrieval mechanism.
+ * If this proxy is used in a browser where session storage is not supported, the constructor will throw an error.
+ * A session storage proxy requires a unique ID which is used as a key in which all record data are stored in the
+ * session storage object.&lt;/p&gt;
+ * 
+ * &lt;p&gt;It's important to supply this unique ID as it cannot be reliably determined otherwise. If no id is provided
+ * but the attached store has a storeId, the storeId will be used. If neither option is presented the proxy will
+ * throw an error.&lt;/p&gt;
+ * 
+ * &lt;p&gt;Proxies are almost always used with a {@link Ext.data.Store store}:&lt;p&gt;
+ * 
+&lt;pre&gt;&lt;code&gt;
+new Ext.data.Store({
+    proxy: {
+        type: 'sessionstorage',
+        id  : 'myProxyKey'
+    }
+});
+&lt;/code&gt;&lt;/pre&gt;
+ * 
+ * &lt;p&gt;Alternatively you can instantiate the Proxy directly:&lt;/p&gt;
+ * 
+&lt;pre&gt;&lt;code&gt;
+new Ext.data.proxy.SessionStorage({
+    id  : 'myOtherProxyKey'
+});
+ &lt;/code&gt;&lt;/pre&gt;
+ * 
+ * &lt;p&gt;Note that session storage is different to local storage (see {@link Ext.data.proxy.LocalStorage}) - if a browser
+ * session is ended (e.g. by closing the browser) then all data in a SessionStorageProxy are lost. Browser restarts
+ * don't affect the {@link Ext.data.proxy.LocalStorage} - the data are preserved.&lt;/p&gt;
+ */
+Ext.define('Ext.data.proxy.SessionStorage', {
+    extend: 'Ext.data.proxy.WebStorage',
+    alias: 'proxy.sessionstorage',
+    alternateClassName: 'Ext.data.SessionStorageProxy',
+    
+    //inherit docs
+    getStorageObject: function() {
+        return window.sessionStorage;
+    }
+});
+</pre></pre></body></html>
+\ No newline at end of file