1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.data.ScriptTagProxy</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.data.ScriptTagProxy-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.data.ScriptTagProxy-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.data.ScriptTagProxy-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.data.ScriptTagProxy-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <!-- ============================== class title / details ============================ -->
48 <h1 class="classTitle">
50 Class Roo.data.ScriptTagProxy
53 <table cellspacing="0" class="class-summary-table">
55 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
57 <tr><td class="label">Defined In:</td><td class="hd-info">
59 <a href="./src/Roo_data_ScriptTagProxy.js.html">Roo/data/ScriptTagProxy.js</a>.
62 <tr><td class="label">Class:</td><td class="hd-info">ScriptTagProxy</td></tr>
70 <!-- ============================== class summary ========================== -->
71 <div class="description">
72 An implementation of Roo.data.DataProxy that reads a data object from a URL which may be in a domain<br/>other than the originating domain of the running page.<br><br><br/><p><br/><em>Note that if you are retrieving data from a page that is in a domain that is NOT the same as the originating domain<br/>of the running page, you must use this class, rather than DataProxy.</em><br><br><br/><p><br/>The content passed back from a server resource requested by a ScriptTagProxy is executable JavaScript<br/>source code that is used as the source inside a <script> tag.<br><br><br/><p><br/>In order for the browser to process the returned data, the server must wrap the data object<br/>with a call to a callback function, the name of which is passed as a parameter by the ScriptTagProxy.<br/>Below is a Java example for a servlet which returns data for either a ScriptTagProxy, or an HttpProxy<br/>depending on whether the callback name was passed:<br/><p><br/><pre><code><br/>boolean scriptTag = false;<br/>String cb = request.getParameter("callback");<br/>if (cb != null) {<br/> scriptTag = true;<br/> response.setContentType("text/javascript");<br/>} else {<br/> response.setContentType("application/x-json");<br/>}<br/>Writer out = response.getWriter();<br/>if (scriptTag) {<br/> out.write(cb + "(");<br/>}<br/>out.print(dataBlock.toJsonString());<br/>if (scriptTag) {<br/> out.write(");");<br/>}<br/></pre></code>
76 <!-- ============================== Class comment block... ========================== -->
78 <div class="comments">
79 <b>Class Comments / Notes</B> =>
80 <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.ScriptTagProxy';">[Add Your comment/notes about this class]</u>
82 <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
83 src="/blog.php/GtkDjsComments/Roo.data.ScriptTagProxy.html"></iframe>
88 <!-- ============================== config options ========================== -->
93 <div class="hr"></div>
94 <a id="Roo.data.ScriptTagProxy-configs"></a>
100 <table cellspacing="0" class="member-table">
101 <caption>Config Options (Usually are also Properties)</caption>
105 <th class="sig-header" colspan="2">Options</th>
107 <th class="msource-header">Defined By</th>
114 <tr class="config-row expandable config-row-alt0 notInherited">
115 <td class="micon"><a class="exi" href="#expand"> </a></td>
118 <a id="Roo.data.ScriptTagProxy-cfg-callbackParam" name=".callbackParam"></a>
119 <div class="fixedFont">
120 <b class="itemname">callbackParam</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
126 <div class="short">(Optional) The name of the parameter to pass to the server which tells<br/>the server the name of the callback function set up by the load call to process the returned data object.</div>
130 <div class="long">(Optional) The name of the parameter to pass to the server which tells<br/>the server the name of the callback function set up by the load call to process the returned data object.<br/>Defaults to "callback".<p>The server-side processing must read this parameter value, and generate<br/>javascript output which calls this named function passing the data object as its only parameter.</div>
138 Roo.data.ScriptTagProxy
144 <tr class="config-row expandable config-row-alt1 notInherited">
145 <td class="micon"><a class="exi" href="#expand"> </a></td>
148 <a id="Roo.data.ScriptTagProxy-cfg-nocache" name=".nocache"></a>
149 <div class="fixedFont">
150 <b class="itemname">nocache</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
156 <div class="short">(Optional) Defaults to true.</div>
160 <div class="long">(Optional) Defaults to true. Disable cacheing by adding a unique parameter<br/>name to the request.</div>
168 Roo.data.ScriptTagProxy
174 <tr class="config-row expandable config-row-alt0 notInherited">
175 <td class="micon"><a class="exi" href="#expand"> </a></td>
178 <a id="Roo.data.ScriptTagProxy-cfg-timeout" name=".timeout"></a>
179 <div class="fixedFont">
180 <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
186 <div class="short">(Optional) The number of milliseconds to wait for a response.</div>
190 <div class="long">(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.</div>
198 Roo.data.ScriptTagProxy
204 <tr class="config-row expandable config-row-alt1 notInherited">
205 <td class="micon"><a class="exi" href="#expand"> </a></td>
208 <a id="Roo.data.ScriptTagProxy-cfg-url" name=".url"></a>
209 <div class="fixedFont">
210 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
216 <div class="short">The URL from which to request the data object.</div>
220 <div class="long">The URL from which to request the data object.</div>
228 Roo.data.ScriptTagProxy
244 <!-- ============================== public properties ==================== -->
248 <a id="Roo.data.ScriptTagProxy-props"></a>
254 <table cellspacing="0" class="member-table">
255 <caption class="Empty">Public Properties - Has None</caption>
261 <!-- ============================== methods summary / details ======================== -->
264 <a id="Roo.data.ScriptTagProxy-methods"></a>
265 <!-- constructor?? -->
272 <!-- then dynamics first -->
279 <table cellspacing="0" class="member-table">
280 <caption>Public Methods</caption>
282 <th class="sig-header" colspan="2">Method</th>
283 <th class="msource-header">Defined By</th>
293 <tr class="method-row config-row-alt0 expandable notInherited">
294 <td class="micon"><a class="exi" href="#expand"> </a></td>
298 <a id="Roo.data-method-ScriptTagProxy" name=".ScriptTagProxy"></a>
299 <div class="fixedFont">
300 <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">ScriptTagProxy</b>
302 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
310 <div class="short">Create a new Roo.data.ScriptTagProxy</div>
317 Create a new Roo.data.ScriptTagProxy
320 <dl class="detailList">
321 <dt class="heading">Parameters:</dt>
324 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
327 <dd>A configuration object.</dd>
351 <tr class="method-row config-row-alt1 expandable notInherited">
352 <td class="micon"><a class="exi" href="#expand"> </a></td>
356 <a id="Roo.data.ScriptTagProxy-method-abort" name=".abort"></a>
357 <div class="fixedFont">
358 <span class="attributes"></span><b class="itemname">abort</b>
367 <div class="short">Abort the current server request.</div>
373 Abort the current server request.
396 Roo.data.ScriptTagProxy
402 <tr class="method-row config-row-alt0 expandable notInherited">
403 <td class="micon"><a class="exi" href="#expand"> </a></td>
407 <a id="Roo.data.ScriptTagProxy-method-load" name=".load"></a>
408 <div class="fixedFont">
409 <span class="attributes"></span><b class="itemname">load</b>
411 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>params</i></B>, <a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a> <B><i>reader</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>arg</i></B>)
418 <div class="short">Load data from the configured URL, read the data object into<br/>a block of Roo.data.Records using the passed Roo.data.DataReader implementation, and<br/>process that block using the passed callback.</div>
424 Load data from the configured URL, read the data object into<br/>a block of Roo.data.Records using the passed Roo.data.DataReader implementation, and<br/>process that block using the passed callback.
431 <dl class="detailList">
432 <dt class="heading">Parameters:</dt>
435 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>params</b>
438 <dd>An object containing properties which are to be used as HTTP parameters<br/>for the request to the remote server.</dd>
441 <span class="fixedFont"><a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a></span> <b>reader</b>
444 <dd>The Reader object which converts the data<br/>object into a block of Roo.data.Records.</dd>
447 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
450 <dd>The function into which to pass the block of Roo.data.Records.<br/>The function must be passed <ul><br/><li>The Record block object</li><br/><li>The "arg" argument from the load function</li><br/><li>A boolean success indicator</li><br/></ul></dd>
453 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
456 <dd>The scope in which to call the callback</dd>
459 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>arg</b>
462 <dd>An optional argument which is passed to the callback as its second parameter.</dd>
482 Roo.data.ScriptTagProxy
491 <!-- ============================== events summary / details ======================== -->
494 <a id="Roo.data.ScriptTagProxy-events"></a>
500 <table cellspacing="0" class="member-table">
501 <caption class="Empty">Events - Has None</caption>
512 <!-- ============================== footer ================================= -->
513 <div class="fineprint" style="clear:both">
515 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Apr 01 2011 15:12:58 GMT+0800 (HKT)
517 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>