docs/api/Ext.data.proxy.LocalStorage.html

   1 <!DOCTYPE html><html><head><title>Ext.data.proxy.LocalStorage | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.data.proxy.LocalStorage',
  13         docClass: 'Ext.data.proxy.LocalStorage',
  14         docReq: 'Ext.data.proxy.LocalStorage',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'LocalStorage.html#Ext-data.proxy.LocalStorage';
  33     clsInfo = {"methods":["LocalStorage","addEvents","addListener","addManagedListener","batch","capture","clear","clearListeners","clearManagedListeners","enableBubble","fireEvent","getModel","getReader","getWriter","hasListener","observe","on","relayEvents","releaseCapture","removeListener","removeManagedListener","resumeEvents","setModel","setReader","setRecord","setWriter","suspendEvents","un"],"cfgs":["batchActions","batchOrder","id","listeners","model"],"properties":["cache","create","destroy","read","update"],"events":[],"subclasses":[]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/LocalStorage.html#Ext-data.proxy.LocalStorage" target="_blank">Ext.data.proxy.LocalStorage</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Hierarchy</h4><div class="subclass f"><a href="Ext.data.proxy.Proxy.html" rel="Ext.data.proxy.Proxy" class="cls docClass">Ext.data.proxy.Proxy</a><div class="subclass"><a href="Ext.data.proxy.Client.html" rel="Ext.data.proxy.Client" class="cls docClass">Ext.data.proxy.Client</a><div class="subclass"><a href="Ext.data.proxy.WebStorage.html" rel="Ext.data.proxy.WebStorage" class="cls docClass">Ext.data.proxy.WebStorage</a><div class="subclass"><strong>Ext.data.proxy.LocalStorage</strong></div></div></div></div><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>The LocalStorageProxy uses the new HTML5 localStorage API to save <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a> data locally on
  38 the client browser. HTML5 localStorage is a key-value store (e.g. cannot save complex objects like JSON), so
  39 LocalStorageProxy automatically serializes and deserializes data when saving and retrieving it.</p>
  40
  41
  42
  43
  44 <p>localStorage is extremely useful for saving user-specific information without needing to build server-side
  45 infrastructure to support it. Let's imagine we're writing a Twitter search application and want to save the user's
  46 searches locally so they can easily perform a saved search again later. We'd start by creating a Search model:</p>
  47
  48
  49
  50
  51 <pre class="prettyprint"><code>Ext.define('Search', {
  52     fields: ['id', 'query'],
  53     extend: 'Ext.data.Model',
  54     proxy: {
  55         type: 'localstorage',
  56         id  : 'twitter-Searches'
  57     }
  58 });
  59 </code></pre>
  60
  61
  62
  63
  64 <p>Our Search model contains just two fields - id and query - plus a Proxy definition. The only configuration we
  65 need to pass to the LocalStorage proxy is an <a href="Ext.data.proxy.LocalStorage.html#id" rel="Ext.data.proxy.LocalStorage#id" class="docClass">id</a>. This is important as it separates the Model data in this
  66 Proxy from all others. The localStorage API puts all data into a single shared namespace, so by setting an id we
  67 enable LocalStorageProxy to manage the saved Search data.</p>
  68
  69
  70
  71
  72 <p>Saving our data into localStorage is easy and would usually be done with a <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Store</a>:</p>
  73
  74
  75
  76
  77 <pre class="prettyprint"><code>//our Store automatically picks up the LocalStorageProxy defined on the Search model
  78 var store = new Ext.data.Store({
  79     model: "Search"
  80 });
  81
  82 //loads any existing Search data from localStorage
  83 store.load();
  84
  85 //now add some Searches
  86 store.add({query: 'Sencha Touch'});
  87 store.add({query: 'Ext JS'});
  88
  89 //finally, save our Search data to localStorage
  90 store.sync();
  91 </code></pre>
  92
  93
  94
  95
  96 <p>The LocalStorageProxy automatically gives our new Searches an id when we call store.sync(). It encodes the Model
  97 data and places it into localStorage. We can also save directly to localStorage, bypassing the Store altogether:</p>
  98
  99
 100
 101
 102 <pre class="prettyprint"><code>var search = Ext.ModelManager.create({query: 'Sencha Animator'}, 'Search');
 103
 104 //uses the configured LocalStorageProxy to save the new Search to localStorage
 105 search.save();
 106 </code></pre>
 107
 108
 109
 110
 111 <p><u>Limitations</u></p>
 112
 113
 114
 115
 116 <p>If this proxy is used in a browser where local storage is not supported, the constructor will throw an error.
 117 A local storage proxy requires a unique ID which is used as a key in which all record data are stored in the
 118 local storage object.</p>
 119
 120
 121
 122
 123 <p>It's important to supply this unique ID as it cannot be reliably determined otherwise. If no id is provided
 124 but the attached store has a storeId, the storeId will be used. If neither option is presented the proxy will
 125 throw an error.</p>
 126
 127 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-batchActions" class="member f inherited"><a href="Ext.data.proxy.LocalStorage.html#config-batchActions" rel="config-batchActions" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-cfg-batchActions" class="viewSource">view source</a></div><a name="batchActions"></a><a name="config-batchActions"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="config-batchActions" class="cls expand">batchActions</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to batch actions of a particular type when synchronizing the store.
 128 Defaults to <tt>true</tt>.</p>
 129 </div><div class="long"><p>True to batch actions of a particular type when synchronizing the store.
 130 Defaults to <tt>true</tt>.</p>
 131 </div></div></div><div id="config-batchOrder" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#config-batchOrder" rel="config-batchOrder" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-cfg-batchOrder" class="viewSource">view source</a></div><a name="batchOrder"></a><a name="config-batchOrder"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="config-batchOrder" class="cls expand">batchOrder</a><span> : String</span></div><div class="description"><div class="short">Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this
 132 to set a different ord...</div><div class="long"><p>Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this
 133 to set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy'</p>
 134 </div></div></div><div id="config-id" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#config-id" rel="config-id" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.WebStorage.html" class="definedIn docClass">Ext.data.proxy.WebStorage</a><br/><a href="../source/WebStorage.html#Ext-data.proxy.WebStorage-cfg-id" class="viewSource">view source</a></div><a name="id"></a><a name="config-id"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="config-id" class="cls expand">id</a><span> : String</span></div><div class="description"><div class="short"><p>The unique ID used as the key in which all record data are stored in the local storage object</p>
 135 </div><div class="long"><p>The unique ID used as the key in which all record data are stored in the local storage object</p>
 136 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
 137 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
 138 object during initialization.  This should be a valid listeners config object as specified in the
 139 <a href="Ext.data.proxy.LocalStorage.html#addListener" rel="Ext.data.proxy.LocalStorage#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
 140
 141 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
 142
 143
 144 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
 145
 146
 147 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
 148 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
 149 events directly from a child element of a Component, we need to specify the <code>element</code> option to
 150 identify the Component property to add a DOM listener to:</p>
 151
 152 <pre><code>new Ext.panel.Panel({
 153     width: 400,
 154     height: 200,
 155     dockedItems: [{
 156         xtype: 'toolbar'
 157     }],
 158     listeners: {
 159         click: {
 160             element: 'el', //bind to the underlying el property on the panel
 161             fn: function(){ console.log('click el'); }
 162         },
 163         dblclick: {
 164             element: 'body', //bind to the underlying body property on the panel
 165             fn: function(){ console.log('dblclick body'); }
 166         }
 167     }
 168 });
 169 </code></pre>
 170
 171
 172 <p></p></p>
 173 </div></div></div><div id="config-model" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#config-model" rel="config-model" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-cfg-model" class="viewSource">view source</a></div><a name="model"></a><a name="config-model"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="config-model" class="cls expand">model</a><span> : String/Ext.data.Model</span></div><div class="description"><div class="short">The name of the Model to tie to this Proxy. Can be either the string name of
 174 the Model, or a reference to the Model c...</div><div class="long"><p>The name of the Model to tie to this Proxy. Can be either the string name of
 175 the Model, or a reference to the Model constructor. Required.</p>
 176 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-cache" class="member f inherited"><a href="Ext.data.proxy.LocalStorage.html#property-cache" rel="property-cache" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.WebStorage.html" class="definedIn docClass">Ext.data.proxy.WebStorage</a><br/><a href="../source/WebStorage.html#Ext-data.proxy.WebStorage-property-cache" class="viewSource">view source</a></div><a name="cache"></a><a name="property-cache"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="property-cache" class="cls expand">cache</a><span> : Object</span></div><div class="description"><div class="short"><p>Cached map of records already retrieved by this Proxy - ensures that the same instance is always retrieved</p>
 177 </div><div class="long"><p>Cached map of records already retrieved by this Proxy - ensures that the same instance is always retrieved</p>
 178 </div></div></div><div id="property-create" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#property-create" rel="property-create" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-property-create" class="viewSource">view source</a></div><a name="create"></a><a name="property-create"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="property-create" class="cls expand">create</a><span> : Object</span></div><div class="description"><div class="short"><p>Performs the given create operation.</p>
 179 </div><div class="long"><p>Performs the given create operation.</p>
 180 </div></div></div><div id="property-destroy" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#property-destroy" rel="property-destroy" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-property-destroy" class="viewSource">view source</a></div><a name="destroy"></a><a name="property-destroy"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="property-destroy" class="cls expand">destroy</a><span> : Object</span></div><div class="description"><div class="short"><p>Performs the given destroy operation.</p>
 181 </div><div class="long"><p>Performs the given destroy operation.</p>
 182 </div></div></div><div id="property-read" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#property-read" rel="property-read" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-property-read" class="viewSource">view source</a></div><a name="read"></a><a name="property-read"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="property-read" class="cls expand">read</a><span> : Object</span></div><div class="description"><div class="short"><p>Performs the given read operation.</p>
 183 </div><div class="long"><p>Performs the given read operation.</p>
 184 </div></div></div><div id="property-update" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#property-update" rel="property-update" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-property-update" class="viewSource">view source</a></div><a name="update"></a><a name="property-update"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="property-update" class="cls expand">update</a><span> : Object</span></div><div class="description"><div class="short"><p>Performs the given update operation.</p>
 185 </div><div class="long"><p>Performs the given update operation.</p>
 186 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-LocalStorage" class="member f inherited"><a href="Ext.data.proxy.LocalStorage.html#method-LocalStorage" rel="method-LocalStorage" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.WebStorage.html" class="definedIn docClass">Ext.data.proxy.WebStorage</a><br/><a href="../source/WebStorage.html#Ext-data.proxy.WebStorage-method-constructor" class="viewSource">view source</a></div><a name="LocalStorage"></a><a name="method-LocalStorage"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-LocalStorage" class="cls expand">LocalStorage</a>(
 187 <span class="pre">Object config</span>)
 188  : void</div><div class="description"><div class="short"><p>Creates the proxy, throws an error if local storage is not supported in the current browser</p>
 189 </div><div class="long"><p>Creates the proxy, throws an error if local storage is not supported in the current browser</p>
 190 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Optional config object</p>
 191 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 192 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
 193 <span class="pre">Object/String o, String </span>)
 194  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
 195 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
 196 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
 197 or the first event name string if multiple event names are being passed as separate parameters.</p>
 198 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
 199 Usage:</p>
 200
 201 <pre><code>this.addEvents('storeloaded', 'storecleared');
 202 </code></pre>
 203
 204 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 205 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-addListener" class="cls expand">addListener</a>(
 206 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
 207  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
 208 </div><div class="long"><p>Appends an event handler to this object.</p>
 209 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
 210 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
 211 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 212 <b>If omitted, defaults to the object which fired the event.</b></p>
 213 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
 214 properties. This may contain any of the following properties:<ul>
 215 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 216 <b>If omitted, defaults to the object which fired the event.</b></div></li>
 217 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
 218 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
 219 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
 220 by the specified number of milliseconds. If the event fires again within that time, the original
 221 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
 222 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
 223 if the event was bubbled up from a child Observable.</div></li>
 224 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
 225 The name of a Component property which references an element to add a listener to.</p>
 226
 227 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
 228 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
 229 <pre><code>new Ext.panel.Panel({
 230     title: 'The title',
 231     listeners: {
 232         click: this.handlePanelClick,
 233         element: 'body'
 234     }
 235 });
 236 </code></pre></p>
 237
 238
 239 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
 240
 241
 242 <p></div></li>
 243 </ul><br></p>
 244
 245 <p>
 246 <b>Combining Options</b><br>
 247 Using the options argument, it is possible to combine different types of listeners:<br>
 248 <br>
 249 A delayed, one-time listener.
 250 <pre><code>myPanel.on('hide', this.handleClick, this, {
 251 single: true,
 252 delay: 100
 253 });</code></pre>
 254 <p>
 255 <b>Attaching multiple handlers in 1 call</b><br>
 256 The method also allows for a single argument to be passed which is a config object containing properties
 257 which specify multiple events. For example:
 258 <pre><code>myGridPanel.on({
 259     cellClick: this.onCellClick,
 260     mouseover: this.onMouseOver,
 261     mouseout: this.onMouseOut,
 262     scope: this // Important. Ensure "this" is correct during handler execution
 263 });
 264 </code></pre>.
 265 <p>
 266
 267 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 268 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
 269 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
 270  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
 271 is destroyed.
 272
 273 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
 274 is destroyed.
 275
 276 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
 277 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
 278 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 279 is the handler function.</p>
 280 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 281 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
 282 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 283 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
 284 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 285 </li></ul></div></div></div><div id="method-batch" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-batch" rel="method-batch" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-batch" class="viewSource">view source</a></div><a name="batch"></a><a name="method-batch"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-batch" class="cls expand">batch</a>(
 286 <span class="pre">Object operations, Object listeners</span>)
 287  : Ext.data.Batch</div><div class="description"><div class="short">Performs a batch of Operations, in the order specified by batchOrder. Used internally by
 288 Ext.data.Store's sync method...</div><div class="long"><p>Performs a batch of <a href="Ext.data.Operation.html" rel="Ext.data.Operation" class="docClass">Operations</a>, in the order specified by <a href="Ext.data.proxy.LocalStorage.html#batchOrder" rel="Ext.data.proxy.LocalStorage#batchOrder" class="docClass">batchOrder</a>. Used internally by
 289 <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">Ext.data.Store</a>'s <a href="Ext.data.Store.html#sync" rel="Ext.data.Store#sync" class="docClass">sync</a> method. Example usage:</p>
 290
 291 <pre><code>myProxy.batch({
 292     create : [myModel1, myModel2],
 293     update : [myModel3],
 294     destroy: [myModel4, myModel5]
 295 });
 296 </code></pre>
 297
 298
 299 <p>Where the myModel* above are <a href="Ext.data.Model.html" rel="Ext.data.Model" class="docClass">Model</a> instances - in this case 1 and 2 are new instances and have not been
 300 saved before, 3 has been saved previously but needs to be updated, and 4 and 5 have already been saved but should now be destroyed.</p>
 301 <h3 class="pa">Parameters</h3><ul><li><span class="pre">operations</span> : Object<div class="sub-desc"><p>Object containing the Model instances to act upon, keyed by action name</p>
 302 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>Optional listeners object passed straight through to the Batch - see <a href="Ext.data.Batch.html" rel="Ext.data.Batch" class="docClass">Ext.data.Batch</a></p>
 303 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Batch</span>&nbsp; &nbsp;<p>The newly created <a href="Ext.data.Batch.html" rel="Ext.data.Batch" class="docClass">Ext.data.Batch</a> object</p>
 304 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-capture" class="cls expand">capture</a>(
 305 <span class="pre">Observable o, Function fn, [Object scope]</span>)
 306  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
 307 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
 308 to the supplied function with the event name + standard signature of the event
 309 <b>before</b> the event is fired. If the supplied function returns false,
 310 the event will not fire.</p>
 311 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
 312 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
 313 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
 314 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 315 </li></ul></div></div></div><div id="method-clear" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-clear" rel="method-clear" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.WebStorage.html" class="definedIn docClass">Ext.data.proxy.WebStorage</a><br/><a href="../source/WebStorage.html#Ext-data.proxy.WebStorage-method-clear" class="viewSource">view source</a></div><a name="clear"></a><a name="method-clear"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-clear" class="cls expand">clear</a> : void</div><div class="description"><div class="short">Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage o...</div><div class="long"><p>Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage object</p>
 316 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 317 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
 318 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
 319 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 320 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
 321 </div><div class="long"><p>Removes all managed listeners for this object.</p>
 322 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 323 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
 324 <span class="pre">String/Array events</span>)
 325  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
 326 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
 327 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
 328
 329
 330 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
 331 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
 332 access the required target more quickly.</p>
 333
 334
 335 <p>Example:</p>
 336
 337
 338 <pre><code>Ext.override(Ext.form.field.Base, {
 339 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
 340 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
 341     this.enableBubble('change');
 342 }),
 343
 344 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
 345 getBubbleTarget : function() {
 346     if (!this.formPanel) {
 347         this.formPanel = this.findParentByType('form');
 348     }
 349     return this.formPanel;
 350 }
 351 });
 352
 353 var myForm = new Ext.formPanel({
 354 title: 'User Details',
 355 items: [{
 356     ...
 357 }],
 358 listeners: {
 359     change: function() {
 360         // Title goes red if form has been modified.
 361         myForm.header.setStyle('color', 'red');
 362     }
 363 }
 364 });
 365 </code></pre>
 366
 367 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
 368 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 369 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
 370 <span class="pre">String eventName, Object... args</span>)
 371  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
 372
 373
 374 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
 375
 376
 377 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
 378 by calling <a href="Ext.data.proxy.LocalStorage.html#enableBubble" rel="Ext.data.proxy.LocalStorage#enableBubble" class="docClass">enableBubble</a>.</p>
 379
 380 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
 381 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
 382 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
 383 </li></ul></div></div></div><div id="method-getModel" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-getModel" rel="method-getModel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-getModel" class="viewSource">view source</a></div><a name="getModel"></a><a name="method-getModel"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-getModel" class="cls expand">getModel</a> : Ext.data.Model</div><div class="description"><div class="short"><p>Returns the model attached to this Proxy</p>
 384 </div><div class="long"><p>Returns the model attached to this Proxy</p>
 385 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Model</span>&nbsp; &nbsp;<p>The model</p>
 386 </li></ul></div></div></div><div id="method-getReader" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-getReader" rel="method-getReader" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-getReader" class="viewSource">view source</a></div><a name="getReader"></a><a name="method-getReader"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-getReader" class="cls expand">getReader</a> : Ext.data.reader.Reader</div><div class="description"><div class="short"><p>Returns the reader currently attached to this proxy instance</p>
 387 </div><div class="long"><p>Returns the reader currently attached to this proxy instance</p>
 388 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.reader.Reader</span>&nbsp; &nbsp;<p>The Reader instance</p>
 389 </li></ul></div></div></div><div id="method-getWriter" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-getWriter" rel="method-getWriter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-getWriter" class="viewSource">view source</a></div><a name="getWriter"></a><a name="method-getWriter"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-getWriter" class="cls expand">getWriter</a> : Ext.data.writer.Writer</div><div class="description"><div class="short"><p>Returns the writer currently attached to this proxy instance</p>
 390 </div><div class="long"><p>Returns the writer currently attached to this proxy instance</p>
 391 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.writer.Writer</span>&nbsp; &nbsp;<p>The Writer instance</p>
 392 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
 393 <span class="pre">String eventName</span>)
 394  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
 395 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
 396 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
 397 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
 398 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-observe" class="cls expand">observe</a>(
 399 <span class="pre">Function c, Object listeners</span>)
 400  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
 401
 402 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
 403
 404 <p>This makes any event fired on any instance of the passed class also fire a single event through
 405 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
 406
 407 <p>Usage:</p>
 408
 409 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
 410 Ext.data.Connection.on('beforerequest', function(con, options) {
 411     console.log('Ajax request made to ' + options.url);
 412 });
 413 </code></pre>
 414 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
 415 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.data.proxy.LocalStorage.html#addListener" rel="Ext.data.proxy.LocalStorage#addListener" class="docClass">addListener</a>.</p>
 416 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 417 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-on" class="cls expand">on</a>(
 418 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
 419  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.proxy.LocalStorage.html#addListener" rel="Ext.data.proxy.LocalStorage#addListener" class="docClass">addListener</a>.)</p>
 420 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.proxy.LocalStorage.html#addListener" rel="Ext.data.proxy.LocalStorage#addListener" class="docClass">addListener</a>.)</p>
 421 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
 422 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
 423 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 424 <b>If omitted, defaults to the object which fired the event.</b></p>
 425 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
 426 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 427 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
 428 <span class="pre">Object origin, Array events, Object prefix</span>)
 429  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
 430 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
 431 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
 432 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
 433 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
 434 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 435 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
 436 <span class="pre">Observable o</span>)
 437  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
 438 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
 439 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
 440 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 441 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
 442 <span class="pre">String eventName, Function handler, [Object scope]</span>)
 443  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
 444 </div><div class="long"><p>Removes an event handler.</p>
 445 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
 446 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.proxy.LocalStorage.html#addListener" rel="Ext.data.proxy.LocalStorage#addListener" class="docClass">addListener</a> call.</b></p>
 447 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
 448 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 449 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
 450 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
 451  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.data.proxy.LocalStorage.html#mon" rel="Ext.data.proxy.LocalStorage#mon" class="docClass">mon</a> method.</p>
 452 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.data.proxy.LocalStorage.html#mon" rel="Ext.data.proxy.LocalStorage#mon" class="docClass">mon</a> method.</p>
 453 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
 454 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
 455 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 456 is the handler function.</p>
 457 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 458 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
 459 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 460 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
 461 If events were suspended using the queueSuspended parameter, then all
 462 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.data.proxy.LocalStorage.html#suspendEvents" rel="Ext.data.proxy.LocalStorage#suspendEvents" class="docClass">suspendEvents</a>)
 463 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
 464 events fired during event suspension will be sent to any listeners now.</p>
 465 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 466 </li></ul></div></div></div><div id="method-setModel" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-setModel" rel="method-setModel" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-setModel" class="viewSource">view source</a></div><a name="setModel"></a><a name="method-setModel"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-setModel" class="cls expand">setModel</a>(
 467 <span class="pre">String|Ext.data.Model model, Boolean setOnStore</span>)
 468  : void</div><div class="description"><div class="short"><p>Sets the model associated with this proxy. This will only usually be called by a Store</p>
 469 </div><div class="long"><p>Sets the model associated with this proxy. This will only usually be called by a Store</p>
 470 <h3 class="pa">Parameters</h3><ul><li><span class="pre">model</span> : String|Ext.data.Model<div class="sub-desc"><p>The new model. Can be either the model name string,
 471 or a reference to the model's constructor</p>
 472 </div></li><li><span class="pre">setOnStore</span> : Boolean<div class="sub-desc"><p>Sets the new model on the associated Store, if one is present</p>
 473 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 474 </li></ul></div></div></div><div id="method-setReader" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-setReader" rel="method-setReader" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-setReader" class="viewSource">view source</a></div><a name="setReader"></a><a name="method-setReader"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-setReader" class="cls expand">setReader</a>(
 475 <span class="pre">String|Object|Ext.data.reader.Reader reader</span>)
 476  : Ext.data.reader.Reader</div><div class="description"><div class="short"><p>Sets the Proxy's Reader by string, config object or Reader instance</p>
 477 </div><div class="long"><p>Sets the Proxy's Reader by string, config object or Reader instance</p>
 478 <h3 class="pa">Parameters</h3><ul><li><span class="pre">reader</span> : String|Object|Ext.data.reader.Reader<div class="sub-desc"><p>The new Reader, which can be either a type string, a configuration object
 479 or an <a href="Ext.data.reader.Reader.html" rel="Ext.data.reader.Reader" class="docClass">Ext.data.reader.Reader</a> instance</p>
 480 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.reader.Reader</span>&nbsp; &nbsp;<p>The attached Reader object</p>
 481 </li></ul></div></div></div><div id="method-setRecord" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-setRecord" rel="method-setRecord" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.WebStorage.html" class="definedIn docClass">Ext.data.proxy.WebStorage</a><br/><a href="../source/WebStorage.html#Ext-data.proxy.WebStorage-method-setRecord" class="viewSource">view source</a></div><a name="setRecord"></a><a name="method-setRecord"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-setRecord" class="cls expand">setRecord</a>(
 482 <span class="pre">Ext.data.Model record, String id</span>)
 483  : void</div><div class="description"><div class="short"><p>Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data</p>
 484 </div><div class="long"><p>Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data</p>
 485 <h3 class="pa">Parameters</h3><ul><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The model instance</p>
 486 </div></li><li><span class="pre">id</span> : String<div class="sub-desc"><p>The id to save the record under (defaults to the value of the record's getId() function)</p>
 487 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 488 </li></ul></div></div></div><div id="method-setWriter" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-setWriter" rel="method-setWriter" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.proxy.Proxy.html" class="definedIn docClass">Ext.data.proxy.Proxy</a><br/><a href="../source/Proxy2.html#Ext-data.proxy.Proxy-method-setWriter" class="viewSource">view source</a></div><a name="setWriter"></a><a name="method-setWriter"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-setWriter" class="cls expand">setWriter</a>(
 489 <span class="pre">String|Object|Ext.data.writer.Writer writer</span>)
 490  : Ext.data.writer.Writer</div><div class="description"><div class="short"><p>Sets the Proxy's Writer by string, config object or Writer instance</p>
 491 </div><div class="long"><p>Sets the Proxy's Writer by string, config object or Writer instance</p>
 492 <h3 class="pa">Parameters</h3><ul><li><span class="pre">writer</span> : String|Object|Ext.data.writer.Writer<div class="sub-desc"><p>The new Writer, which can be either a type string, a configuration object
 493 or an <a href="Ext.data.writer.Writer.html" rel="Ext.data.writer.Writer" class="docClass">Ext.data.writer.Writer</a> instance</p>
 494 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.writer.Writer</span>&nbsp; &nbsp;<p>The attached Writer object</p>
 495 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
 496 <span class="pre">Boolean queueSuspended</span>)
 497  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.data.proxy.LocalStorage.html#resumeEvents" rel="Ext.data.proxy.LocalStorage#resumeEvents" class="docClass">resumeEvents</a>)</p>
 498 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.data.proxy.LocalStorage.html#resumeEvents" rel="Ext.data.proxy.LocalStorage#resumeEvents" class="docClass">resumeEvents</a>)</p>
 499 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
 500 after the <a href="Ext.data.proxy.LocalStorage.html#resumeEvents" rel="Ext.data.proxy.LocalStorage#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
 501 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 502 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.data.proxy.LocalStorage.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.data.proxy.LocalStorage.html#" rel="method-un" class="cls expand">un</a>(
 503 <span class="pre">String eventName, Function handler, [Object scope]</span>)
 504  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.data.proxy.LocalStorage.html#removeListener" rel="Ext.data.proxy.LocalStorage#removeListener" class="docClass">removeListener</a>.)</p>
 505 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.data.proxy.LocalStorage.html#removeListener" rel="Ext.data.proxy.LocalStorage#removeListener" class="docClass">removeListener</a>.)</p>
 506 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
 507 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.proxy.LocalStorage.html#addListener" rel="Ext.data.proxy.LocalStorage#addListener" class="docClass">addListener</a> call.</b></p>
 508 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
 509 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 510 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>