1 <div xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif"><a href="output/Ext.data.DataProxy.html" ext:member="" ext:cls="Ext.data.DataProxy">DataProxy</a> <img src="resources/elbow-end.gif">DirectProxy</pre></div><h1>Class <a href="source/DirectProxy.html#cls-Ext.data.DirectProxy">Ext.data.DirectProxy</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">DirectProxy.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DirectProxy.html#cls-Ext.data.DirectProxy">DirectProxy</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.data.DataProxy.html" ext:cls="Ext.data.DataProxy" ext:member="">DataProxy</a></td></tr></table><div class="description"></div><div class="hr"></div><a id="Ext.data.DirectProxy-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-api"></a><b><a href="source/DataProxy.html#cfg-Ext.data.DataProxy-api">api</a></b> : Object<div class="mdesc"><div class="short">Specific urls to call on CRUD action methods "read", "create", "update" and "destroy".
\r
2 Defaults to:api: {
\r
3 read ...</div><div class="long">Specific urls to call on CRUD action methods "read", "create", "update" and "destroy".
\r
4 Defaults to:<pre><code>api: {
\r
10 <p>The url is built based upon the action being executed <tt>[load|create|save|destroy]</tt>
\r
11 using the commensurate <tt><a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-api" ext:member="api" ext:cls="Ext.data.DataProxy">api</a></tt> property, or if undefined default to the
\r
12 configured <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a>.<a href="output/Ext.data.Store.html#Ext.data.Store-url" ext:member="url" ext:cls="Ext.data.Store">url</a>.</p><br>
\r
15 load : <em>'/controller/load'</em>,
\r
16 create : <em>'/controller/<b>new</b>'</em>, <i>// Server MUST <b>return</b> idProperty of <b>new</b> record
\r</i>
17 save : <em>'/controller/update'</em>,
\r
18 destroy : <em>'/controller/destroy_action'</em>
\r
21 <i>// Alternatively, one can use the object-form to specify each API-action
\r</i>
23 load: {url: <em>'read.php'</em>, method: <em>'GET'</em>},
\r
24 create: <em>'create.php'</em>,
\r
25 destroy: <em>'destroy.php'</em>,
\r
26 save: <em>'update.php'</em>
\r
28 <p>If the specific URL for a given CRUD action is undefined, the CRUD action request
\r
29 will be directed to the configured <tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a></tt>.</p>
\r
30 <br><p><b>Note</b>: To modify the URL for an action dynamically the appropriate API
\r
31 property should be modified before the action is requested using the corresponding before
\r
32 action event. For example to modify the URL associated with the load action:
\r
33 <pre><code><i>// modify the url <b>for</b> the action
\r</i>
36 fn: <b>function</b> (store, options) {
\r
37 <i>// use <tt><a href="output/Ext.data.HttpProxy.html#Ext.data.HttpProxy-setUrl" ext:member="setUrl" ext:cls="Ext.data.HttpProxy">setUrl</a></tt> to change the URL <b>for</b> *just* this request.
\r</i>
38 store.proxy.setUrl(<em>'changed1.php'</em>);
\r
40 <i>// set optional second parameter to true to make this URL change
\r</i>
41 <i>// permanent, applying this URL <b>for</b> all subsequent requests.
\r</i>
42 store.proxy.setUrl(<em>'changed1.php'</em>, true);
\r
44 <i>// Altering the proxy API should be done using the public
\r</i>
45 <i>// method <tt><a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-setApi" ext:member="setApi" ext:cls="Ext.data.DataProxy">setApi</a></tt>.
\r</i>
46 store.proxy.setApi(<em>'read'</em>, <em>'changed2.php'</em>);
\r
48 <i>// Or set the entire API <b>with</b> a config-object.
\r</i>
49 <i>// When using the config-object option, you must redefine the <b>entire</b>
\r</i>
50 <i>// API -- not just a specific action of it.
\r</i>
51 store.proxy.setApi({
\r
52 read : <em>'changed_read.php'</em>,
\r
53 create : <em>'changed_create.php'</em>,
\r
54 update : <em>'changed_update.php'</em>,
\r
55 destroy : <em>'changed_destroy.php'</em>
\r
60 </p></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#api" ext:member="#api" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DirectProxy-directFn"></a><b><a href="source/DirectProxy.html#cfg-Ext.data.DirectProxy-directFn">directFn</a></b> : Function<div class="mdesc"><div class="short">Function to call when executing a request. directFn is a simple alternative to defining the api configuration-parame...</div><div class="long">Function to call when executing a request. directFn is a simple alternative to defining the api configuration-parameter
\r
61 for Store's which will not implement a full CRUD api.</div></div></td><td class="msource">DirectProxy</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-doRequest"></a><b><a href="source/DataProxy.html#cfg-Ext.data.DataProxy-doRequest">doRequest</a></b> : Function<div class="mdesc"><div class="short">Abstract method that should be implemented in all subclasses. Note: Should only be used by custom-proxy developers. ...</div><div class="long">Abstract method that should be implemented in all subclasses. <b>Note:</b> Should only be used by custom-proxy developers.
\r
62 (e.g.: <a href="output/Ext.data.HttpProxy.html#Ext.data.HttpProxy-doRequest" ext:member="doRequest" ext:cls="Ext.data.HttpProxy">HttpProxy.doRequest</a>,
\r
63 <a href="output/Ext.data.DirectProxy.html#Ext.data.DirectProxy-doRequest" ext:member="doRequest" ext:cls="Ext.data.DirectProxy">DirectProxy.doRequest</a>).</div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#doRequest" ext:member="#doRequest" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
\r
64 object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
65 object during initialization. This should be a valid listeners config object as specified in the
66 <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
67 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
68 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
69 is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
70 <b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
71 events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
72 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
73 <i>// The Component is appended to the argument list of all handler functions.</i>
74 Ext.DomObserver = Ext.extend(Object, {
75 constructor: <b>function</b>(config) {
76 this.listeners = config.listeners ? config.listeners : config;
79 <i>// Component passes itself into plugin's init method</i>
80 init: <b>function</b>(c) {
81 <b>var</b> p, l = this.listeners;
82 <b>for</b> (p <b>in</b> l) {
83 <b>if</b> (Ext.isFunction(l[p])) {
84 l[p] = this.createHandler(l[p], c);
86 l[p].fn = this.createHandler(l[p].fn, c);
90 <i>// Add the listeners to the Element immediately following the render call</i>
91 c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
92 <b>var</b> e = c.getEl();
99 createHandler: <b>function</b>(fn, c) {
100 <b>return</b> <b>function</b>(e) {
106 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
108 <i>// Collapse combo when its element is clicked on</i>
109 plugins: [ <b>new</b> Ext.DomObserver({
110 click: <b>function</b>(evt, comp) {
116 mode: <em>'local'</em>,
117 triggerAction: <em>'all'</em>
118 });</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-onRead"></a><b><a href="source/DataProxy.html#cfg-Ext.data.DataProxy-onRead">onRead</a></b> : Function<div class="mdesc"><div class="short">Abstract method that should be implemented in all subclasses. Note: Should only be used by custom-proxy developers. ...</div><div class="long">Abstract method that should be implemented in all subclasses. <b>Note:</b> Should only be used by custom-proxy developers. Callback for read <a href="output/Ext.data.Api.html#Ext.data.Api-actions" ext:member="actions" ext:cls="Ext.data.Api">action</a>.</div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#onRead" ext:member="#onRead" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-onWrite"></a><b><a href="source/DataProxy.html#cfg-Ext.data.DataProxy-onWrite">onWrite</a></b> : Function<div class="mdesc"><div class="short">Abstract method that should be implemented in all subclasses. Note: Should only be used by custom-proxy developers. ...</div><div class="long">Abstract method that should be implemented in all subclasses. <b>Note:</b> Should only be used by custom-proxy developers. Callback for <i>create, update and destroy</i> <a href="output/Ext.data.Api.html#Ext.data.Api-actions" ext:member="actions" ext:cls="Ext.data.Api">actions</a>.</div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#onWrite" ext:member="#onWrite" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DirectProxy-paramOrder"></a><b><a href="source/DirectProxy.html#cfg-Ext.data.DirectProxy-paramOrder">paramOrder</a></b> : Array/String<div class="mdesc"><div class="short">Defaults to undefined. A list of params to be executed
\r
119 server side. Specify the params in the order in which they m...</div><div class="long">Defaults to <tt>undefined</tt>. A list of params to be executed
\r
120 server side. Specify the params in the order in which they must be executed on the server-side
\r
121 as either (1) an Array of String values, or (2) a String of params delimited by either whitespace,
\r
122 comma, or pipe. For example,
\r
123 any of the following would be acceptable:<pre><code>paramOrder: [<em>'param1'</em>,<em>'param2'</em>,<em>'param3'</em>]
\r
124 paramOrder: <em>'param1 param2 param3'</em>
\r
125 paramOrder: <em>'param1,param2,param3'</em>
\r
126 paramOrder: <em>'param1|param2|param'</em></code></pre></div></div></td><td class="msource">DirectProxy</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DirectProxy-paramsAsHash"></a><b><a href="source/DirectProxy.html#cfg-Ext.data.DirectProxy-paramsAsHash">paramsAsHash</a></b> : Boolean<div class="mdesc"><div class="short">Send parameters as a collection of named arguments (defaults to true). Providing a
\r
127 paramOrder nullifies this configu...</div><div class="long">Send parameters as a collection of named arguments (defaults to <tt>true</tt>). Providing a
\r
128 <tt><a href="output/Ext.data.DirectProxy.html#Ext.data.DirectProxy-paramOrder" ext:member="paramOrder" ext:cls="Ext.data.DirectProxy">paramOrder</a></tt> nullifies this configuration.</div></div></td><td class="msource">DirectProxy</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-restful"></a><b><a href="source/DataProxy.html#cfg-Ext.data.DataProxy-restful">restful</a></b> : Boolean<div class="mdesc"><div class="short">Defaults to false. Set to true to operate in a RESTful manner.
\r
129 Note: this parameter will automatically be set to t...</div><div class="long"><p>Defaults to <tt>false</tt>. Set to <tt>true</tt> to operate in a RESTful manner.</p>
\r
130 <br><p> Note: this parameter will automatically be set to <tt>true</tt> if the
\r
131 <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a> it is plugged into is set to <code>restful: true</code>. If the
\r
132 Store is RESTful, there is no need to set this option on the proxy.</p>
\r
133 <br><p>RESTful implementations enable the serverside framework to automatically route
\r
134 actions sent to one url based upon the HTTP method, for example:
\r
135 <pre><code>store: <b>new</b> Ext.data.Store({
\r
137 proxy: <b>new</b> Ext.data.HttpProxy({url:<em>'/users'</em>}); <i>// all requests sent to /users
\r</i>
140 If there is no <code><a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-api" ext:member="api" ext:cls="Ext.data.DataProxy">api</a></code> specified in the configuration of the proxy,
\r
141 all requests will be marshalled to a single RESTful url (/users) so the serverside
\r
142 framework can inspect the HTTP Method and act accordingly:
\r
144 <u>Method</u> <u>url</u> <u>action</u>
\r
147 PUT /users/23 update
\r
148 DESTROY /users/23 delete
\r
150 <p>If set to <tt>true</tt>, a <a href="output/Ext.data.Record.html#Ext.data.Record-phantom" ext:member="phantom" ext:cls="Ext.data.Record">non-phantom</a> record's
\r
151 <a href="output/Ext.data.Record.html#Ext.data.Record-id" ext:member="id" ext:cls="Ext.data.Record">id</a> will be appended to the url. Some MVC (e.g., Ruby on Rails,
\r
152 Merb and Django) support segment based urls where the segments in the URL follow the
\r
153 Model-View-Controller approach:<pre><code>someSite.com/controller/action/id</code></pre>
\r
154 Where the segments in the url are typically:<div class="mdetail-params"><ul>
\r
155 <li>The first segment : represents the controller class that should be invoked.</li>
\r
156 <li>The second segment : represents the class function, or method, that should be called.</li>
\r
157 <li>The third segment : represents the ID (a variable typically passed to the method).</li>
\r
159 <br><p>Refer to <code><a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-api" ext:member="api" ext:cls="Ext.data.DataProxy">Ext.data.DataProxy.api</a></code> for additional information.</p></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#restful" ext:member="#restful" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr></tbody></table><a id="Ext.data.DirectProxy-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.data.DirectProxy-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>( <code>Object|String o</code>, <code>string Optional.</code> )
\r
161 void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
162 or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
163 Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )
\r
165 void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
166 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
167 properties. This may contain any of the following properties:<ul>
168 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
169 <b>If omitted, defaults to the object which fired the event.</b></div></li>
170 <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>
171 <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>
172 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
173 by the specified number of milliseconds. If the event fires again within that time, the original
174 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
175 <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>
176 if the event was bubbled up from a child Observable.</div></li>
179 <b>Combining Options</b><br>
180 Using the options argument, it is possible to combine different types of listeners:<br>
182 A delayed, one-time listener.
183 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
188 <b>Attaching multiple handlers in 1 call</b><br>
189 The method also allows for a single argument to be passed which is a config object containing properties
190 which specify multiple handlers.
192 <pre><code>myGridPanel.on({
198 <em>'mouseover'</em> : {
199 fn: this.onMouseOver,
202 <em>'mouseout'</em> : {
208 Or a shorthand syntax:<br>
209 <pre><code>myGridPanel.on({
210 <em>'click'</em> : this.onClick,
211 <em>'mouseover'</em> : this.onMouseOver,
212 <em>'mouseout'</em> : this.onMouseOut,
214 });</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-destroy"></a><b><a href="source/DataProxy.html#method-Ext.data.DataProxy-destroy">destroy</a></b>()
\r
216 void<div class="mdesc"><div class="short">Destroys the proxy by purging any event listeners and cancelling any active requests.</div><div class="long">Destroys the proxy by purging any event listeners and cancelling any active requests.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#destroy" ext:member="#destroy" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DirectProxy-doRequest"></a><b><a href="source/DirectProxy.html#method-Ext.data.DirectProxy-doRequest">doRequest</a></b>( <code>String action</code>, <code>Ext.data.Record/Ext.data.Record[] rs</code>, <code>Object params</code>, <code>Ext.data.DataReader reader</code>, <code>Function callback</code>, <code>Object scope</code>, <code>Object arg</code> )
\r
218 void<div class="mdesc"><div class="short">DirectProxy implementation of Ext.data.DataProxy.doRequest</div><div class="long">DirectProxy implementation of <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-doRequest" ext:member="doRequest" ext:cls="Ext.data.DataProxy">Ext.data.DataProxy.doRequest</a><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>action</code> : String<div class="sub-desc">The crud action type (create, read, update, destroy)</div></li><li><code>rs</code> : Ext.data.Record/Ext.data.Record[]<div class="sub-desc">If action is load, rs will be null</div></li><li><code>params</code> : Object<div class="sub-desc">An object containing properties which are to be used as HTTP parameters
\r
219 for the request to the remote server.</div></li><li><code>reader</code> : Ext.data.DataReader<div class="sub-desc">The Reader object which converts the data
\r
220 object into a block of Ext.data.Records.</div></li><li><code>callback</code> : Function<div class="sub-desc"><div class="sub-desc"><p>A function to be called after the request.
\r
221 The <tt>callback</tt> is passed the following arguments:<ul>
\r
222 <li><tt>r</tt> : Ext.data.Record[] The block of Ext.data.Records.</li>
\r
223 <li><tt>options</tt>: Options object from the action request</li>
\r
224 <li><tt>success</tt>: Boolean success indicator</li></ul></p></div></div></li><li><code>scope</code> : Object<div class="sub-desc">The scope (<code>this</code> reference) in which the callback function is executed. Defaults to the browser window.</div></li><li><code>arg</code> : Object<div class="sub-desc">An optional argument which is passed to the callback as its second parameter.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DirectProxy</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>String/Array events</code> )
\r
226 void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
\r
227 this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
\r
228 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
\r
229 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default
\r
230 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
\r
231 access the required target more quickly.</p>
\r
232 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
\r
233 <i>// Add functionality to Field's initComponent to enable the change event to bubble
\r</i>
234 initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
\r
235 this.enableBubble(<em>'change'</em>);
\r
238 <i>// We know that we want Field's events to bubble directly to the FormPanel.
\r</i>
239 getBubbleTarget : <b>function</b>() {
\r
240 <b>if</b> (!this.formPanel) {
\r
241 this.formPanel = this.findParentByType(<em>'form'</em>);
\r
243 <b>return</b> this.formPanel;
\r
247 <b>var</b> myForm = <b>new</b> Ext.formPanel({
\r
248 title: <em>'User Details'</em>,
\r
253 change: <b>function</b>() {
\r
254 <i>// Title goes red <b>if</b> form has been modified.
\r</i>
255 myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
\r
258 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>( <code>String eventName</code>, <code>Object... args</code> )
\r
260 Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
\r
261 An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
262 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
263 by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>( <code>String eventName</code> )
\r
265 Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-isApiAction"></a><b><a href="source/DataProxy.html#method-Ext.data.DataProxy-isApiAction">isApiAction</a></b>( <code>String [Ext.data.Api.CREATE|READ|UPDATE|DESTROY]}</code> )
\r
267 Boolean<div class="mdesc"><div class="short">Returns true if the specified action is defined as a unique action in the api-config.
\r
268 request. If all API-actions a...</div><div class="long">Returns true if the specified action is defined as a unique action in the api-config.
\r
269 request. If all API-actions are routed to unique urls, the xaction parameter is unecessary. However, if no api is defined
\r
270 and all Proxy actions are routed to DataProxy#url, the server-side will require the xaction parameter to perform a switch to
\r
271 the corresponding code for CRUD action.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>[Ext.data.Api.CREATE|READ|UPDATE|DESTROY]}</code> : String<div class="sub-desc">action</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#isApiAction" ext:member="#isApiAction" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-load"></a><b><a href="source/DataProxy.html#method-Ext.data.DataProxy-load">load</a></b>( <code>Object params</code>, <code>Object reader</code>, <code>Object callback</code>, <code>Object scope</code>, <code>Object arg</code> )
\r
273 void<div class="mdesc"><div class="short">Deprecated load method using old method signature. See {@doRequest} for preferred method.</div><div class="long"><b>Deprecated</b> load method using old method signature. See {@doRequest} for preferred method.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>params</code> : Object<div class="sub-desc"></div></li><li><code>reader</code> : Object<div class="sub-desc"></div></li><li><code>callback</code> : Object<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc"></div></li><li><code>arg</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#load" ext:member="#load" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span>, <span title="Optional" class="optional">[<code>Object options</code>]</span> )
\r
275 void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
276 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DirectProxy-onRead"></a><b><a href="source/DirectProxy.html#method-Ext.data.DirectProxy-onRead">onRead</a></b>( <code>String action</code>, <code>Object trans</code>, <code>Object result</code>, <code>Object res</code> )
\r
278 void<div class="mdesc"><div class="short">Callback for read actions</div><div class="long">Callback for read actions<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>action</code> : String<div class="sub-desc">[Ext.data.Api.actions.create|read|update|destroy]</div></li><li><code>trans</code> : Object<div class="sub-desc">The request transaction object</div></li><li><code>result</code> : Object<div class="sub-desc">Data object picked out of the server-response.</div></li><li><code>res</code> : Object<div class="sub-desc">The server response</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DirectProxy</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DirectProxy-onWrite"></a><b><a href="source/DirectProxy.html#method-Ext.data.DirectProxy-onWrite">onWrite</a></b>( <code>String action</code>, <code>Object trans</code>, <code>Object result</code>, <code>Object res</code>, <code>Ext.data.Record/[Ext.data.Record] rs</code> )
\r
280 void<div class="mdesc"><div class="short">Callback for write actions</div><div class="long">Callback for write actions<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>action</code> : String<div class="sub-desc">[<a href="output/Ext.data.Api.html#Ext.data.Api-actions" ext:member="actions" ext:cls="Ext.data.Api">create|read|update|destroy</a>]</div></li><li><code>trans</code> : Object<div class="sub-desc">The request transaction object</div></li><li><code>result</code> : Object<div class="sub-desc">Data object picked out of the server-response.</div></li><li><code>res</code> : Object<div class="sub-desc">The server response</div></li><li><code>rs</code> : Ext.data.Record/[Ext.data.Record]<div class="sub-desc">The Store resultset associated with the action.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">DirectProxy</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
\r
282 void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>( <code>Object o</code>, <code>Array events</code> )
\r
284 void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
\r
286 void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-request"></a><b><a href="source/DataProxy.html#method-Ext.data.DataProxy-request">request</a></b>( <code>String action</code>, <code>Ext.data.Record/Ext.data.Record[]/null rs</code>, <code>Object params</code>, <code>Ext.data.DataReader reader</code>, <code>Function callback</code>, <code>Object scope</code>, <code>Object options</code> )
\r
288 void<div class="mdesc"><div class="short">All proxy actions are executed through this method. Automatically fires the "before" + action event</div><div class="long">All proxy actions are executed through this method. Automatically fires the "before" + action event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>action</code> : String<div class="sub-desc">Name of the action</div></li><li><code>rs</code> : Ext.data.Record/Ext.data.Record[]/null<div class="sub-desc">Will be null when action is 'load'</div></li><li><code>params</code> : Object<div class="sub-desc"></div></li><li><code>reader</code> : Ext.data.DataReader<div class="sub-desc"></div></li><li><code>callback</code> : Function<div class="sub-desc"></div></li><li><code>scope</code> : Object<div class="sub-desc">The scope (<code>this</code> reference) in which the callback function is executed. Defaults to the Proxy object.</div></li><li><code>options</code> : Object<div class="sub-desc">Any options specified for the action (e.g. see <a href="output/Ext.data.Store.html#Ext.data.Store-load" ext:member="load" ext:cls="Ext.data.Store">Ext.data.Store.load</a>.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#request" ext:member="#request" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
\r
290 void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
\r
291 If events were suspended using the queueSuspended parameter, then all
\r
292 event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
293 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
294 events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-setApi"></a><b><a href="source/DataProxy.html#method-Ext.data.DataProxy-setApi">setApi</a></b>( <code>String/Object api</code>, <code>String/Function url</code> )
\r
296 void<div class="mdesc"><div class="short">Redefines the Proxy's API or a single action of an API. Can be called with two method signatures.
\r
297 If called with an ...</div><div class="long"><p>Redefines the Proxy's API or a single action of an API. Can be called with two method signatures.</p>
\r
298 <p>If called with an object as the only parameter, the object should redefine the <b>entire</b> API, e.g.:</p><pre><code>proxy.setApi({
\r
299 read : <em>'/users/read'</em>,
\r
300 create : <em>'/users/create'</em>,
\r
301 update : <em>'/users/update'</em>,
\r
302 destroy : <em>'/users/destroy'</em>
\r
304 <p>If called with two parameters, the first parameter should be a string specifying the API action to
\r
305 redefine and the second parameter should be the URL (or function if using DirectProxy) to call for that action, e.g.:</p><pre><code>proxy.setApi(Ext.data.Api.actions.read, <em>'/users/<b>new</b>_load_url'</em>);</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>api</code> : String/Object<div class="sub-desc">An API specification object, or the name of an action.</div></li><li><code>url</code> : String/Function<div class="sub-desc">The URL (or function if using DirectProxy) to call for the action.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#setApi" ext:member="#setApi" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>( <code>Boolean queueSuspended</code> )
\r
307 void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
308 after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
\r
310 void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.data.DirectProxy-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-beforeload"></a><b><a href="source/DataProxy.html#event-Ext.data.DataProxy-beforeload">beforeload</a></b> :
\r
311 ( <code>DataProxy this</code>, <code>Object params</code> )
\r
312 <div class="mdesc"><div class="short">Fires before a request to retrieve a data object.</div><div class="long">Fires before a request to retrieve a data object.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : DataProxy<div class="sub-desc">The proxy for the request</div></li><li><code>params</code> : Object<div class="sub-desc">The params object passed to the <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-request" ext:member="request" ext:cls="Ext.data.DataProxy">request</a> function</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#beforeload" ext:member="#beforeload" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-beforewrite"></a><b><a href="source/DataProxy.html#event-Ext.data.DataProxy-beforewrite">beforewrite</a></b> :
\r
313 ( <code>DataProxy this</code>, <code>String action</code>, <code>Record/Array[Record] rs</code>, <code>Object params</code> )
\r
314 <div class="mdesc"><div class="short">Fires before a request is generated for one of the actions Ext.data.Api.actions.create|update|destroy
\r
315 In addition to...</div><div class="long"><p>Fires before a request is generated for one of the actions Ext.data.Api.actions.create|update|destroy</p>
\r
316 <p>In addition to being fired through the DataProxy instance that raised the event, this event is also fired
\r
317 through the Ext.data.DataProxy <i>class</i> to allow for centralized processing of beforewrite events from <b>all</b>
\r
318 DataProxies by attaching a listener to the Ext.data.Proxy class itself.</p><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : DataProxy<div class="sub-desc">The proxy for the request</div></li><li><code>action</code> : String<div class="sub-desc">[Ext.data.Api.actions.create|update|destroy]</div></li><li><code>rs</code> : Record/Array[Record]<div class="sub-desc">The Record(s) to create|update|destroy.</div></li><li><code>params</code> : Object<div class="sub-desc">The request <code>params</code> object. Edit <code>params</code> to add parameters to the request.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#beforewrite" ext:member="#beforewrite" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-exception"></a><b><a href="source/DataProxy.html#event-Ext.data.DataProxy-exception">exception</a></b> :
\r
319 ( <code>DataProxy this</code>, <code>String type</code>, <code>String action</code>, <code>Object options</code>, <code>Object response</code>, <code>Mixed arg</code> )
\r
320 <div class="mdesc"><div class="short">Fires if an exception occurs in the Proxy during a remote request. This event is relayed
\r
321 through a corresponding Ext...</div><div class="long"><p>Fires if an exception occurs in the Proxy during a remote request. This event is relayed
\r
322 through a corresponding <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a>.<a href="output/Ext.data.Store.html#Ext.data.Store-exception" ext:member="exception" ext:cls="Ext.data.Store">exception</a>,
\r
323 so any Store instance may observe this event.</p>
\r
324 <p>In addition to being fired through the DataProxy instance that raised the event, this event is also fired
\r
325 through the Ext.data.DataProxy <i>class</i> to allow for centralized processing of exception events from <b>all</b>
\r
326 DataProxies by attaching a listener to the Ext.data.Proxy class itself.</p>
\r
327 <p>This event can be fired for one of two reasons:</p>
\r
328 <div class="mdetail-params"><ul>
\r
329 <li>remote-request <b>failed</b> : <div class="sub-desc">
\r
330 The server did not return status === 200.
\r
332 <li>remote-request <b>succeeded</b> : <div class="sub-desc">
\r
333 The remote-request succeeded but the reader could not read the response.
\r
334 This means the server returned data, but the configured Reader threw an
\r
335 error while reading the response. In this case, this event will be
\r
336 raised and the caught error will be passed along into this event.
\r
339 <br><p>This event fires with two different contexts based upon the 2nd
\r
340 parameter <tt>type [remote|response]</tt>. The first four parameters
\r
341 are identical between the two contexts -- only the final two parameters
\r
342 differ.</p><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : DataProxy<div class="sub-desc">The proxy that sent the request</div></li><li><code>type</code> : String<div class="sub-desc"><p>The value of this parameter will be either <tt>'response'</tt> or <tt>'remote'</tt>.</p>
\r
343 <div class="mdetail-params"><ul>
\r
344 <li><b><tt>'response'</tt></b> : <div class="sub-desc">
\r
345 <p>An <b>invalid</b> response from the server was returned: either 404,
\r
346 500 or the response meta-data does not match that defined in the DataReader
\r
347 (e.g.: root, idProperty, successProperty).</p>
\r
349 <li><b><tt>'remote'</tt></b> : <div class="sub-desc">
\r
350 <p>A <b>valid</b> response was returned from the server having
\r
351 successProperty === false. This response might contain an error-message
\r
352 sent from the server. For example, the user may have failed
\r
353 authentication/authorization or a database validation error occurred.</p>
\r
355 </ul></div></div></li><li><code>action</code> : String<div class="sub-desc">Name of the action (see <a href="output/Ext.data.Api.html#Ext.data.Api-actions" ext:member="actions" ext:cls="Ext.data.Api">Ext.data.Api.actions</a>.</div></li><li><code>options</code> : Object<div class="sub-desc">The options for the action that were specified in the <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-request" ext:member="request" ext:cls="Ext.data.DataProxy">request</a>.</div></li><li><code>response</code> : Object<div class="sub-desc"><p>The value of this parameter depends on the value of the <code>type</code> parameter:</p>
\r
356 <div class="mdetail-params"><ul>
\r
357 <li><b><tt>'response'</tt></b> : <div class="sub-desc">
\r
358 <p>The raw browser response object (e.g.: XMLHttpRequest)</p>
\r
360 <li><b><tt>'remote'</tt></b> : <div class="sub-desc">
\r
361 <p>The decoded response object sent from the server.</p>
\r
363 </ul></div></div></li><li><code>arg</code> : Mixed<div class="sub-desc"><p>The type and value of this parameter depends on the value of the <code>type</code> parameter:</p>
\r
364 <div class="mdetail-params"><ul>
\r
365 <li><b><tt>'response'</tt></b> : Error<div class="sub-desc">
\r
366 <p>The JavaScript Error object caught if the configured Reader could not read the data.
\r
367 If the remote request returns success===false, this parameter will be null.</p>
\r
369 <li><b><tt>'remote'</tt></b> : Record/Record[]<div class="sub-desc">
\r
370 <p>This parameter will only exist if the <tt>action</tt> was a <b>write</b> action
\r
371 (Ext.data.Api.actions.create|update|destroy).</p>
\r
373 </ul></div></div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#exception" ext:member="#exception" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-load"></a><b><a href="source/DataProxy.html#event-Ext.data.DataProxy-load">load</a></b> :
\r
374 ( <code>DataProxy this</code>, <code>Object o</code>, <code>Object options</code> )
\r
375 <div class="mdesc"><div class="short">Fires before the load method's callback is called.</div><div class="long">Fires before the load method's callback is called.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : DataProxy<div class="sub-desc">The proxy for the request</div></li><li><code>o</code> : Object<div class="sub-desc">The request transaction object</div></li><li><code>options</code> : Object<div class="sub-desc">The callback's <tt>options</tt> property as passed to the <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-request" ext:member="request" ext:cls="Ext.data.DataProxy">request</a> function</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#load" ext:member="#load" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-loadexception"></a><b><a href="source/DataProxy.html#event-Ext.data.DataProxy-loadexception">loadexception</a></b> :
\r
376 ( <code>misc misc</code> )
\r
377 <div class="mdesc"><div class="short">This event is deprecated. The signature of the loadexception event
\r
378 varies depending on the proxy, use the catch-all...</div><div class="long"><p>This event is <b>deprecated</b>. The signature of the loadexception event
\r
379 varies depending on the proxy, use the catch-all <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-exception" ext:member="exception" ext:cls="Ext.data.DataProxy">exception</a> event instead.
\r
380 This event will fire in addition to the <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-exception" ext:member="exception" ext:cls="Ext.data.DataProxy">exception</a> event.</p><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>misc</code> : misc<div class="sub-desc">See <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-exception" ext:member="exception" ext:cls="Ext.data.DataProxy">exception</a>.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#loadexception" ext:member="#loadexception" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.DataProxy-write"></a><b><a href="source/DataProxy.html#event-Ext.data.DataProxy-write">write</a></b> :
\r
381 ( <code>DataProxy this</code>, <code>String action</code>, <code>Object data</code>, <code>Object response</code>, <code>Record/Record{} rs</code>, <code>Object options</code> )
\r
382 <div class="mdesc"><div class="short">Fires before the request-callback is called
\r
383 In addition to being fired through the DataProxy instance that raised th...</div><div class="long"><p>Fires before the request-callback is called</p>
\r
384 <p>In addition to being fired through the DataProxy instance that raised the event, this event is also fired
\r
385 through the Ext.data.DataProxy <i>class</i> to allow for centralized processing of write events from <b>all</b>
\r
386 DataProxies by attaching a listener to the Ext.data.Proxy class itself.</p><div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : DataProxy<div class="sub-desc">The proxy that sent the request</div></li><li><code>action</code> : String<div class="sub-desc">[Ext.data.Api.actions.create|upate|destroy]</div></li><li><code>data</code> : Object<div class="sub-desc">The data object extracted from the server-response</div></li><li><code>response</code> : Object<div class="sub-desc">The decoded response from server</div></li><li><code>rs</code> : Record/Record{}<div class="sub-desc">The records from Store</div></li><li><code>options</code> : Object<div class="sub-desc">The callback's <tt>options</tt> property as passed to the <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-request" ext:member="request" ext:cls="Ext.data.DataProxy">request</a> function</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.DataProxy.html#write" ext:member="#write" ext:cls="Ext.data.DataProxy">DataProxy</a></td></tr></tbody></table></div>
git.ithinksw.org / extjs.git / blob