docs/output/Ext.data.HttpProxy.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.data.HttpProxy-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.data.HttpProxy-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.data.HttpProxy-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                             <a class="inner-link" href="#Ext.data.HttpProxy-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
   7                         <a class="bookmark" href="../docs/?class=Ext.data.HttpProxy"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   8         </div>
   9                 <div class="inheritance res-block">
  10 <pre class="res-block-inner"><a ext:cls="Ext.util.Observable" ext:member="" href="output/Ext.util.Observable.html">Observable</a>
  11   <img src="resources/elbow-end.gif"/><a ext:cls="Ext.data.DataProxy" ext:member="" href="output/Ext.data.DataProxy.html">DataProxy</a>
  12     <img src="resources/elbow-end.gif"/>HttpProxy</pre></div>
  13                 <h1>Class Ext.data.HttpProxy</h1>
  14         <table cellspacing="0">
  15             <tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr>
  16             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/HttpProxy.js" target="_blank">HttpProxy.js</a></td></tr>
  17             <tr><td class="label">Class:</td><td class="hd-info">HttpProxy</td></tr>
  18                                     <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.data.DataProxy" ext:member="" href="output/Ext.data.DataProxy.html">DataProxy</a></td></tr>
  19                     </table>
  20         <div class="description">
  21             *
  22 An implementation of <a ext:cls="Ext.data.DataProxy" href="output/Ext.data.DataProxy.html">Ext.data.DataProxy</a> that reads a data object from a <a ext:cls="Ext.data.Connection" href="output/Ext.data.Connection.html">Connection</a> object
  23 configured to reference a certain URL.<br>
  24 <p>
  25 <b>Note that this class cannot be used to retrieve data from a domain other than the domain
  26 from which the running page was served.<br>
  27 <p>
  28 For cross-domain access to remote data, use a <a ext:cls="Ext.data.ScriptTagProxy" href="output/Ext.data.ScriptTagProxy.html">ScriptTagProxy</a>.</b><br>
  29 <p>
  30 Be aware that to enable the browser to parse an XML document, the server must set
  31 the Content-Type header in the HTTP response to "text/xml".        </div>
  32
  33         <div class="hr"></div>
  34                 <a id="Ext.data.HttpProxy-configs"></a>
  35         <h2>Config Options</h2>
  36         <table cellspacing="0" class="member-table">
  37             <tr>
  38                 <th class="sig-header" colspan="2">Config Options</th>
  39                 <th class="msource-header">Defined By</th>
  40             </tr>
  41                 <tr class="config-row inherited expandable">\r
  42         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  43         <td class="sig">\r
  44         <a id="Ext.data.HttpProxy-listeners"></a>\r
  45             <b>listeners</b> : Object            <div class="mdesc">\r
  46                         <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
  47             <div class="long">\r
  48                 (optional) 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 <a ext:cls="Ext.util.Observable" ext:member="addListener" href="output/Ext.util.Observable.html#addListener">addListener</a> example for attaching multiple handlers at once.            </div>\r
  49                         </div>\r
  50         </td>\r
  51         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
  52     </tr>\r
  53             </table>
  54                 <a id="Ext.data.HttpProxy-props"></a>
  55         <h2>Public Properties</h2>
  56                 <table cellspacing="0" class="member-table">
  57             <tr>
  58                 <th class="sig-header" colspan="2">Property</th>
  59                 <th class="msource-header">Defined By</th>
  60             </tr>
  61                 <tr class="property-row expandable">\r
  62         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  63         <td class="sig">\r
  64         <a id="Ext.data.HttpProxy-conn"></a>\r
  65             <b>conn</b> : Object            <div class="mdesc">\r
  66                         <div class="short">The Connection object (Or options parameter to Ext.Ajax.request) which this HttpProxy uses to make requests to the se...</div>\r
  67             <div class="long">\r
  68                 The Connection object (Or options parameter to <a ext:cls="Ext.Ajax" ext:member="request" href="output/Ext.Ajax.html#request">Ext.Ajax.request</a>) which this HttpProxy uses to make requests to the server.
  69 Properties of this object may be changed dynamically to change the way data is requested.            </div>\r
  70                         </div>\r
  71         </td>\r
  72         <td class="msource">HttpProxy</td>\r
  73     </tr>\r
  74             </table>
  75                 <a id="Ext.data.HttpProxy-methods"></a>
  76         <h2>Public Methods</h2>
  77                 <table cellspacing="0" class="member-table">
  78             <tr>
  79                 <th class="sig-header" colspan="2">Method</th>
  80                 <th class="msource-header">Defined By</th>
  81             </tr>
  82                 <tr class="method-row expandable">\r
  83         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  84         <td class="sig">\r
  85         <a id="Ext.data.HttpProxy-HttpProxy"></a>\r
  86             <b>HttpProxy</b>(&nbsp;<code>Object conn</code>&nbsp;)            <div class="mdesc">\r
  87                         <div class="short"></div>\r
  88             <div class="long">\r
  89                     <div class="mdetail-params">\r
  90         <strong>Parameters:</strong>\r
  91         <ul><li><code>conn</code> : Object<div class="sub-desc">an <a ext:cls="Ext.data.Connection" href="output/Ext.data.Connection.html">Ext.data.Connection</a> object, or options parameter to <a ext:cls="Ext.Ajax" ext:member="request" href="output/Ext.Ajax.html#request">Ext.Ajax.request</a>.
  92 If an options parameter is passed, the singleton <a ext:cls="Ext.Ajax" href="output/Ext.Ajax.html">Ext.Ajax</a> object will be used to make the request.</div></li>        </ul>\r
  93         <strong>Returns:</strong>\r
  94         <ul>\r
  95             <li><code></code></li>\r
  96         </ul>\r
  97     </div>\r
  98                 </div>\r
  99                         </div>\r
 100         </td>\r
 101         <td class="msource">HttpProxy</td>\r
 102     </tr>\r
 103         <tr class="method-row inherited alt expandable">\r
 104         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 105         <td class="sig">\r
 106         <a id="Ext.data.HttpProxy-addEvents"></a>\r
 107             <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">\r
 108                         <div class="short">Used to define events on this Observable</div>\r
 109             <div class="long">\r
 110                 Used to define events on this Observable    <div class="mdetail-params">\r
 111         <strong>Parameters:</strong>\r
 112         <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>\r
 113         <strong>Returns:</strong>\r
 114         <ul>\r
 115             <li><code>void</code></li>\r
 116         </ul>\r
 117     </div>\r
 118                 </div>\r
 119                         </div>\r
 120         </td>\r
 121         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
 122     </tr>\r
 123         <tr class="method-row inherited expandable">\r
 124         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 125         <td class="sig">\r
 126         <a id="Ext.data.HttpProxy-addListener"></a>\r
 127             <b>addListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 128                         <div class="short">Appends an event handler to this component</div>\r
 129             <div class="long">\r
 130                 Appends an event handler to this component    <div class="mdetail-params">\r
 131         <strong>Parameters:</strong>\r
 132         <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 in which to execute the handler
 133 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
 134 properties. This may contain any of the following properties:<ul>
 135 <li><b>scope</b> : Object<p class="sub-desc">The scope in which to execute the handler function. The handler function's "this" context.</p></li>
 136 <li><b>delay</b> : Number<p class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>
 137 <li><b>single</b> : Boolean<p class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>
 138 <li><b>buffer</b> : Number<p class="sub-desc">Causes the handler to be scheduled to run in an <a ext:cls="Ext.util.DelayedTask" href="output/Ext.util.DelayedTask.html">Ext.util.DelayedTask</a> delayed
 139 by the specified number of milliseconds. If the event fires again within that time, the original
 140 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
 141 </ul><br>
 142 <p>
 143 <b>Combining Options</b><br>
 144 Using the options argument, it is possible to combine different types of listeners:<br>
 145 <br>
 146 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
 147 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
 148     single: true,
 149     delay: 100,
 150     forumId: 4
 151 });</code></pre>
 152 <p>
 153 <b>Attaching multiple handlers in 1 call</b><br>
 154 The method also allows for a single argument to be passed which is a config object containing properties
 155 which specify multiple handlers.
 156 <p>
 157 <pre><code>foo.on({
 158     <em>'click'</em> : {
 159         fn: <b>this</b>.onClick,
 160         scope: <b>this</b>,
 161         delay: 100
 162     },
 163     <em>'mouseover'</em> : {
 164         fn: <b>this</b>.onMouseOver,
 165         scope: <b>this</b>
 166     },
 167     <em>'mouseout'</em> : {
 168         fn: <b>this</b>.onMouseOut,
 169         scope: <b>this</b>
 170     }
 171 });</code></pre>
 172 <p>
 173 Or a shorthand syntax:<br>
 174 <pre><code>foo.on({
 175     <em>'click'</em> : <b>this</b>.onClick,
 176     <em>'mouseover'</em> : <b>this</b>.onMouseOver,
 177     <em>'mouseout'</em> : <b>this</b>.onMouseOut,
 178      scope: <b>this</b>
 179 });</code></pre></div></li>        </ul>\r
 180         <strong>Returns:</strong>\r
 181         <ul>\r
 182             <li><code>void</code></li>\r
 183         </ul>\r
 184     </div>\r
 185                 </div>\r
 186                         </div>\r
 187         </td>\r
 188         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
 189     </tr>\r
 190         <tr class="method-row inherited alt expandable">\r
 191         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 192         <td class="sig">\r
 193         <a id="Ext.data.HttpProxy-fireEvent"></a>\r
 194             <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">\r
 195                         <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
 196             <div class="long">\r
 197                 Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">\r
 198         <strong>Parameters:</strong>\r
 199         <ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li>        </ul>\r
 200         <strong>Returns:</strong>\r
 201         <ul>\r
 202             <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
 203         </ul>\r
 204     </div>\r
 205                 </div>\r
 206                         </div>\r
 207         </td>\r
 208         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
 209     </tr>\r
 210         <tr class="method-row expandable">\r
 211         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 212         <td class="sig">\r
 213         <a id="Ext.data.HttpProxy-getConnection"></a>\r
 214             <b>getConnection</b>() : Connection            <div class="mdesc">\r
 215                         <div class="short">Return the <a ext:cls="Ext.data.Connection" href="output/Ext.data.Connection.html">Ext.data.Connection</a> object being used by this Proxy.</div>\r
 216             <div class="long">\r
 217                 Return the <a ext:cls="Ext.data.Connection" href="output/Ext.data.Connection.html">Ext.data.Connection</a> object being used by this Proxy.    <div class="mdetail-params">\r
 218         <strong>Parameters:</strong>\r
 219         <ul><li>None.</li>        </ul>\r
 220         <strong>Returns:</strong>\r
 221         <ul>\r
 222             <li><code>Connection</code><div class="sub-desc">The Connection object. This object may be used to subscribe to events on a finer-grained basis than the DataProxy events.</div></li>\r
 223         </ul>\r
 224     </div>\r
 225                 </div>\r
 226                         </div>\r
 227         </td>\r
 228         <td class="msource">HttpProxy</td>\r
 229     </tr>\r
 230         <tr class="method-row inherited alt expandable">\r
 231         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 232         <td class="sig">\r
 233         <a id="Ext.data.HttpProxy-hasListener"></a>\r
 234             <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">\r
 235                         <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
 236             <div class="long">\r
 237                 Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">\r
 238         <strong>Parameters:</strong>\r
 239         <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>\r
 240         <strong>Returns:</strong>\r
 241         <ul>\r
 242             <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
 243         </ul>\r
 244     </div>\r
 245                 </div>\r
 246                         </div>\r
 247         </td>\r
 248         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
 249     </tr>\r
 250         <tr class="method-row expandable">\r
 251         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 252         <td class="sig">\r
 253         <a id="Ext.data.HttpProxy-load"></a>\r
 254             <b>load</b>(&nbsp;<code>Object params</code>, <code>Ext.data.DataReader reader</code>, <code>Function callback</code>, <code>Object scope</code>, <code>Object arg</code>&nbsp;) : void            <div class="mdesc">\r
 255                         <div class="short">Load data from the configured Ext.data.Connection, read the data object into
 256 a block of Ext.data.Records using the pa...</div>\r
 257             <div class="long">\r
 258                 Load data from the configured <a ext:cls="Ext.data.Connection" href="output/Ext.data.Connection.html">Ext.data.Connection</a>, read the data object into
 259 a block of Ext.data.Records using the passed <a ext:cls="Ext.data.DataReader" href="output/Ext.data.DataReader.html">Ext.data.DataReader</a> implementation, and
 260 process that block using the passed callback.    <div class="mdetail-params">\r
 261         <strong>Parameters:</strong>\r
 262         <ul><li><code>params</code> : Object<div class="sub-desc">An object containing properties which are to be used as HTTP parameters
 263 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
 264 object into a block of Ext.data.Records.</div></li><li><code>callback</code> : Function<div class="sub-desc">The function into which to pass the block of Ext.data.Records.
 265 The function must be passed <ul>
 266 <li>The Record block object</li>
 267 <li>The "arg" argument from the load function</li>
 268 <li>A boolean success indicator</li>
 269 </ul></div></li><li><code>scope</code> : Object<div class="sub-desc">The scope in which to call the callback</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>\r
 270         <strong>Returns:</strong>\r
 271         <ul>\r
 272             <li><code>void</code></li>\r
 273         </ul>\r
 274     </div>\r
 275                 </div>\r
 276                         </div>\r
 277         </td>\r
 278         <td class="msource">HttpProxy</td>\r
 279     </tr>\r
 280         <tr class="method-row inherited alt expandable">\r
 281         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 282         <td class="sig">\r
 283         <a id="Ext.data.HttpProxy-on"></a>\r
 284             <b>on</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Object options</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 285                         <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
 286             <div class="long">\r
 287                 Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">\r
 288         <strong>Parameters:</strong>\r
 289         <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 in which to execute the handler
 290 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
 291         <strong>Returns:</strong>\r
 292         <ul>\r
 293             <li><code>void</code></li>\r
 294         </ul>\r
 295     </div>\r
 296                 </div>\r
 297                         </div>\r
 298         </td>\r
 299         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
 300     </tr>\r
 301         <tr class="method-row inherited expandable">\r
 302         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 303         <td class="sig">\r
 304         <a id="Ext.data.HttpProxy-purgeListeners"></a>\r
 305             <b>purgeListeners</b>() : void            <div class="mdesc">\r
 306                         <div class="short">Removes all listeners for this object</div>\r
 307             <div class="long">\r
 308                 Removes all listeners for this object    <div class="mdetail-params">\r
 309         <strong>Parameters:</strong>\r
 310         <ul><li>None.</li>        </ul>\r
 311         <strong>Returns:</strong>\r
 312         <ul>\r
 313             <li><code>void</code></li>\r
 314         </ul>\r
 315     </div>\r
 316                 </div>\r
 317                         </div>\r
 318         </td>\r
 319         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
 320     </tr>\r
 321         <tr class="method-row inherited alt expandable">\r
 322         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 323         <td class="sig">\r
 324         <a id="Ext.data.HttpProxy-relayEvents"></a>\r
 325             <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">\r
 326                         <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
 327             <div class="long">\r
 328                 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">\r
 329         <strong>Parameters:</strong>\r
 330         <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>\r
 331         <strong>Returns:</strong>\r
 332         <ul>\r
 333             <li><code>void</code></li>\r
 334         </ul>\r
 335     </div>\r
 336                 </div>\r
 337                         </div>\r
 338         </td>\r
 339         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
 340     </tr>\r
 341         <tr class="method-row inherited expandable">\r
 342         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 343         <td class="sig">\r
 344         <a id="Ext.data.HttpProxy-removeListener"></a>\r
 345             <b>removeListener</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 346                         <div class="short">Removes a listener</div>\r
 347             <div class="long">\r
 348                 Removes a listener    <div class="mdetail-params">\r
 349         <strong>Parameters:</strong>\r
 350         <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 handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
 351         <strong>Returns:</strong>\r
 352         <ul>\r
 353             <li><code>void</code></li>\r
 354         </ul>\r
 355     </div>\r
 356                 </div>\r
 357                         </div>\r
 358         </td>\r
 359         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
 360     </tr>\r
 361         <tr class="method-row inherited alt expandable">\r
 362         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 363         <td class="sig">\r
 364         <a id="Ext.data.HttpProxy-resumeEvents"></a>\r
 365             <b>resumeEvents</b>() : void            <div class="mdesc">\r
 366                         <div class="short">Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)</div>\r
 367             <div class="long">\r
 368                 Resume firing events. (see <a ext:cls="Ext.util.Observable" ext:member="suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">suspendEvents</a>)    <div class="mdetail-params">\r
 369         <strong>Parameters:</strong>\r
 370         <ul><li>None.</li>        </ul>\r
 371         <strong>Returns:</strong>\r
 372         <ul>\r
 373             <li><code>void</code></li>\r
 374         </ul>\r
 375     </div>\r
 376                 </div>\r
 377                         </div>\r
 378         </td>\r
 379         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
 380     </tr>\r
 381         <tr class="method-row inherited expandable">\r
 382         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 383         <td class="sig">\r
 384         <a id="Ext.data.HttpProxy-suspendEvents"></a>\r
 385             <b>suspendEvents</b>() : void            <div class="mdesc">\r
 386                         <div class="short">Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)</div>\r
 387             <div class="long">\r
 388                 Suspend the firing of all events. (see <a ext:cls="Ext.util.Observable" ext:member="resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">resumeEvents</a>)    <div class="mdetail-params">\r
 389         <strong>Parameters:</strong>\r
 390         <ul><li>None.</li>        </ul>\r
 391         <strong>Returns:</strong>\r
 392         <ul>\r
 393             <li><code>void</code></li>\r
 394         </ul>\r
 395     </div>\r
 396                 </div>\r
 397                         </div>\r
 398         </td>\r
 399         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
 400     </tr>\r
 401         <tr class="method-row inherited alt expandable">\r
 402         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 403         <td class="sig">\r
 404         <a id="Ext.data.HttpProxy-un"></a>\r
 405             <b>un</b>(&nbsp;<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>&nbsp;) : void            <div class="mdesc">\r
 406                         <div class="short">Removes a listener (shorthand for removeListener)</div>\r
 407             <div class="long">\r
 408                 Removes a listener (shorthand for removeListener)    <div class="mdetail-params">\r
 409         <strong>Parameters:</strong>\r
 410         <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 handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li>        </ul>\r
 411         <strong>Returns:</strong>\r
 412         <ul>\r
 413             <li><code>void</code></li>\r
 414         </ul>\r
 415     </div>\r
 416                 </div>\r
 417                         </div>\r
 418         </td>\r
 419         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
 420     </tr>\r
 421             </table>
 422                 <a id="Ext.data.HttpProxy-events"></a>
 423         <h2>Public Events</h2>
 424                 <table cellspacing="0" class="member-table">
 425             <tr>
 426                 <th class="sig-header" colspan="2">Event</th>
 427                 <th class="msource-header">Defined By</th>
 428             </tr>
 429                 <tr class="event-row inherited expandable">\r
 430         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 431         <td class="sig">\r
 432         <a id="Ext.data.HttpProxy-beforeload"></a>\r
 433             <b>beforeload</b> : (&nbsp;<code>Object this</code>, <code>Object params</code>&nbsp;)            <div class="mdesc">\r
 434                         <div class="short">Fires before a network request is made to retrieve a data object.</div>\r
 435             <div class="long">\r
 436                 Fires before a network request is made to retrieve a data object.    <div class="mdetail-params">\r
 437         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
 438         <ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>params</code> : Object<div class="sub-desc">The params object passed to the <a ext:cls="Ext.data.DataProxy" ext:member="load" href="output/Ext.data.DataProxy.html#load">load</a> function</div></li>        </ul>\r
 439     </div>\r
 440                 </div>\r
 441                         </div>\r
 442         </td>\r
 443         <td class="msource"><a ext:cls="Ext.data.DataProxy" ext:member="#event-beforeload" href="output/Ext.data.DataProxy.html#event-beforeload">DataProxy</a></td>\r
 444     </tr>\r
 445         <tr class="event-row inherited alt expandable">\r
 446         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 447         <td class="sig">\r
 448         <a id="Ext.data.HttpProxy-load"></a>\r
 449             <b>load</b> : (&nbsp;<code>Object this</code>, <code>Object o</code>, <code>Object arg</code>&nbsp;)            <div class="mdesc">\r
 450                         <div class="short">Fires before the load method's callback is called.</div>\r
 451             <div class="long">\r
 452                 Fires before the load method's callback is called.    <div class="mdetail-params">\r
 453         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
 454         <ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>o</code> : Object<div class="sub-desc">The data object</div></li><li><code>arg</code> : Object<div class="sub-desc">The callback's arg object passed to the <a ext:cls="Ext.data.DataProxy" ext:member="load" href="output/Ext.data.DataProxy.html#load">load</a> function</div></li>        </ul>\r
 455     </div>\r
 456                 </div>\r
 457                         </div>\r
 458         </td>\r
 459         <td class="msource"><a ext:cls="Ext.data.DataProxy" ext:member="#event-load" href="output/Ext.data.DataProxy.html#event-load">DataProxy</a></td>\r
 460     </tr>\r
 461         <tr class="event-row expandable">\r
 462         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 463         <td class="sig">\r
 464         <a id="Ext.data.HttpProxy-loadexception"></a>\r
 465             <b>loadexception</b> : (&nbsp;<code>Object this</code>, <code>Object options</code>, <code>Object response</code>, <code>Error e</code>&nbsp;)            <div class="mdesc">\r
 466                         <div class="short">Fires if an exception occurs in the Proxy during data loading.  This event can be fired for one of two reasons:
 467 The l...</div>\r
 468             <div class="long">\r
 469                 Fires if an exception occurs in the Proxy during data loading.  This event can be fired for one of two reasons:
 470 <ul><li><b>The load call returned success: false.</b>  This means the server logic returned a failure
 471 status and there is no data to read.  In this case, this event will be raised and the
 472 fourth parameter (read error) will be null.</li>
 473 <li><b>The load succeeded but the reader could not read the response.</b>  This means the server returned
 474 data, but the configured Reader threw an error while reading the data.  In this case, this event will be
 475 raised and the caught error will be passed along as the fourth parameter of this event.</li></ul>
 476 Note that this event is also relayed through <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a>, so you can listen for it directly
 477 on any Store instance.    <div class="mdetail-params">\r
 478         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
 479         <ul><li><code>this</code> : Object<div class="sub-desc"></div></li><li><code>options</code> : Object<div class="sub-desc">The loading options that were specified (see <a ext:cls="Ext.data.HttpProxy" ext:member="load" href="output/Ext.data.HttpProxy.html#load">load</a> for details)</div></li><li><code>response</code> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data</div></li><li><code>e</code> : Error<div class="sub-desc">The JavaScript Error object caught if the configured Reader could not read the data.
 480 If the load call returned success: false, this parameter will be null.</div></li>        </ul>\r
 481     </div>\r
 482                 </div>\r
 483                         </div>\r
 484         </td>\r
 485         <td class="msource">HttpProxy</td>\r
 486     </tr>\r
 487             </table>
 488
 489         </div>