d7ef3111fdac532c8dfec844b551edd8b6a0add5.svn-base 28 KB

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