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