Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / docs / api / Ext.data.proxy.SessionStorage.html
1 <!DOCTYPE html><html><head><title>Ext.data.proxy.SessionStorage | 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.SessionStorage',
13         docClass: 'Ext.data.proxy.SessionStorage',
14         docReq: 'Ext.data.proxy.SessionStorage',
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 = 'SessionStorage.html#Ext-data.proxy.SessionStorage';
33     clsInfo = {"methods":["SessionStorage","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/SessionStorage.html#Ext-data.proxy.SessionStorage" target="_blank">Ext.data.proxy.SessionStorage</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.SessionStorage</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>Proxy which uses HTML5 session storage as its data storage/retrieval mechanism.
38 If this proxy is used in a browser where session storage is not supported, the constructor will throw an error.
39 A session storage proxy requires a unique ID which is used as a key in which all record data are stored in the
40 session storage object.</p>
41
42
43
44
45 <p>It's important to supply this unique ID as it cannot be reliably determined otherwise. If no id is provided
46 but the attached store has a storeId, the storeId will be used. If neither option is presented the proxy will
47 throw an error.</p>
48
49
50
51
52 <p>Proxies are almost always used with a <a href="Ext.data.Store.html" rel="Ext.data.Store" class="docClass">store</a>:<p>
53
54 <pre class="prettyprint"><code>new Ext.data.Store({
55     proxy: {
56         type: 'sessionstorage',
57         id  : 'myProxyKey'
58     }
59 });
60 </code></pre>
61
62 <p>Alternatively you can instantiate the Proxy directly:</p>
63
64 <pre class="prettyprint"><code>new Ext.data.proxy.SessionStorage({
65     id  : 'myOtherProxyKey'
66 });
67  </code></pre>
68
69 <p>Note that session storage is different to local storage (see <a href="Ext.data.proxy.LocalStorage.html" rel="Ext.data.proxy.LocalStorage" class="docClass">Ext.data.proxy.LocalStorage</a>) - if a browser
70 session is ended (e.g. by closing the browser) then all data in a SessionStorageProxy are lost. Browser restarts
71 don't affect the <a href="Ext.data.proxy.LocalStorage.html" rel="Ext.data.proxy.LocalStorage" class="docClass">Ext.data.proxy.LocalStorage</a> - the data are preserved.</p>
72
73 <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.SessionStorage.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.SessionStorage.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.
74 Defaults to <tt>true</tt>.</p>
75 </div><div class="long"><p>True to batch actions of a particular type when synchronizing the store.
76 Defaults to <tt>true</tt>.</p>
77 </div></div></div><div id="config-batchOrder" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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
78 to set a different ord...</div><div class="long"><p>Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this
79 to set a different order for the batched CRUD actions to be executed in. Defaults to 'create,update,destroy'</p>
80 </div></div></div><div id="config-id" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
81 </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>
82 </div></div></div><div id="config-listeners" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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
83 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
84 object during initialization.  This should be a valid listeners config object as specified in the
85 <a href="Ext.data.proxy.SessionStorage.html#addListener" rel="Ext.data.proxy.SessionStorage#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
86
87 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
88
89
90 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
91
92
93 <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
94 <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
95 events directly from a child element of a Component, we need to specify the <code>element</code> option to
96 identify the Component property to add a DOM listener to:</p>
97
98 <pre><code>new Ext.panel.Panel({
99     width: 400,
100     height: 200,
101     dockedItems: [{
102         xtype: 'toolbar'
103     }],
104     listeners: {
105         click: {
106             element: 'el', //bind to the underlying el property on the panel
107             fn: function(){ console.log('click el'); }
108         },
109         dblclick: {
110             element: 'body', //bind to the underlying body property on the panel
111             fn: function(){ console.log('dblclick body'); }
112         }
113     }
114 });
115 </code></pre>
116
117
118 <p></p></p>
119 </div></div></div><div id="config-model" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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
120 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
121 the Model, or a reference to the Model constructor. Required.</p>
122 </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.SessionStorage.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.SessionStorage.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>
123 </div><div class="long"><p>Cached map of records already retrieved by this Proxy - ensures that the same instance is always retrieved</p>
124 </div></div></div><div id="property-create" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
125 </div><div class="long"><p>Performs the given create operation.</p>
126 </div></div></div><div id="property-destroy" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
127 </div><div class="long"><p>Performs the given destroy operation.</p>
128 </div></div></div><div id="property-read" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
129 </div><div class="long"><p>Performs the given read operation.</p>
130 </div></div></div><div id="property-update" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
131 </div><div class="long"><p>Performs the given update operation.</p>
132 </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-SessionStorage" class="member f inherited"><a href="Ext.data.proxy.SessionStorage.html#method-SessionStorage" rel="method-SessionStorage" 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="SessionStorage"></a><a name="method-SessionStorage"></a><a href="Ext.data.proxy.SessionStorage.html#" rel="method-SessionStorage" class="cls expand">SessionStorage</a>(
133 <span class="pre">Object config</span>)
134  : 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>
135 </div><div class="long"><p>Creates the proxy, throws an error if local storage is not supported in the current browser</p>
136 <h3 class="pa">Parameters</h3><ul><li><span class="pre">config</span> : Object<div class="sub-desc"><p>Optional config object</p>
137 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
138 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
139 <span class="pre">Object/String o, String </span>)
140  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
141 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
142 <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>
143 or the first event name string if multiple event names are being passed as separate parameters.</p>
144 </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.
145 Usage:</p>
146
147 <pre><code>this.addEvents('storeloaded', 'storecleared');
148 </code></pre>
149
150 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
151 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-addListener" class="cls expand">addListener</a>(
152 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
153  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
154 </div><div class="long"><p>Appends an event handler to this object.</p>
155 <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>
156 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
157 </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.
158 <b>If omitted, defaults to the object which fired the event.</b></p>
159 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
160 properties. This may contain any of the following properties:<ul>
161 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
162 <b>If omitted, defaults to the object which fired the event.</b></div></li>
163 <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>
164 <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>
165 <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
166 by the specified number of milliseconds. If the event fires again within that time, the original
167 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
168 <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>
169 if the event was bubbled up from a child Observable.</div></li>
170 <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>
171 The name of a Component property which references an element to add a listener to.</p>
172
173 <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
174 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
175 <pre><code>new Ext.panel.Panel({
176     title: 'The title',
177     listeners: {
178         click: this.handlePanelClick,
179         element: 'body'
180     }
181 });
182 </code></pre></p>
183
184
185 <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>
186
187
188 <p></div></li>
189 </ul><br></p>
190
191 <p>
192 <b>Combining Options</b><br>
193 Using the options argument, it is possible to combine different types of listeners:<br>
194 <br>
195 A delayed, one-time listener.
196 <pre><code>myPanel.on('hide', this.handleClick, this, {
197 single: true,
198 delay: 100
199 });</code></pre>
200 <p>
201 <b>Attaching multiple handlers in 1 call</b><br>
202 The method also allows for a single argument to be passed which is a config object containing properties
203 which specify multiple events. For example:
204 <pre><code>myGridPanel.on({
205     cellClick: this.onCellClick,
206     mouseover: this.onMouseOver,
207     mouseout: this.onMouseOut,
208     scope: this // Important. Ensure "this" is correct during handler execution
209 });
210 </code></pre>.
211 <p>
212
213 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
214 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
215 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
216  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
217 is destroyed.
218
219 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
220 is destroyed.
221
222 <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>
223 </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>
224 </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
225 is the handler function.</p>
226 </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
227 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
228 </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
229 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
230 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
231 </li></ul></div></div></div><div id="method-batch" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-batch" class="cls expand">batch</a>(
232 <span class="pre">Object operations, Object listeners</span>)
233  : Ext.data.Batch</div><div class="description"><div class="short">Performs a batch of Operations, in the order specified by batchOrder. Used internally by
234 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.SessionStorage.html#batchOrder" rel="Ext.data.proxy.SessionStorage#batchOrder" class="docClass">batchOrder</a>. Used internally by
235 <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>
236
237 <pre><code>myProxy.batch({
238     create : [myModel1, myModel2],
239     update : [myModel3],
240     destroy: [myModel4, myModel5]
241 });
242 </code></pre>
243
244
245 <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
246 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>
247 <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>
248 </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>
249 </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>
250 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-capture" class="cls expand">capture</a>(
251 <span class="pre">Observable o, Function fn, [Object scope]</span>)
252  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
253 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
254 to the supplied function with the event name + standard signature of the event
255 <b>before</b> the event is fired. If the supplied function returns false,
256 the event will not fire.</p>
257 <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>
258 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
259 </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>
260 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
261 </li></ul></div></div></div><div id="method-clear" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
262 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
263 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
264 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
265 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
266 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
267 </div><div class="long"><p>Removes all managed listeners for this object.</p>
268 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
269 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
270 <span class="pre">String/Array events</span>)
271  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
272 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
273 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
274
275
276 <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
277 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
278 access the required target more quickly.</p>
279
280
281 <p>Example:</p>
282
283
284 <pre><code>Ext.override(Ext.form.field.Base, {
285 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
286 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
287     this.enableBubble('change');
288 }),
289
290 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
291 getBubbleTarget : function() {
292     if (!this.formPanel) {
293         this.formPanel = this.findParentByType('form');
294     }
295     return this.formPanel;
296 }
297 });
298
299 var myForm = new Ext.formPanel({
300 title: 'User Details',
301 items: [{
302     ...
303 }],
304 listeners: {
305     change: function() {
306         // Title goes red if form has been modified.
307         myForm.header.setStyle('color', 'red');
308     }
309 }
310 });
311 </code></pre>
312
313 <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>
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-fireEvent" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
316 <span class="pre">String eventName, Object... args</span>)
317  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
318
319
320 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>
321
322
323 <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>)
324 by calling <a href="Ext.data.proxy.SessionStorage.html#enableBubble" rel="Ext.data.proxy.SessionStorage#enableBubble" class="docClass">enableBubble</a>.</p>
325
326 <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>
327 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
328 </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>
329 </li></ul></div></div></div><div id="method-getModel" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
330 </div><div class="long"><p>Returns the model attached to this Proxy</p>
331 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.Model</span>&nbsp; &nbsp;<p>The model</p>
332 </li></ul></div></div></div><div id="method-getReader" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
333 </div><div class="long"><p>Returns the reader currently attached to this proxy instance</p>
334 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.reader.Reader</span>&nbsp; &nbsp;<p>The Reader instance</p>
335 </li></ul></div></div></div><div id="method-getWriter" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.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>
336 </div><div class="long"><p>Returns the writer currently attached to this proxy instance</p>
337 <h3 class="pa">Returns</h3><ul><li><span class="pre">Ext.data.writer.Writer</span>&nbsp; &nbsp;<p>The Writer instance</p>
338 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
339 <span class="pre">String eventName</span>)
340  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
341 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
342 <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>
343 </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>
344 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-observe" class="cls expand">observe</a>(
345 <span class="pre">Function c, Object listeners</span>)
346  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
347
348 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>
349
350 <p>This makes any event fired on any instance of the passed class also fire a single event through
351 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
352
353 <p>Usage:</p>
354
355 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
356 Ext.data.Connection.on('beforerequest', function(con, options) {
357     console.log('Ajax request made to ' + options.url);
358 });
359 </code></pre>
360 <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>
361 </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.SessionStorage.html#addListener" rel="Ext.data.proxy.SessionStorage#addListener" class="docClass">addListener</a>.</p>
362 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
363 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-on" class="cls expand">on</a>(
364 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
365  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.proxy.SessionStorage.html#addListener" rel="Ext.data.proxy.SessionStorage#addListener" class="docClass">addListener</a>.)</p>
366 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.proxy.SessionStorage.html#addListener" rel="Ext.data.proxy.SessionStorage#addListener" class="docClass">addListener</a>.)</p>
367 <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>
368 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
369 </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.
370 <b>If omitted, defaults to the object which fired the event.</b></p>
371 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
372 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
373 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
374 <span class="pre">Object origin, Array events, Object prefix</span>)
375  : 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>
376 </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>
377 <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>
378 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
379 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
380 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
381 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
382 <span class="pre">Observable o</span>)
383  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
384 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
385 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
386 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
387 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
388 <span class="pre">String eventName, Function handler, [Object scope]</span>)
389  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
390 </div><div class="long"><p>Removes an event handler.</p>
391 <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>
392 </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.SessionStorage.html#addListener" rel="Ext.data.proxy.SessionStorage#addListener" class="docClass">addListener</a> call.</b></p>
393 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
394 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
395 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
396 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
397  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.data.proxy.SessionStorage.html#mon" rel="Ext.data.proxy.SessionStorage#mon" class="docClass">mon</a> method.</p>
398 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.data.proxy.SessionStorage.html#mon" rel="Ext.data.proxy.SessionStorage#mon" class="docClass">mon</a> method.</p>
399 <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>
400 </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>
401 </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
402 is the handler function.</p>
403 </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
404 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
405 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
406 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
407 If events were suspended using the queueSuspended parameter, then all
408 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.data.proxy.SessionStorage.html#suspendEvents" rel="Ext.data.proxy.SessionStorage#suspendEvents" class="docClass">suspendEvents</a>)
409 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
410 events fired during event suspension will be sent to any listeners now.</p>
411 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
412 </li></ul></div></div></div><div id="method-setModel" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-setModel" class="cls expand">setModel</a>(
413 <span class="pre">String|Ext.data.Model model, Boolean setOnStore</span>)
414  : 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>
415 </div><div class="long"><p>Sets the model associated with this proxy. This will only usually be called by a Store</p>
416 <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,
417 or a reference to the model's constructor</p>
418 </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>
419 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
420 </li></ul></div></div></div><div id="method-setReader" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-setReader" class="cls expand">setReader</a>(
421 <span class="pre">String|Object|Ext.data.reader.Reader reader</span>)
422  : 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>
423 </div><div class="long"><p>Sets the Proxy's Reader by string, config object or Reader instance</p>
424 <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
425 or an <a href="Ext.data.reader.Reader.html" rel="Ext.data.reader.Reader" class="docClass">Ext.data.reader.Reader</a> instance</p>
426 </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>
427 </li></ul></div></div></div><div id="method-setRecord" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-setRecord" class="cls expand">setRecord</a>(
428 <span class="pre">Ext.data.Model record, String id</span>)
429  : 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>
430 </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>
431 <h3 class="pa">Parameters</h3><ul><li><span class="pre">record</span> : Ext.data.Model<div class="sub-desc"><p>The model instance</p>
432 </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>
433 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
434 </li></ul></div></div></div><div id="method-setWriter" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-setWriter" class="cls expand">setWriter</a>(
435 <span class="pre">String|Object|Ext.data.writer.Writer writer</span>)
436  : 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>
437 </div><div class="long"><p>Sets the Proxy's Writer by string, config object or Writer instance</p>
438 <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
439 or an <a href="Ext.data.writer.Writer.html" rel="Ext.data.writer.Writer" class="docClass">Ext.data.writer.Writer</a> instance</p>
440 </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>
441 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
442 <span class="pre">Boolean queueSuspended</span>)
443  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.data.proxy.SessionStorage.html#resumeEvents" rel="Ext.data.proxy.SessionStorage#resumeEvents" class="docClass">resumeEvents</a>)</p>
444 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.data.proxy.SessionStorage.html#resumeEvents" rel="Ext.data.proxy.SessionStorage#resumeEvents" class="docClass">resumeEvents</a>)</p>
445 <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
446 after the <a href="Ext.data.proxy.SessionStorage.html#resumeEvents" rel="Ext.data.proxy.SessionStorage#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
447 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
448 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.data.proxy.SessionStorage.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.SessionStorage.html#" rel="method-un" class="cls expand">un</a>(
449 <span class="pre">String eventName, Function handler, [Object scope]</span>)
450  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.data.proxy.SessionStorage.html#removeListener" rel="Ext.data.proxy.SessionStorage#removeListener" class="docClass">removeListener</a>.)</p>
451 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.data.proxy.SessionStorage.html#removeListener" rel="Ext.data.proxy.SessionStorage#removeListener" class="docClass">removeListener</a>.)</p>
452 <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>
453 </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.SessionStorage.html#addListener" rel="Ext.data.proxy.SessionStorage#addListener" class="docClass">addListener</a> call.</b></p>
454 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
455 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
456 </li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>