git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.DataProxy.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.DataProxy</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.DataProxy-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.data.DataProxy-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.data.DataProxy-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.data.DataProxy-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                 <div class="inheritance res-block">
  46                    <pre class="res-block-inner">Roo.data.Observable
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.DataProxy
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.data.DataProxy
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_data_DataProxy.js.html">Roo/data/DataProxy.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">DataProxy</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         Roo.data.Observable
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         This class is an abstract base class for implementations which provide retrieval of<br/>unformatted data objects.<br><br/><p><br/>DataProxy implementations are usually used in conjunction with an implementation of Roo.data.DataReader<br/>(of the appropriate type which knows how to parse the data object) to provide a block of<br/>{<b>link</b> Roo.data.Records} to an {<b>link</b> Roo.data.Store}.<br><br/><p><br/>Custom implementations must implement the load method as described in<br/>{<b>link</b> Roo.data.HttpProxy<b>load</b>}.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.DataProxy';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.data" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.data.DataProxy.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.data.DataProxy-configs"></a>
 108
 109
 110
 111      <table cellspacing="0" class="member-table">
 112       <caption class="Empty">Config Options - Has None</caption>
 113      </table>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126   <!-- ============================== public properties ==================== -->
 127
 128
 129
 130     <a id="Roo.data.DataProxy-props"></a>
 131
 132
 133
 134
 135
 136      <table cellspacing="0" class="member-table">
 137       <caption class="Empty">Public Properties - Has None</caption>
 138      </table>
 139
 140
 141
 142
 143   <!-- ============================== methods summary / details ======================== -->
 144
 145
 146   <a id="Roo.data.DataProxy-methods"></a>
 147         <!-- constructor?? -->
 148
 149         <!-- static's first
 150
 151
 152         -->
 153
 154         <!-- then dynamics first -->
 155
 156
 157
 158
 159
 160
 161       <table cellspacing="0" class="member-table">
 162       <caption>Public Methods</caption>
 163         <tr>
 164             <th class="sig-header" colspan="2">Method</th>
 165             <th class="msource-header">Defined By</th>
 166
 167         </tr>
 168
 169
 170
 171
 172
 173
 174
 175           <tr class="method-row config-row-alt0 notInherited">
 176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 177
 178
 179             <td class="sig">
 180                 <a id="Roo.data-method-DataProxy"   name=".DataProxy"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">DataProxy</b>
 183
 184                                  ()
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.data.DataProxy</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.data.DataProxy
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212                     </div>
 213                 </div>
 214
 215             </td>
 216             <td class="msource">
 217                 &nbsp;
 218             </td>
 219         </tr>
 220
 221
 222     </table>
 223
 224
 225   <!-- ============================== events summary / details ======================== -->
 226
 227
 228   <a id="Roo.data.DataProxy-events"></a>
 229
 230
 231
 232
 233
 234
 235
 236
 237       <table cellspacing="0" class="member-table">
 238                 <caption>Events</caption>
 239               <thead>
 240                 <tr>
 241                     <th class="sig-header" colspan="2">Event</th>
 242                     <th class="msource-header">Defined By</th>
 243
 244                 </tr>
 245               </thead>
 246
 247
 248
 249
 250
 251           <tr class="method-row expandable config-row-alt0 notInherited">
 252             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 253
 254             <td class="sig">
 255                 <a id="Roo.data.DataProxy-event-*beforeload"></a>
 256
 257                <div class="fixedFont">
 258                 <b class="itemname">beforeload</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>This</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>params</i></B>)
 259
 260                 </div>
 261
 262                 <div class="mdesc">
 263
 264                    <div class="short">Fires before a network request is made to retrieve a data object.
 265
 266                 </div>
 267
 268                     <div class="long">
 269
 270                         Fires before a network request is made to retrieve a data object.
 271
 272
 273
 274
 275
 276                                 <dl class="detailList">
 277                                 <dt class="heading">Parameters:</dt>
 278
 279                                         <dt>
 280                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>This</b>
 281
 282                                         </dt>
 283                                         <dd>DataProxy object.</dd>
 284
 285                                         <dt>
 286                                                 <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>
 287
 288                                         </dt>
 289                                         <dd>The params parameter to the load function.</dd>
 290
 291                                 </dl>
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303                     </div>
 304                 </div>
 305
 306             </td>
 307             <td class="msource">
 308                 Roo.data.DataProxy
 309             </td>
 310         </tr>
 311
 312           <tr class="method-row expandable config-row-alt1 notInherited">
 313             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 314
 315             <td class="sig">
 316                 <a id="Roo.data.DataProxy-event-*load"></a>
 317
 318                <div class="fixedFont">
 319                 <b class="itemname">load</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>This</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</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>)
 320
 321                 </div>
 322
 323                 <div class="mdesc">
 324
 325                    <div class="short">Fires before the load method's callback is called.
 326
 327                 </div>
 328
 329                     <div class="long">
 330
 331                         Fires before the load method's callback is called.
 332
 333
 334
 335
 336
 337                                 <dl class="detailList">
 338                                 <dt class="heading">Parameters:</dt>
 339
 340                                         <dt>
 341                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>This</b>
 342
 343                                         </dt>
 344                                         <dd>DataProxy object.</dd>
 345
 346                                         <dt>
 347                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>o</b>
 348
 349                                         </dt>
 350                                         <dd>The data object.</dd>
 351
 352                                         <dt>
 353                                                 <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>
 354
 355                                         </dt>
 356                                         <dd>The callback argument object passed to the load function.</dd>
 357
 358                                 </dl>
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370                     </div>
 371                 </div>
 372
 373             </td>
 374             <td class="msource">
 375                 Roo.data.DataProxy
 376             </td>
 377         </tr>
 378
 379           <tr class="method-row expandable config-row-alt0 notInherited">
 380             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 381
 382             <td class="sig">
 383                 <a id="Roo.data.DataProxy-event-*loadexception"></a>
 384
 385                <div class="fixedFont">
 386                 <b class="itemname">loadexception</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>This</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</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>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
 387
 388                 </div>
 389
 390                 <div class="mdesc">
 391
 392                    <div class="short">Fires if an Exception occurs during data retrieval.
 393
 394                 </div>
 395
 396                     <div class="long">
 397
 398                         Fires if an Exception occurs during data retrieval.
 399
 400
 401
 402
 403
 404                                 <dl class="detailList">
 405                                 <dt class="heading">Parameters:</dt>
 406
 407                                         <dt>
 408                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>This</b>
 409
 410                                         </dt>
 411                                         <dd>DataProxy object.</dd>
 412
 413                                         <dt>
 414                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>o</b>
 415
 416                                         </dt>
 417                                         <dd>The data object.</dd>
 418
 419                                         <dt>
 420                                                 <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>
 421
 422                                         </dt>
 423                                         <dd>The callback argument object passed to the load function.</dd>
 424
 425                                         <dt>
 426                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
 427
 428                                         </dt>
 429                                         <dd>The Exception.</dd>
 430
 431                                 </dl>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443                     </div>
 444                 </div>
 445
 446             </td>
 447             <td class="msource">
 448                 Roo.data.DataProxy
 449             </td>
 450         </tr>
 451
 452
 453     </table>
 454
 455
 456
 457
 458
 459 <!-- ============================== footer ================================= -->
 460                 <div class="fineprint" style="clear:both">
 461
 462                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:43:09 GMT+0800 (HKT)
 463                         Based on
 464                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 465                 </div>
 466         </body>
 467 </html>