git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.ScriptTagProxy.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.data.ScriptTagProxy</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  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>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.data.ScriptTagProxy
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_data_ScriptTagProxy.js.html">Roo/data/ScriptTagProxy.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">ScriptTagProxy</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  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 &lt;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>
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  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>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo.data" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.data.ScriptTagProxy.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.data.ScriptTagProxy-configs"></a>
  95
  96
  97
  98
  99
 100       <table cellspacing="0" class="member-table">
 101       <caption>Config Options (Usually are also Properties)</caption>
 102
 103
 104         <tr>
 105             <th class="sig-header" colspan="2">Options</th>
 106
 107             <th class="msource-header">Defined By</th>
 108         </tr>
 109
 110
 111
 112
 113
 114                 <tr class="config-row expandable config-row-alt0 notInherited">
 115                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 116                     <td class="sig">
 117
 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>
 121
 122
 123                         </div>
 124
 125                         <div class="mdesc">
 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>
 127                         </div>
 128
 129                         <div class="mdesc">
 130                             <div class="long">
 131                     (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.
 132
 133                 </div>
 134                         </div>
 135
 136
 137
 138                     </td>
 139                     <td class="msource">
 140
 141                         Roo.data.ScriptTagProxy
 142
 143                     </td>
 144                 </tr>
 145
 146
 147                 <tr class="config-row expandable config-row-alt1 notInherited">
 148                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 149                     <td class="sig">
 150
 151                         <a id="Roo.data.ScriptTagProxy-cfg-nocache" name=".nocache"></a>
 152                         <div class="fixedFont">
 153                                 <b  class="itemname">nocache</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 154
 155
 156                         </div>
 157
 158                         <div class="mdesc">
 159                             <div class="short">(Optional) Defaults to true.</div>
 160                         </div>
 161
 162                         <div class="mdesc">
 163                             <div class="long">
 164                     (Optional) Defaults to true. Disable cacheing by adding a unique parameter<br/>name to the request.
 165
 166                 </div>
 167                         </div>
 168
 169
 170
 171                     </td>
 172                     <td class="msource">
 173
 174                         Roo.data.ScriptTagProxy
 175
 176                     </td>
 177                 </tr>
 178
 179
 180                 <tr class="config-row expandable config-row-alt0 notInherited">
 181                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 182                     <td class="sig">
 183
 184                         <a id="Roo.data.ScriptTagProxy-cfg-timeout" name=".timeout"></a>
 185                         <div class="fixedFont">
 186                                 <b  class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 187
 188
 189                         </div>
 190
 191                         <div class="mdesc">
 192                             <div class="short">(Optional) The number of milliseconds to wait for a response.</div>
 193                         </div>
 194
 195                         <div class="mdesc">
 196                             <div class="long">
 197                     (Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.
 198
 199                 </div>
 200                         </div>
 201
 202
 203
 204                     </td>
 205                     <td class="msource">
 206
 207                         Roo.data.ScriptTagProxy
 208
 209                     </td>
 210                 </tr>
 211
 212
 213                 <tr class="config-row expandable config-row-alt1 notInherited">
 214                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 215                     <td class="sig">
 216
 217                         <a id="Roo.data.ScriptTagProxy-cfg-url" name=".url"></a>
 218                         <div class="fixedFont">
 219                                 <b  class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 220
 221
 222                         </div>
 223
 224                         <div class="mdesc">
 225                             <div class="short">The URL from which to request the data object.</div>
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="long">
 230                     The URL from which to request the data object.
 231
 232                 </div>
 233                         </div>
 234
 235
 236
 237                     </td>
 238                     <td class="msource">
 239
 240                         Roo.data.ScriptTagProxy
 241
 242                     </td>
 243                 </tr>
 244
 245
 246     </table>
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256   <!-- ============================== public properties ==================== -->
 257
 258
 259
 260     <a id="Roo.data.ScriptTagProxy-props"></a>
 261
 262
 263
 264
 265
 266      <table cellspacing="0" class="member-table">
 267       <caption class="Empty">Public Properties - Has None</caption>
 268      </table>
 269
 270
 271
 272
 273   <!-- ============================== methods summary / details ======================== -->
 274
 275
 276   <a id="Roo.data.ScriptTagProxy-methods"></a>
 277         <!-- constructor?? -->
 278
 279         <!-- static's first
 280
 281
 282         -->
 283
 284         <!-- then dynamics first -->
 285
 286
 287
 288
 289
 290
 291       <table cellspacing="0" class="member-table">
 292       <caption>Public Methods</caption>
 293         <tr>
 294             <th class="sig-header" colspan="2">Method</th>
 295             <th class="msource-header">Defined By</th>
 296
 297         </tr>
 298
 299
 300
 301
 302
 303
 304
 305           <tr class="method-row config-row-alt0 expandable notInherited">
 306             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 307
 308
 309             <td class="sig">
 310                 <a id="Roo.data-method-ScriptTagProxy"   name=".ScriptTagProxy"></a>
 311                 <div class="fixedFont">
 312                         <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">ScriptTagProxy</b>
 313
 314                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 315
 316
 317
 318                 </div>
 319                 <div class="mdesc">
 320
 321
 322                         <div class="short">Create a new Roo.data.ScriptTagProxy</div>
 323
 324
 325                     <div class="long">
 326
 327
 328
 329                                 Create a new Roo.data.ScriptTagProxy
 330
 331
 332                                 <dl class="detailList">
 333                                 <dt class="heading">Parameters:</dt>
 334
 335                                         <dt>
 336                                                 <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>
 337
 338                                         </dt>
 339                                         <dd>A configuration object.</dd>
 340
 341                                 </dl>
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353                     </div>
 354                 </div>
 355
 356             </td>
 357             <td class="msource">
 358                 &nbsp;
 359             </td>
 360         </tr>
 361
 362
 363           <tr class="method-row config-row-alt1 expandable notInherited">
 364             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 365
 366
 367             <td class="sig">
 368                 <a id="Roo.data.ScriptTagProxy-method-abort"   name=".abort"></a>
 369                 <div class="fixedFont">
 370                         <span class="attributes"></span><b class="itemname">abort</b>
 371
 372                                  ()
 373
 374
 375
 376                 </div>
 377                 <div class="mdesc">
 378
 379                    <div class="short">Abort the current server request.</div>
 380
 381
 382
 383                     <div class="long">
 384
 385                                 Abort the current server request.
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402                     </div>
 403                 </div>
 404
 405             </td>
 406             <td class="msource">
 407
 408                         Roo.data.ScriptTagProxy
 409                 &nbsp;
 410             </td>
 411         </tr>
 412
 413
 414           <tr class="method-row config-row-alt0 expandable notInherited">
 415             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 416
 417
 418             <td class="sig">
 419                 <a id="Roo.data.ScriptTagProxy-method-load"   name=".load"></a>
 420                 <div class="fixedFont">
 421                         <span class="attributes"></span><b class="itemname">load</b>
 422
 423                                  (<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>)
 424
 425
 426
 427                 </div>
 428                 <div class="mdesc">
 429
 430                    <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>
 431
 432
 433
 434                     <div class="long">
 435
 436                                 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.
 437
 438
 439
 440
 441
 442
 443                                 <dl class="detailList">
 444                                 <dt class="heading">Parameters:</dt>
 445
 446                                         <dt>
 447                                                 <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>
 448
 449                                         </dt>
 450                                         <dd>An object containing properties which are to be used as HTTP parameters<br/>for the request to the remote server.</dd>
 451
 452                                         <dt>
 453                                                 <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>
 454
 455                                         </dt>
 456                                         <dd>The Reader object which converts the data<br/>object into a block of Roo.data.Records.</dd>
 457
 458                                         <dt>
 459                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
 460
 461                                         </dt>
 462                                         <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>
 463
 464                                         <dt>
 465                                                 <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>
 466
 467                                         </dt>
 468                                         <dd>The scope in which to call the callback</dd>
 469
 470                                         <dt>
 471                                                 <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>
 472
 473                                         </dt>
 474                                         <dd>An optional argument which is passed to the callback as its second parameter.</dd>
 475
 476                                 </dl>
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488                     </div>
 489                 </div>
 490
 491             </td>
 492             <td class="msource">
 493
 494                         Roo.data.ScriptTagProxy
 495                 &nbsp;
 496             </td>
 497         </tr>
 498
 499
 500     </table>
 501
 502
 503   <!-- ============================== events summary / details ======================== -->
 504
 505
 506   <a id="Roo.data.ScriptTagProxy-events"></a>
 507
 508
 509
 510
 511
 512      <table cellspacing="0" class="member-table">
 513       <caption class="Empty">Events - Has None</caption>
 514      </table>
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524 <!-- ============================== footer ================================= -->
 525                 <div class="fineprint" style="clear:both">
 526
 527                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
 528                         Based on
 529                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 530                 </div>
 531         </body>
 532 </html>