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