Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / SessionStorage.html
index e0274f0..a68c6e6 100644 (file)
@@ -3,8 +3,8 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
-  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
-  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
 <body onload="prettyPrint(); highlight();">
   <pre class="prettyprint lang-js"><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
+ *
+ * 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.
+ *
+ * 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.
+ *
+ * Proxies are almost always used with a {@link Ext.data.Store store}:
+ *
+ *     new Ext.data.Store({
+ *         proxy: {
+ *             type: 'sessionstorage',
+ *             id  : 'myProxyKey'
+ *         }
+ *     });
+ *
+ * Alternatively you can instantiate the Proxy directly:
+ *
+ *     new Ext.data.proxy.SessionStorage({
+ *         id  : 'myOtherProxyKey'
+ *     });
+ *
+ * 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;
+ * don't affect the {@link Ext.data.proxy.LocalStorage} - the data are preserved.
  */
 Ext.define('Ext.data.proxy.SessionStorage', {
     extend: 'Ext.data.proxy.WebStorage',