-<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">DataProxy</pre></div><h1>Class <a href="source/DataProxy.html#cls-Ext.data.DataProxy">Ext.data.DataProxy</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">DataProxy.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DataProxy.html#cls-Ext.data.DataProxy">DataProxy</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.data.DirectProxy.html" ext:cls="Ext.data.DirectProxy">DirectProxy</a>, <a href="output/Ext.data.HttpProxy.html" ext:cls="Ext.data.HttpProxy">HttpProxy</a>, <a href="output/Ext.data.MemoryProxy.html" ext:cls="Ext.data.MemoryProxy">MemoryProxy</a>, <a href="output/Ext.data.ScriptTagProxy.html" ext:cls="Ext.data.ScriptTagProxy">ScriptTagProxy</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description"><p>Abstract base class for implementations which provide retrieval of unformatted data objects.\r
-This class is intended to be extended and should not be created directly. For existing implementations,\r
-see <a href="output/Ext.data.DirectProxy.html" ext:cls="Ext.data.DirectProxy">Ext.data.DirectProxy</a>, <a href="output/Ext.data.HttpProxy.html" ext:cls="Ext.data.HttpProxy">Ext.data.HttpProxy</a>, <a href="output/Ext.data.ScriptTagProxy.html" ext:cls="Ext.data.ScriptTagProxy">Ext.data.ScriptTagProxy</a> and\r
-<a href="output/Ext.data.MemoryProxy.html" ext:cls="Ext.data.MemoryProxy">Ext.data.MemoryProxy</a>.</p>\r
-<p>DataProxy implementations are usually used in conjunction with an implementation of <a href="output/Ext.data.DataReader.html" ext:cls="Ext.data.DataReader">Ext.data.DataReader</a>\r
-(of the appropriate type which knows how to parse the data object) to provide a block of\r
-<a href="output/Ext.data.Records.html" ext:cls="Ext.data.Records">Ext.data.Records</a> to an <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a>.</p>\r
-<p>The parameter to a DataProxy constructor may be an <a href="output/Ext.data.Connection.html" ext:cls="Ext.data.Connection">Ext.data.Connection</a> or can also be the\r
-config object to an <a href="output/Ext.data.Connection.html" ext:cls="Ext.data.Connection">Ext.data.Connection</a>.</p>\r
-<p>Custom implementations must implement either the <code><b>doRequest</b></code> method (preferred) or the\r
-<code>load</code> method (deprecated). See\r
-<a href="output/Ext.data.HttpProxy.html" ext:cls="Ext.data.HttpProxy">Ext.data.HttpProxy</a>.<a href="output/Ext.data.HttpProxy.html#Ext.data.HttpProxy-doRequest" ext:member="doRequest" ext:cls="Ext.data.HttpProxy">doRequest</a> or\r
-<a href="output/Ext.data.HttpProxy.html" ext:cls="Ext.data.HttpProxy">Ext.data.HttpProxy</a>.<a href="output/Ext.data.HttpProxy.html#Ext.data.HttpProxy-load" ext:member="load" ext:cls="Ext.data.HttpProxy">load</a> for additional details.</p>\r
-<p><b><u>Example 1</u></b></p>\r
-<pre><code>proxy: <b>new</b> Ext.data.ScriptTagProxy({\r
- <a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a>: <em>'http:<i>//extjs.com/forum/topics-remote.php'</em>\r</i>
-}),</code></pre>\r
-<p><b><u>Example 2</u></b></p>\r
-<pre><code>proxy : <b>new</b> Ext.data.HttpProxy({\r
- <a href="output/Ext.data.Connection.html#Ext.data.Connection-method" ext:member="method" ext:cls="Ext.data.Connection">method</a>: <em>'GET'</em>,\r
- <a href="output/Ext.data.HttpProxy.html#Ext.data.HttpProxy-prettyUrls" ext:member="prettyUrls" ext:cls="Ext.data.HttpProxy">prettyUrls</a>: false,\r
- <a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a>: <em>'local/<b>default</b>.php'</em>, <i>// see options parameter <b>for</b> <a href="output/Ext.Ajax.html#Ext.Ajax-request" ext:member="request" ext:cls="Ext.Ajax">Ext.Ajax.request</a>\r</i>
- <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-api" ext:member="api" ext:cls="Ext.data.DataProxy">api</a>: {\r
- <i>// all actions except the following will use above url\r</i>
- create : <em>'local/<b>new</b>.php'</em>,\r
- update : <em>'local/update.php'</em>\r
- }\r
-}),</code></pre>\r
-<p>And <b>new in Ext version 3</b>, attach centralized event-listeners upon the DataProxy class itself! This is a great place\r
-to implement a <i>messaging system</i> to centralize your application's user-feedback and error-handling.</p>\r
-<pre><code><i>// Listen to all <em>"beforewrite"</em> event fired by all proxies.\r</i>
-Ext.data.DataProxy.on(<em>'beforewrite'</em>, <b>function</b>(proxy, action) {\r
- console.log(<em>'beforewrite: '</em>, action);\r
-});\r
-\r
-<i>// Listen to <em>"write"</em> event fired by all proxies\r</i>
-Ext.data.DataProxy.on(<em>'write'</em>, <b>function</b>(proxy, action, data, res, rs) {\r
- console.info(<em>'write: '</em>, action);\r
-});\r
-\r
-<i>// Listen to <em>"exception"</em> event fired by all proxies\r</i>
-Ext.data.DataProxy.on(<em>'exception'</em>, <b>function</b>(proxy, type, action) {\r
- console.error(type + action + <em>' exception);\r
-});</code></pre>\r
-<b>Note:</b> These three events are all fired with the signature of the corresponding <i>DataProxy instance</i> event <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-beforewrite" ext:member="beforewrite" ext:cls="Ext.data.DataProxy">beforewrite</a>, <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-write" ext:member="write" ext:cls="Ext.data.DataProxy">write</a> and <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-exception" ext:member="exception" ext:cls="Ext.data.DataProxy">exception</a>.</div><div class="hr"></div><a id="Ext.data.DataProxy-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 "><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".
-Defaults to:api: {
- read ...</div><div class="long">Specific urls to call on CRUD action methods "read", "create", "update" and "destroy".\r
-Defaults to:<pre><code>api: {\r
- read : undefined,\r
- create : undefined,\r
- update : undefined,\r
- destroy : undefined\r
-}</code></pre>\r
-<p>The url is built based upon the action being executed <tt>[load|create|save|destroy]</tt>\r
-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
-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
-<p>For example:</p>\r
-<pre><code>api: {\r
- load : <em>'/controller/load'</em>,\r
- create : <em>'/controller/<b>new</b>'</em>, <i>// Server MUST <b>return</b> idProperty of <b>new</b> record\r</i>
- save : <em>'/controller/update'</em>,\r
- destroy : <em>'/controller/destroy_action'</em>\r
-}\r
-\r
-<i>// Alternatively, one can use the object-form to specify each API-action\r</i>
-api: {\r
- load: {url: <em>'read.php'</em>, method: <em>'GET'</em>},\r
- create: <em>'create.php'</em>,\r
- destroy: <em>'destroy.php'</em>,\r
- save: <em>'update.php'</em>\r
-}</code></pre>\r
-<p>If the specific URL for a given CRUD action is undefined, the CRUD action request\r
-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
-<br><p><b>Note</b>: To modify the URL for an action dynamically the appropriate API\r
-property should be modified before the action is requested using the corresponding before\r
-action event. For example to modify the URL associated with the load action:\r
-<pre><code><i>// modify the url <b>for</b> the action\r</i>
-myStore.on({\r
- beforeload: {\r
- fn: <b>function</b> (store, options) {\r
- <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>
- store.proxy.setUrl(<em>'changed1.php'</em>);\r
-\r
- <i>// set optional second parameter to true to make this URL change\r</i>
- <i>// permanent, applying this URL <b>for</b> all subsequent requests.\r</i>
- store.proxy.setUrl(<em>'changed1.php'</em>, true);\r
-\r
- <i>// Altering the proxy API should be done using the public\r</i>
- <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>
- store.proxy.setApi(<em>'read'</em>, <em>'changed2.php'</em>);\r
-\r
- <i>// Or set the entire API <b>with</b> a config-object.\r</i>
- <i>// When using the config-object option, you must redefine the <b>entire</b>\r</i>
- <i>// API -- not just a specific action of it.\r</i>
- store.proxy.setApi({\r
- read : <em>'changed_read.php'</em>,\r
- create : <em>'changed_create.php'</em>,\r
- update : <em>'changed_update.php'</em>,\r
- destroy : <em>'changed_destroy.php'</em>\r
- });\r
- }\r
- }\r
-});</code></pre>\r
-</p></div></div></td><td class="msource">DataProxy</td></tr><tr class="config-row expandable "><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
-(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
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.data.DataProxy-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.data.DataProxy-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.data.DataProxy-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.data.DataProxy-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.data.DataProxy"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><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">DataProxy</pre></div><h1>Class <a href="source/DataProxy.html#cls-Ext.data.DataProxy">Ext.data.DataProxy</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"><a href="source/DataProxy.html#cls-Ext.data.DataProxy">DataProxy.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/DataProxy.html#cls-Ext.data.DataProxy">DataProxy</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.data.DirectProxy.html" ext:cls="Ext.data.DirectProxy">DirectProxy</a>, <a href="output/Ext.data.HttpProxy.html" ext:cls="Ext.data.HttpProxy">HttpProxy</a>, <a href="output/Ext.data.MemoryProxy.html" ext:cls="Ext.data.MemoryProxy">MemoryProxy</a>, <a href="output/Ext.data.ScriptTagProxy.html" ext:cls="Ext.data.ScriptTagProxy">ScriptTagProxy</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description"><p>Abstract base class for implementations which provide retrieval of unformatted data objects.
+This class is intended to be extended and should not be created directly. For existing implementations,
+see <a href="output/Ext.data.DirectProxy.html" ext:cls="Ext.data.DirectProxy">Ext.data.DirectProxy</a>, <a href="output/Ext.data.HttpProxy.html" ext:cls="Ext.data.HttpProxy">Ext.data.HttpProxy</a>, <a href="output/Ext.data.ScriptTagProxy.html" ext:cls="Ext.data.ScriptTagProxy">Ext.data.ScriptTagProxy</a> and
+<a href="output/Ext.data.MemoryProxy.html" ext:cls="Ext.data.MemoryProxy">Ext.data.MemoryProxy</a>.</p>
+<p>DataProxy implementations are usually used in conjunction with an implementation of <a href="output/Ext.data.DataReader.html" ext:cls="Ext.data.DataReader">Ext.data.DataReader</a>
+(of the appropriate type which knows how to parse the data object) to provide a block of
+<a href="output/Ext.data.Records.html" ext:cls="Ext.data.Records">Ext.data.Records</a> to an <a href="output/Ext.data.Store.html" ext:cls="Ext.data.Store">Ext.data.Store</a>.</p>
+<p>The parameter to a DataProxy constructor may be an <a href="output/Ext.data.Connection.html" ext:cls="Ext.data.Connection">Ext.data.Connection</a> or can also be the
+config object to an <a href="output/Ext.data.Connection.html" ext:cls="Ext.data.Connection">Ext.data.Connection</a>.</p>
+<p>Custom implementations must implement either the <code><b>doRequest</b></code> method (preferred) or the
+<code>load</code> method (deprecated). See
+<a href="output/Ext.data.HttpProxy.html" ext:cls="Ext.data.HttpProxy">Ext.data.HttpProxy</a>.<a href="output/Ext.data.HttpProxy.html#Ext.data.HttpProxy-doRequest" ext:member="doRequest" ext:cls="Ext.data.HttpProxy">doRequest</a> or
+<a href="output/Ext.data.HttpProxy.html" ext:cls="Ext.data.HttpProxy">Ext.data.HttpProxy</a>.<a href="output/Ext.data.HttpProxy.html#Ext.data.HttpProxy-load" ext:member="load" ext:cls="Ext.data.HttpProxy">load</a> for additional details.</p>
+<p><b><u>Example 1</u></b></p>
+<pre><code>proxy: <b>new</b> Ext.data.ScriptTagProxy({
+ <a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a>: <em>'http:<i>//extjs.com/forum/topics-remote.php'</em></i>
+}),</code></pre>
+<p><b><u>Example 2</u></b></p>
+<pre><code>proxy : <b>new</b> Ext.data.HttpProxy({
+ <a href="output/Ext.data.Connection.html#Ext.data.Connection-method" ext:member="method" ext:cls="Ext.data.Connection">method</a>: <em>'GET'</em>,
+ <a href="output/Ext.data.HttpProxy.html#Ext.data.HttpProxy-prettyUrls" ext:member="prettyUrls" ext:cls="Ext.data.HttpProxy">prettyUrls</a>: false,
+ <a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a>: <em>'local/<b>default</b>.php'</em>, <i>// see options parameter <b>for</b> <a href="output/Ext.Ajax.html#Ext.Ajax-request" ext:member="request" ext:cls="Ext.Ajax">Ext.Ajax.request</a></i>
+ <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-api" ext:member="api" ext:cls="Ext.data.DataProxy">api</a>: {
+ <i>// all actions except the following will use above url</i>
+ create : <em>'local/<b>new</b>.php'</em>,
+ update : <em>'local/update.php'</em>
+ }
+}),</code></pre>
+<p>And <b>new in Ext version 3</b>, attach centralized event-listeners upon the DataProxy class itself! This is a great place
+to implement a <i>messaging system</i> to centralize your application's user-feedback and error-handling.</p>
+<pre><code><i>// Listen to all <em>"beforewrite"</em> event fired by all proxies.</i>
+Ext.data.DataProxy.on(<em>'beforewrite'</em>, <b>function</b>(proxy, action) {
+ console.log(<em>'beforewrite: '</em>, action);
+});
+
+<i>// Listen to <em>"write"</em> event fired by all proxies</i>
+Ext.data.DataProxy.on(<em>'write'</em>, <b>function</b>(proxy, action, data, res, rs) {
+ console.info(<em>'write: '</em>, action);
+});
+
+<i>// Listen to <em>"exception"</em> event fired by all proxies</i>
+Ext.data.DataProxy.on(<em>'exception'</em>, <b>function</b>(proxy, type, action) {
+ console.error(type + action + <em>' exception);
+});</code></pre>
+<b>Note:</b> These three events are all fired with the signature of the corresponding <i>DataProxy instance</i> event <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-beforewrite" ext:member="beforewrite" ext:cls="Ext.data.DataProxy">beforewrite</a>, <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-write" ext:member="write" ext:cls="Ext.data.DataProxy">write</a> and <a href="output/Ext.data.DataProxy.html#Ext.data.DataProxy-exception" ext:member="exception" ext:cls="Ext.data.DataProxy">exception</a>.</div><div class="hr"></div><a id="Ext.data.DataProxy-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 "><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".
+Defaults to:api: {
+ read ...</div><div class="long">Specific urls to call on CRUD action methods "read", "create", "update" and "destroy".
+Defaults to:<pre><code>api: {
+ read : undefined,
+ create : undefined,
+ update : undefined,
+ destroy : undefined
+}</code></pre>
+<p>The url is built based upon the action being executed <tt>[load|create|save|destroy]</tt>
+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
+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>
+<p>For example:</p>
+<pre><code>api: {
+ load : <em>'/controller/load'</em>,
+ create : <em>'/controller/<b>new</b>'</em>, <i>// Server MUST <b>return</b> idProperty of <b>new</b> record</i>
+ save : <em>'/controller/update'</em>,
+ destroy : <em>'/controller/destroy_action'</em>
+}
+
+<i>// Alternatively, one can use the object-form to specify each API-action</i>
+api: {
+ load: {url: <em>'read.php'</em>, method: <em>'GET'</em>},
+ create: <em>'create.php'</em>,
+ destroy: <em>'destroy.php'</em>,
+ save: <em>'update.php'</em>
+}</code></pre>
+<p>If the specific URL for a given CRUD action is undefined, the CRUD action request
+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>
+<br><p><b>Note</b>: To modify the URL for an action dynamically the appropriate API
+property should be modified before the action is requested using the corresponding before
+action event. For example to modify the URL associated with the load action:
+<pre><code><i>// modify the url <b>for</b> the action</i>
+myStore.on({
+ beforeload: {
+ fn: <b>function</b> (store, options) {
+ <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.</i>
+ store.proxy.setUrl(<em>'changed1.php'</em>);
+
+ <i>// set optional second parameter to true to make this URL change</i>
+ <i>// permanent, applying this URL <b>for</b> all subsequent requests.</i>
+ store.proxy.setUrl(<em>'changed1.php'</em>, true);
+
+ <i>// Altering the proxy API should be done using the public</i>
+ <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>.</i>
+ store.proxy.setApi(<em>'read'</em>, <em>'changed2.php'</em>);
+
+ <i>// Or set the entire API <b>with</b> a config-object.</i>
+ <i>// When using the config-object option, you must redefine the <b>entire</b></i>
+ <i>// API -- not just a specific action of it.</i>
+ store.proxy.setApi({
+ read : <em>'changed_read.php'</em>,
+ create : <em>'changed_create.php'</em>,
+ update : <em>'changed_update.php'</em>,
+ destroy : <em>'changed_destroy.php'</em>
+ });
+ }
+ }
+});</code></pre>
+</p></div></div></td><td class="msource">DataProxy</td></tr><tr class="config-row expandable "><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.
+(e.g.: <a href="output/Ext.data.HttpProxy.html#Ext.data.HttpProxy-doRequest" ext:member="doRequest" ext:cls="Ext.data.HttpProxy">HttpProxy.doRequest</a>,
<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">DataProxy</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
object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
object during initialization. This should be a valid listeners config object as specified in the
typeAhead: true,
mode: <em>'local'</em>,
triggerAction: <em>'all'</em>
-});</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 "><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">DataProxy</td></tr><tr class="config-row expandable "><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">DataProxy</td></tr><tr class="config-row expandable "><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.
- 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
-<br><p> Note: this parameter will automatically be set to <tt>true</tt> if the\r
-<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
-Store is RESTful, there is no need to set this option on the proxy.</p>\r
-<br><p>RESTful implementations enable the serverside framework to automatically route\r
-actions sent to one url based upon the HTTP method, for example:\r
-<pre><code>store: <b>new</b> Ext.data.Store({\r
- restful: true,\r
- proxy: <b>new</b> Ext.data.HttpProxy({url:<em>'/users'</em>}); <i>// all requests sent to /users\r</i>
- ...\r
-)}</code></pre>\r
-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
-all requests will be marshalled to a single RESTful url (/users) so the serverside\r
-framework can inspect the HTTP Method and act accordingly:\r
-<pre>\r
-<u>Method</u> <u>url</u> <u>action</u>\r
-POST /users create\r
-GET /users read\r
-PUT /users/23 update\r
-DESTROY /users/23 delete\r
-</pre></p>\r
-<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
-<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
-Merb and Django) support segment based urls where the segments in the URL follow the\r
-Model-View-Controller approach:<pre><code>someSite.com/controller/action/id</code></pre>\r
-Where the segments in the url are typically:<div class="mdetail-params"><ul>\r
-<li>The first segment : represents the controller class that should be invoked.</li>\r
-<li>The second segment : represents the class function, or method, that should be called.</li>\r
-<li>The third segment : represents the ID (a variable typically passed to the method).</li>\r
-</ul></div></p>\r
+});</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 "><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">DataProxy</td></tr><tr class="config-row expandable "><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">DataProxy</td></tr><tr class="config-row expandable "><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.
+ Note: this parameter will automatically be set to tr...</div><div class="long"><p>Defaults to <tt>false</tt>. Set to <tt>true</tt> to operate in a RESTful manner.</p>
+<br><p> Note: this parameter will automatically be set to <tt>true</tt> if the
+<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
+Store is RESTful, there is no need to set this option on the proxy.</p>
+<br><p>RESTful implementations enable the serverside framework to automatically route
+actions sent to one url based upon the HTTP method, for example:
+<pre><code>store: <b>new</b> Ext.data.Store({
+ restful: true,
+ proxy: <b>new</b> Ext.data.HttpProxy({url:<em>'/users'</em>}); <i>// all requests sent to /users</i>
+ ...
+)}</code></pre>
+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,
+all requests will be marshalled to a single RESTful url (/users) so the serverside
+framework can inspect the HTTP Method and act accordingly:
+<pre>
+<u>Method</u> <u>url</u> <u>action</u>
+POST /users create
+GET /users read
+PUT /users/23 update
+DESTROY /users/23 delete
+</pre></p>
+<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
+<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,
+Merb and Django) support segment based urls where the segments in the URL follow the
+Model-View-Controller approach:<pre><code>someSite.com/controller/action/id</code></pre>
+Where the segments in the url are typically:<div class="mdetail-params"><ul>
+<li>The first segment : represents the controller class that should be invoked.</li>
+<li>The second segment : represents the class function, or method, that should be called.</li>
+<li>The third segment : represents the ID (a variable typically passed to the method).</li>
+</ul></div></p>
<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">DataProxy</td></tr></tbody></table><a id="Ext.data.DataProxy-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.data.DataProxy-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> )
:
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>
:
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">DataProxy</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> )
:
- void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
-<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
-<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
-implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
-access the required target more quickly.</p>\r
-<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
- <i>// Add functionality to Field's initComponent to enable the change event to bubble\r</i>
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
- this.enableBubble(<em>'change'</em>);\r
- }),\r
-\r
- <i>// We know that we want Field's events to bubble directly to the FormPanel.\r</i>
- getBubbleTarget : <b>function</b>() {\r
- <b>if</b> (!this.formPanel) {\r
- this.formPanel = this.findParentByType(<em>'form'</em>);\r
- }\r
- <b>return</b> this.formPanel;\r
- }\r
-});\r
-\r
-<b>var</b> myForm = <b>new</b> Ext.formPanel({\r
- title: <em>'User Details'</em>,\r
- items: [{\r
- ...\r
- }],\r
- listeners: {\r
- change: <b>function</b>() {\r
- <i>// Title goes red <b>if</b> form has been modified.\r</i>
- myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);\r
- }\r
- }\r
+ void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
+<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
+<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
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.</p>
+<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
+ <i>// Add functionality to Field's initComponent to enable the change event to bubble</i>
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
+ this.enableBubble(<em>'change'</em>);
+ }),
+
+ <i>// We know that we want Field's events to bubble directly to the FormPanel.</i>
+ getBubbleTarget : <b>function</b>() {
+ <b>if</b> (!this.formPanel) {
+ this.formPanel = this.findParentByType(<em>'form'</em>);
+ }
+ <b>return</b> this.formPanel;
+ }
+});
+
+<b>var</b> myForm = <b>new</b> Ext.formPanel({
+ title: <em>'User Details'</em>,
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: <b>function</b>() {
+ <i>// Title goes red <b>if</b> form has been modified.</i>
+ myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
+ }
+ }
});</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> )
:
Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
:
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 "><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> )
:
- Boolean<div class="mdesc"><div class="short">Returns true if the specified action is defined as a unique action in the api-config.
-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
-request. If all API-actions are routed to unique urls, the xaction parameter is unecessary. However, if no api is defined\r
-and all Proxy actions are routed to DataProxy#url, the server-side will require the xaction parameter to perform a switch to\r
+ Boolean<div class="mdesc"><div class="short">Returns true if the specified action is defined as a unique action in the api-config.
+request. If all API-actions ar...</div><div class="long">Returns true if the specified action is defined as a unique action in the api-config.
+request. If all API-actions are routed to unique urls, the xaction parameter is unecessary. However, if no api is defined
+and all Proxy actions are routed to DataProxy#url, the server-side will require the xaction parameter to perform a switch to
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">DataProxy</td></tr><tr class="method-row expandable "><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> )
:
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">DataProxy</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> )
If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
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 "><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> )
:
- 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.
-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
-<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
- read : <em>'/users/read'</em>,\r
- create : <em>'/users/create'</em>,\r
- update : <em>'/users/update'</em>,\r
- destroy : <em>'/users/destroy'</em>\r
-});</code></pre>\r
-<p>If called with two parameters, the first parameter should be a string specifying the API action to\r
+ 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.
+If called with an o...</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>
+<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({
+ read : <em>'/users/read'</em>,
+ create : <em>'/users/create'</em>,
+ update : <em>'/users/update'</em>,
+ destroy : <em>'/users/destroy'</em>
+});</code></pre>
+<p>If called with two parameters, the first parameter should be a string specifying the API action to
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">DataProxy</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> )
:
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
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.DataProxy-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 "><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> :
( <code>DataProxy this</code>, <code>Object params</code> )
<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">DataProxy</td></tr><tr class="method-row expandable "><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> :
- ( <code>DataProxy this</code>, <code>String action</code>, <code>Record/Array[Record] rs</code>, <code>Object params</code> )
- <div class="mdesc"><div class="short">Fires before a request is generated for one of the actions Ext.data.Api.actions.create|update|destroy
-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
-<p>In addition to being fired through the DataProxy instance that raised the event, this event is also fired\r
-through the Ext.data.DataProxy <i>class</i> to allow for centralized processing of beforewrite events from <b>all</b>\r
-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">DataProxy</td></tr><tr class="method-row expandable "><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> :
+ ( <code>DataProxy this</code>, <code>String action</code>, <code>Record/Record[] rs</code>, <code>Object params</code> )
+ <div class="mdesc"><div class="short">Fires before a request is generated for one of the actions Ext.data.Api.actions.create|update|destroy
+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>
+<p>In addition to being fired through the DataProxy instance that raised the event, this event is also fired
+through the Ext.data.DataProxy <i>class</i> to allow for centralized processing of beforewrite events from <b>all</b>
+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/
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">DataProxy</td></tr><tr class="method-row expandable "><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> :
( <code>DataProxy this</code>, <code>String type</code>, <code>String action</code>, <code>Object options</code>, <code>Object response</code>, <code>Mixed arg</code> )
- <div class="mdesc"><div class="short">Fires if an exception occurs in the Proxy during a remote request. This event is relayed
-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
-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
-so any Store instance may observe this event.</p>\r
-<p>In addition to being fired through the DataProxy instance that raised the event, this event is also fired\r
-through the Ext.data.DataProxy <i>class</i> to allow for centralized processing of exception events from <b>all</b>\r
-DataProxies by attaching a listener to the Ext.data.Proxy class itself.</p>\r
-<p>This event can be fired for one of two reasons:</p>\r
-<div class="mdetail-params"><ul>\r
-<li>remote-request <b>failed</b> : <div class="sub-desc">\r
-The server did not return status === 200.\r
-</div></li>\r
-<li>remote-request <b>succeeded</b> : <div class="sub-desc">\r
-The remote-request succeeded but the reader could not read the response.\r
-This means the server returned data, but the configured Reader threw an\r
-error while reading the response. In this case, this event will be\r
-raised and the caught error will be passed along into this event.\r
-</div></li>\r
-</ul></div>\r
-<br><p>This event fires with two different contexts based upon the 2nd\r
-parameter <tt>type [remote|response]</tt>. The first four parameters\r
-are identical between the two contexts -- only the final two parameters\r
-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
-<div class="mdetail-params"><ul>\r
-<li><b><tt>'response'</tt></b> : <div class="sub-desc">\r
-<p>An <b>invalid</b> response from the server was returned: either 404,\r
-500 or the response meta-data does not match that defined in the DataReader\r
-(e.g.: root, idProperty, successProperty).</p>\r
-</div></li>\r
-<li><b><tt>'remote'</tt></b> : <div class="sub-desc">\r
-<p>A <b>valid</b> response was returned from the server having\r
-successProperty === false. This response might contain an error-message\r
-sent from the server. For example, the user may have failed\r
-authentication/authorization or a database validation error occurred.</p>\r
-</div></li>\r
-</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
-<div class="mdetail-params"><ul>\r
-<li><b><tt>'response'</tt></b> : <div class="sub-desc">\r
-<p>The raw browser response object (e.g.: XMLHttpRequest)</p>\r
-</div></li>\r
-<li><b><tt>'remote'</tt></b> : <div class="sub-desc">\r
-<p>The decoded response object sent from the server.</p>\r
-</div></li>\r
-</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
-<div class="mdetail-params"><ul>\r
-<li><b><tt>'response'</tt></b> : Error<div class="sub-desc">\r
-<p>The JavaScript Error object caught if the configured Reader could not read the data.\r
-If the remote request returns success===false, this parameter will be null.</p>\r
-</div></li>\r
-<li><b><tt>'remote'</tt></b> : Record/Record[]<div class="sub-desc">\r
-<p>This parameter will only exist if the <tt>action</tt> was a <b>write</b> action\r
-(Ext.data.Api.actions.create|update|destroy).</p>\r
-</div></li>\r
+ <div class="mdesc"><div class="short">Fires if an exception occurs in the Proxy during a remote request. This event is relayed
+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
+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>,
+so any Store instance may observe this event.</p>
+<p>In addition to being fired through the DataProxy instance that raised the event, this event is also fired
+through the Ext.data.DataProxy <i>class</i> to allow for centralized processing of exception events from <b>all</b>
+DataProxies by attaching a listener to the Ext.data.Proxy class itself.</p>
+<p>This event can be fired for one of two reasons:</p>
+<div class="mdetail-params"><ul>
+<li>remote-request <b>failed</b> : <div class="sub-desc">
+The server did not return status === 200.
+</div></li>
+<li>remote-request <b>succeeded</b> : <div class="sub-desc">
+The remote-request succeeded but the reader could not read the response.
+This means the server returned data, but the configured Reader threw an
+error while reading the response. In this case, this event will be
+raised and the caught error will be passed along into this event.
+</div></li>
+</ul></div>
+<br><p>This event fires with two different contexts based upon the 2nd
+parameter <tt>type [remote|response]</tt>. The first four parameters
+are identical between the two contexts -- only the final two parameters
+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>
+<div class="mdetail-params"><ul>
+<li><b><tt>'response'</tt></b> : <div class="sub-desc">
+<p>An <b>invalid</b> response from the server was returned: either 404,
+500 or the response meta-data does not match that defined in the DataReader
+(e.g.: root, idProperty, successProperty).</p>
+</div></li>
+<li><b><tt>'remote'</tt></b> : <div class="sub-desc">
+<p>A <b>valid</b> response was returned from the server having
+successProperty === false. This response might contain an error-message
+sent from the server. For example, the user may have failed
+authentication/authorization or a database validation error occurred.</p>
+</div></li>
+</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>
+<div class="mdetail-params"><ul>
+<li><b><tt>'response'</tt></b> : <div class="sub-desc">
+<p>The raw browser response object (e.g.: XMLHttpRequest)</p>
+</div></li>
+<li><b><tt>'remote'</tt></b> : <div class="sub-desc">
+<p>The decoded response object sent from the server.</p>
+</div></li>
+</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>
+<div class="mdetail-params"><ul>
+<li><b><tt>'response'</tt></b> : Error<div class="sub-desc">
+<p>The JavaScript Error object caught if the configured Reader could not read the data.
+If the remote request returns success===false, this parameter will be null.</p>
+</div></li>
+<li><b><tt>'remote'</tt></b> : Record/Record[]<div class="sub-desc">
+<p>This parameter will only exist if the <tt>action</tt> was a <b>write</b> action
+(Ext.data.Api.actions.create|update|destroy).</p>
+</div></li>
</ul></div></div></li></ul></div></div></div></td><td class="msource">DataProxy</td></tr><tr class="method-row expandable "><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> :
( <code>DataProxy this</code>, <code>Object o</code>, <code>Object options</code> )
<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">DataProxy</td></tr><tr class="method-row expandable "><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> :
( <code>misc misc</code> )
- <div class="mdesc"><div class="short">This event is deprecated. The signature of the loadexception event
-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
-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
+ <div class="mdesc"><div class="short">This event is deprecated. The signature of the loadexception event
+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
+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.
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">DataProxy</td></tr><tr class="method-row expandable "><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> :
- ( <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> )
- <div class="mdesc"><div class="short">Fires before the request-callback is called
-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
-<p>In addition to being fired through the DataProxy instance that raised the event, this event is also fired\r
-through the Ext.data.DataProxy <i>class</i> to allow for centralized processing of write events from <b>all</b>\r
-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">DataProxy</td></tr></tbody></table></div>
\ No newline at end of file
+ ( <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> )
+ <div class="mdesc"><div class="short">Fires before the request-callback is called
+In addition to being fired through the DataProxy instance that raised the...</div><div class="long"><p>Fires before the request-callback is called</p>
+<p>In addition to being fired through the DataProxy instance that raised the event, this event is also fired
+through the Ext.data.DataProxy <i>class</i> to allow for centralized processing of write events from <b>all</b>
+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 Record(s) 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">DataProxy</td></tr></tbody></table></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff