commit extjs-2.2.1
[extjs.git] / docs / output / Ext.data.ScriptTagProxy.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.data.ScriptTagProxy-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.data.ScriptTagProxy-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.data.ScriptTagProxy-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                             <a class="inner-link" href="#Ext.data.ScriptTagProxy-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.ScriptTagProxy"><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"/>ScriptTagProxy</pre></div>
13                 <h1>Class Ext.data.ScriptTagProxy</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/ScriptTagProxy.js" target="_blank">ScriptTagProxy.js</a></td></tr>
17             <tr><td class="label">Class:</td><td class="hd-info">ScriptTagProxy</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 Ext.data.DataProxy that reads a data object from a URL which may be in a domain
23 other than the originating domain of the running page.<br>
24 <p>
25 <b>Note that if you are retrieving data from a page that is in a domain that is NOT the same as the originating domain
26 of the running page, you must use this class, rather than HttpProxy.</b><br>
27 <p>
28 The content passed back from a server resource requested by a ScriptTagProxy <b>must</b> be executable JavaScript
29 source code because it is used as the source inside a &lt;script> tag.<br>
30 <p>
31 In order for the browser to process the returned data, the server must wrap the data object
32 with a call to a callback function, the name of which is passed as a parameter by the ScriptTagProxy.
33 Below is a Java example for a servlet which returns data for either a ScriptTagProxy, or an HttpProxy
34 depending on whether the callback name was passed:
35 <p>
36 <pre><code>boolean scriptTag = false;
37 String cb = request.getParameter(<em>"callback"</em>);
38 <b>if</b> (cb != null) {
39     scriptTag = true;
40     response.setContentType(<em>"text/javascript"</em>);
41 } <b>else</b> {
42     response.setContentType(<em>"application/x-json"</em>);
43 }
44 Writer out = response.getWriter();
45 <b>if</b> (scriptTag) {
46     out.write(cb + <em>"("</em>);
47 }
48 out.print(dataBlock.toJsonString());
49 <b>if</b> (scriptTag) {
50     out.write(<em>");"</em>);
51 }</code></pre>        </div>
52         
53         <div class="hr"></div>
54                 <a id="Ext.data.ScriptTagProxy-configs"></a>
55         <h2>Config Options</h2>
56         <table cellspacing="0" class="member-table">
57             <tr>
58                 <th class="sig-header" colspan="2">Config Options</th>
59                 <th class="msource-header">Defined By</th>
60             </tr>
61                 <tr class="config-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.ScriptTagProxy-callbackParam"></a>\r
65             <b>callbackParam</b> : String            <div class="mdesc">\r
66                         <div class="short">(Optional) The name of the parameter to pass to the server which tells the server the name of the callback function s...</div>\r
67             <div class="long">\r
68                 (Optional) The name of the parameter to pass to the server which tells the server the name of the callback function set up by the load call to process the returned data object. Defaults to "callback".<p>The server-side processing must read this parameter value, and generate javascript output which calls this named function passing the data object as its only parameter.            </div>\r
69                         </div>\r
70         </td>\r
71         <td class="msource">ScriptTagProxy</td>\r
72     </tr>\r
73         <tr class="config-row inherited alt expandable">\r
74         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
75         <td class="sig">\r
76         <a id="Ext.data.ScriptTagProxy-listeners"></a>\r
77             <b>listeners</b> : Object            <div class="mdesc">\r
78                         <div class="short">(optional) A config object containing one or more event handlers to be added to this object during initialization. Th...</div>\r
79             <div class="long">\r
80                 (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
81                         </div>\r
82         </td>\r
83         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#listeners" href="output/Ext.util.Observable.html#listeners">Observable</a></td>\r
84     </tr>\r
85         <tr class="config-row">\r
86         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
87         <td class="sig">\r
88         <a id="Ext.data.ScriptTagProxy-nocache"></a>\r
89             <b>nocache</b> : Boolean            <div class="mdesc">\r
90                             (optional) Defaults to true. Disable caching by adding a unique parameter name to the request.                        </div>\r
91         </td>\r
92         <td class="msource">ScriptTagProxy</td>\r
93     </tr>\r
94         <tr class="config-row alt">\r
95         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
96         <td class="sig">\r
97         <a id="Ext.data.ScriptTagProxy-timeout"></a>\r
98             <b>timeout</b> : Number            <div class="mdesc">\r
99                             (optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.                        </div>\r
100         </td>\r
101         <td class="msource">ScriptTagProxy</td>\r
102     </tr>\r
103         <tr class="config-row">\r
104         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
105         <td class="sig">\r
106         <a id="Ext.data.ScriptTagProxy-url"></a>\r
107             <b>url</b> : String            <div class="mdesc">\r
108                             The URL from which to request the data object.                        </div>\r
109         </td>\r
110         <td class="msource">ScriptTagProxy</td>\r
111     </tr>\r
112             </table>
113                 <a id="Ext.data.ScriptTagProxy-props"></a>
114         <h2>Public Properties</h2>
115         <div class="no-members">This class has no public properties.</div>        <a id="Ext.data.ScriptTagProxy-methods"></a>
116         <h2>Public Methods</h2>
117                 <table cellspacing="0" class="member-table">
118             <tr>
119                 <th class="sig-header" colspan="2">Method</th>
120                 <th class="msource-header">Defined By</th>
121             </tr>
122                 <tr class="method-row expandable">\r
123         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
124         <td class="sig">\r
125         <a id="Ext.data.ScriptTagProxy-ScriptTagProxy"></a>\r
126             <b>ScriptTagProxy</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">\r
127                         <div class="short"></div>\r
128             <div class="long">\r
129                     <div class="mdetail-params">\r
130         <strong>Parameters:</strong>\r
131         <ul><li><code>config</code> : Object<div class="sub-desc">A configuration object.</div></li>        </ul>\r
132         <strong>Returns:</strong>\r
133         <ul>\r
134             <li><code></code></li>\r
135         </ul>\r
136     </div>\r
137                 </div>\r
138                         </div>\r
139         </td>\r
140         <td class="msource">ScriptTagProxy</td>\r
141     </tr>\r
142         <tr class="method-row alt expandable">\r
143         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
144         <td class="sig">\r
145         <a id="Ext.data.ScriptTagProxy-abort"></a>\r
146             <b>abort</b>() : void            <div class="mdesc">\r
147                         <div class="short">Abort the current server request.</div>\r
148             <div class="long">\r
149                 Abort the current server request.    <div class="mdetail-params">\r
150         <strong>Parameters:</strong>\r
151         <ul><li>None.</li>        </ul>\r
152         <strong>Returns:</strong>\r
153         <ul>\r
154             <li><code>void</code></li>\r
155         </ul>\r
156     </div>\r
157                 </div>\r
158                         </div>\r
159         </td>\r
160         <td class="msource">ScriptTagProxy</td>\r
161     </tr>\r
162         <tr class="method-row inherited expandable">\r
163         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
164         <td class="sig">\r
165         <a id="Ext.data.ScriptTagProxy-addEvents"></a>\r
166             <b>addEvents</b>(&nbsp;<code>Object object</code>&nbsp;) : void            <div class="mdesc">\r
167                         <div class="short">Used to define events on this Observable</div>\r
168             <div class="long">\r
169                 Used to define events on this Observable    <div class="mdetail-params">\r
170         <strong>Parameters:</strong>\r
171         <ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li>        </ul>\r
172         <strong>Returns:</strong>\r
173         <ul>\r
174             <li><code>void</code></li>\r
175         </ul>\r
176     </div>\r
177                 </div>\r
178                         </div>\r
179         </td>\r
180         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addEvents" href="output/Ext.util.Observable.html#addEvents">Observable</a></td>\r
181     </tr>\r
182         <tr class="method-row inherited alt expandable">\r
183         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
184         <td class="sig">\r
185         <a id="Ext.data.ScriptTagProxy-addListener"></a>\r
186             <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
187                         <div class="short">Appends an event handler to this component</div>\r
188             <div class="long">\r
189                 Appends an event handler to this component    <div class="mdetail-params">\r
190         <strong>Parameters:</strong>\r
191         <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
192 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration
193 properties. This may contain any of the following properties:<ul>
194 <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>
195 <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>
196 <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>
197 <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
198 by the specified number of milliseconds. If the event fires again within that time, the original
199 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</p></li>
200 </ul><br>
201 <p>
202 <b>Combining Options</b><br>
203 Using the options argument, it is possible to combine different types of listeners:<br>
204 <br>
205 A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
206 <pre><code>el.on(<em>'click'</em>, <b>this</b>.onClick, <b>this</b>, {
207     single: true,
208     delay: 100,
209     forumId: 4
210 });</code></pre>
211 <p>
212 <b>Attaching multiple handlers in 1 call</b><br>
213 The method also allows for a single argument to be passed which is a config object containing properties
214 which specify multiple handlers.
215 <p>
216 <pre><code>foo.on({
217     <em>'click'</em> : {
218         fn: <b>this</b>.onClick,
219         scope: <b>this</b>,
220         delay: 100
221     },
222     <em>'mouseover'</em> : {
223         fn: <b>this</b>.onMouseOver,
224         scope: <b>this</b>
225     },
226     <em>'mouseout'</em> : {
227         fn: <b>this</b>.onMouseOut,
228         scope: <b>this</b>
229     }
230 });</code></pre>
231 <p>
232 Or a shorthand syntax:<br>
233 <pre><code>foo.on({
234     <em>'click'</em> : <b>this</b>.onClick,
235     <em>'mouseover'</em> : <b>this</b>.onMouseOver,
236     <em>'mouseout'</em> : <b>this</b>.onMouseOut,
237      scope: <b>this</b>
238 });</code></pre></div></li>        </ul>\r
239         <strong>Returns:</strong>\r
240         <ul>\r
241             <li><code>void</code></li>\r
242         </ul>\r
243     </div>\r
244                 </div>\r
245                         </div>\r
246         </td>\r
247         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#addListener" href="output/Ext.util.Observable.html#addListener">Observable</a></td>\r
248     </tr>\r
249         <tr class="method-row inherited expandable">\r
250         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
251         <td class="sig">\r
252         <a id="Ext.data.ScriptTagProxy-fireEvent"></a>\r
253             <b>fireEvent</b>(&nbsp;<code>String eventName</code>, <code>Object... args</code>&nbsp;) : Boolean            <div class="mdesc">\r
254                         <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>\r
255             <div class="long">\r
256                 Fires the specified event with the passed parameters (minus the event name).    <div class="mdetail-params">\r
257         <strong>Parameters:</strong>\r
258         <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
259         <strong>Returns:</strong>\r
260         <ul>\r
261             <li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>\r
262         </ul>\r
263     </div>\r
264                 </div>\r
265                         </div>\r
266         </td>\r
267         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#fireEvent" href="output/Ext.util.Observable.html#fireEvent">Observable</a></td>\r
268     </tr>\r
269         <tr class="method-row inherited alt expandable">\r
270         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
271         <td class="sig">\r
272         <a id="Ext.data.ScriptTagProxy-hasListener"></a>\r
273             <b>hasListener</b>(&nbsp;<code>String eventName</code>&nbsp;) : Boolean            <div class="mdesc">\r
274                         <div class="short">Checks to see if this object has any listeners for a specified event</div>\r
275             <div class="long">\r
276                 Checks to see if this object has any listeners for a specified event    <div class="mdetail-params">\r
277         <strong>Parameters:</strong>\r
278         <ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li>        </ul>\r
279         <strong>Returns:</strong>\r
280         <ul>\r
281             <li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li>\r
282         </ul>\r
283     </div>\r
284                 </div>\r
285                         </div>\r
286         </td>\r
287         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#hasListener" href="output/Ext.util.Observable.html#hasListener">Observable</a></td>\r
288     </tr>\r
289         <tr class="method-row expandable">\r
290         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
291         <td class="sig">\r
292         <a id="Ext.data.ScriptTagProxy-load"></a>\r
293             <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
294                         <div class="short">Load data from the configured URL, read the data object into
295 a block of Ext.data.Records using the passed Ext.data.Da...</div>\r
296             <div class="long">\r
297                 Load data from the configured URL, read the data object into
298 a block of Ext.data.Records using the passed Ext.data.DataReader implementation, and
299 process that block using the passed callback.    <div class="mdetail-params">\r
300         <strong>Parameters:</strong>\r
301         <ul><li><code>params</code> : Object<div class="sub-desc">An object containing properties which are to be used as HTTP parameters
302 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
303 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.
304 The function must be passed <ul>
305 <li>The Record block object</li>
306 <li>The "arg" argument from the load function</li>
307 <li>A boolean success indicator</li>
308 </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
309         <strong>Returns:</strong>\r
310         <ul>\r
311             <li><code>void</code></li>\r
312         </ul>\r
313     </div>\r
314                 </div>\r
315                         </div>\r
316         </td>\r
317         <td class="msource">ScriptTagProxy</td>\r
318     </tr>\r
319         <tr class="method-row inherited alt expandable">\r
320         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
321         <td class="sig">\r
322         <a id="Ext.data.ScriptTagProxy-on"></a>\r
323             <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
324                         <div class="short">Appends an event handler to this element (shorthand for addListener)</div>\r
325             <div class="long">\r
326                 Appends an event handler to this element (shorthand for addListener)    <div class="mdetail-params">\r
327         <strong>Parameters:</strong>\r
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 method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope in which to execute the handler
329 function. The handler function's "this" context.</div></li><li><code>options</code> : Object<div class="sub-desc">(optional)</div></li>        </ul>\r
330         <strong>Returns:</strong>\r
331         <ul>\r
332             <li><code>void</code></li>\r
333         </ul>\r
334     </div>\r
335                 </div>\r
336                         </div>\r
337         </td>\r
338         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#on" href="output/Ext.util.Observable.html#on">Observable</a></td>\r
339     </tr>\r
340         <tr class="method-row inherited expandable">\r
341         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
342         <td class="sig">\r
343         <a id="Ext.data.ScriptTagProxy-purgeListeners"></a>\r
344             <b>purgeListeners</b>() : void            <div class="mdesc">\r
345                         <div class="short">Removes all listeners for this object</div>\r
346             <div class="long">\r
347                 Removes all listeners for this object    <div class="mdetail-params">\r
348         <strong>Parameters:</strong>\r
349         <ul><li>None.</li>        </ul>\r
350         <strong>Returns:</strong>\r
351         <ul>\r
352             <li><code>void</code></li>\r
353         </ul>\r
354     </div>\r
355                 </div>\r
356                         </div>\r
357         </td>\r
358         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#purgeListeners" href="output/Ext.util.Observable.html#purgeListeners">Observable</a></td>\r
359     </tr>\r
360         <tr class="method-row inherited alt expandable">\r
361         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
362         <td class="sig">\r
363         <a id="Ext.data.ScriptTagProxy-relayEvents"></a>\r
364             <b>relayEvents</b>(&nbsp;<code>Object o</code>, <code>Array events</code>&nbsp;) : void            <div class="mdesc">\r
365                         <div class="short">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.</div>\r
366             <div class="long">\r
367                 Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.    <div class="mdetail-params">\r
368         <strong>Parameters:</strong>\r
369         <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
370         <strong>Returns:</strong>\r
371         <ul>\r
372             <li><code>void</code></li>\r
373         </ul>\r
374     </div>\r
375                 </div>\r
376                         </div>\r
377         </td>\r
378         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#relayEvents" href="output/Ext.util.Observable.html#relayEvents">Observable</a></td>\r
379     </tr>\r
380         <tr class="method-row inherited expandable">\r
381         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
382         <td class="sig">\r
383         <a id="Ext.data.ScriptTagProxy-removeListener"></a>\r
384             <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
385                         <div class="short">Removes a listener</div>\r
386             <div class="long">\r
387                 Removes a listener    <div class="mdetail-params">\r
388         <strong>Parameters:</strong>\r
389         <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
390         <strong>Returns:</strong>\r
391         <ul>\r
392             <li><code>void</code></li>\r
393         </ul>\r
394     </div>\r
395                 </div>\r
396                         </div>\r
397         </td>\r
398         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#removeListener" href="output/Ext.util.Observable.html#removeListener">Observable</a></td>\r
399     </tr>\r
400         <tr class="method-row inherited alt expandable">\r
401         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
402         <td class="sig">\r
403         <a id="Ext.data.ScriptTagProxy-resumeEvents"></a>\r
404             <b>resumeEvents</b>() : void            <div class="mdesc">\r
405                         <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
406             <div class="long">\r
407                 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
408         <strong>Parameters:</strong>\r
409         <ul><li>None.</li>        </ul>\r
410         <strong>Returns:</strong>\r
411         <ul>\r
412             <li><code>void</code></li>\r
413         </ul>\r
414     </div>\r
415                 </div>\r
416                         </div>\r
417         </td>\r
418         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#resumeEvents" href="output/Ext.util.Observable.html#resumeEvents">Observable</a></td>\r
419     </tr>\r
420         <tr class="method-row inherited expandable">\r
421         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
422         <td class="sig">\r
423         <a id="Ext.data.ScriptTagProxy-suspendEvents"></a>\r
424             <b>suspendEvents</b>() : void            <div class="mdesc">\r
425                         <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
426             <div class="long">\r
427                 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
428         <strong>Parameters:</strong>\r
429         <ul><li>None.</li>        </ul>\r
430         <strong>Returns:</strong>\r
431         <ul>\r
432             <li><code>void</code></li>\r
433         </ul>\r
434     </div>\r
435                 </div>\r
436                         </div>\r
437         </td>\r
438         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#suspendEvents" href="output/Ext.util.Observable.html#suspendEvents">Observable</a></td>\r
439     </tr>\r
440         <tr class="method-row inherited alt expandable">\r
441         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
442         <td class="sig">\r
443         <a id="Ext.data.ScriptTagProxy-un"></a>\r
444             <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
445                         <div class="short">Removes a listener (shorthand for removeListener)</div>\r
446             <div class="long">\r
447                 Removes a listener (shorthand for removeListener)    <div class="mdetail-params">\r
448         <strong>Parameters:</strong>\r
449         <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
450         <strong>Returns:</strong>\r
451         <ul>\r
452             <li><code>void</code></li>\r
453         </ul>\r
454     </div>\r
455                 </div>\r
456                         </div>\r
457         </td>\r
458         <td class="msource"><a ext:cls="Ext.util.Observable" ext:member="#un" href="output/Ext.util.Observable.html#un">Observable</a></td>\r
459     </tr>\r
460             </table>
461                 <a id="Ext.data.ScriptTagProxy-events"></a>
462         <h2>Public Events</h2>
463                 <table cellspacing="0" class="member-table">
464             <tr>
465                 <th class="sig-header" colspan="2">Event</th>
466                 <th class="msource-header">Defined By</th>
467             </tr>
468                 <tr class="event-row inherited expandable">\r
469         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
470         <td class="sig">\r
471         <a id="Ext.data.ScriptTagProxy-beforeload"></a>\r
472             <b>beforeload</b> : (&nbsp;<code>Object this</code>, <code>Object params</code>&nbsp;)            <div class="mdesc">\r
473                         <div class="short">Fires before a network request is made to retrieve a data object.</div>\r
474             <div class="long">\r
475                 Fires before a network request is made to retrieve a data object.    <div class="mdetail-params">\r
476         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
477         <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
478     </div>\r
479                 </div>\r
480                         </div>\r
481         </td>\r
482         <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
483     </tr>\r
484         <tr class="event-row inherited alt expandable">\r
485         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
486         <td class="sig">\r
487         <a id="Ext.data.ScriptTagProxy-load"></a>\r
488             <b>load</b> : (&nbsp;<code>Object this</code>, <code>Object o</code>, <code>Object arg</code>&nbsp;)            <div class="mdesc">\r
489                         <div class="short">Fires before the load method's callback is called.</div>\r
490             <div class="long">\r
491                 Fires before the load method's callback is called.    <div class="mdetail-params">\r
492         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
493         <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
494     </div>\r
495                 </div>\r
496                         </div>\r
497         </td>\r
498         <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
499     </tr>\r
500         <tr class="event-row expandable">\r
501         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
502         <td class="sig">\r
503         <a id="Ext.data.ScriptTagProxy-loadexception"></a>\r
504             <b>loadexception</b> : (&nbsp;<code>Object this</code>, <code>Object options</code>, <code>Object arg</code>, <code>Error e</code>&nbsp;)            <div class="mdesc">\r
505                         <div class="short">Fires if an exception occurs in the Proxy during data loading.  This event can be fired for one of two reasons:
506 The l...</div>\r
507             <div class="long">\r
508                 Fires if an exception occurs in the Proxy during data loading.  This event can be fired for one of two reasons:
509 <ul><li><b>The load call timed out.</b>  This means the load callback did not execute within the time limit
510 specified by <a ext:cls="Ext.data.ScriptTagProxy" ext:member="timeout" href="output/Ext.data.ScriptTagProxy.html#timeout">timeout</a>.  In this case, this event will be raised and the
511 fourth parameter (read error) will be null.</li>
512 <li><b>The load succeeded but the reader could not read the response.</b>  This means the server returned
513 data, but the configured Reader threw an error while reading the data.  In this case, this event will be 
514 raised and the caught error will be passed along as the fourth parameter of this event.</li></ul>
515 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
516 on any Store instance.    <div class="mdetail-params">\r
517         <strong style="font-weight:normal;">Listeners will be called with the following arguments:</strong>\r
518         <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.ScriptTagProxy" ext:member="load" href="output/Ext.data.ScriptTagProxy.html#load">load</a> for details). If the load
519 call timed out, this parameter will be null.</div></li><li><code>arg</code> : Object<div class="sub-desc">The callback's arg object passed to the <a ext:cls="Ext.data.ScriptTagProxy" ext:member="load" href="output/Ext.data.ScriptTagProxy.html#load">load</a> function</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.
520 If the load call returned success: false, this parameter will be null.</div></li>        </ul>\r
521     </div>\r
522                 </div>\r
523                         </div>\r
524         </td>\r
525         <td class="msource">ScriptTagProxy</td>\r
526     </tr>\r
527             </table>
528         
529         </div>