git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.MemoryProxy.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.MemoryProxy</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.MemoryProxy-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.data.MemoryProxy-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.data.MemoryProxy-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.data.MemoryProxy-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.MemoryProxy
  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_MemoryProxy.js.html">Roo/data/MemoryProxy.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">MemoryProxy</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 simply passes the data specified in its constructor<br/>to the Reader when its load method is called.
  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.MemoryProxy';">[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.MemoryProxy.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.data.MemoryProxy-configs"></a>
  95
  96
  97
  98      <table cellspacing="0" class="member-table">
  99       <caption class="Empty">Config Options - Has None</caption>
 100      </table>
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113   <!-- ============================== public properties ==================== -->
 114
 115
 116
 117     <a id="Roo.data.MemoryProxy-props"></a>
 118
 119
 120
 121
 122
 123      <table cellspacing="0" class="member-table">
 124       <caption class="Empty">Public Properties - Has None</caption>
 125      </table>
 126
 127
 128
 129
 130   <!-- ============================== methods summary / details ======================== -->
 131
 132
 133   <a id="Roo.data.MemoryProxy-methods"></a>
 134         <!-- constructor?? -->
 135
 136         <!-- static's first
 137
 138
 139         -->
 140
 141         <!-- then dynamics first -->
 142
 143
 144
 145
 146
 147
 148       <table cellspacing="0" class="member-table">
 149       <caption>Public Methods</caption>
 150         <tr>
 151             <th class="sig-header" colspan="2">Method</th>
 152             <th class="msource-header">Defined By</th>
 153
 154         </tr>
 155
 156
 157
 158
 159
 160
 161
 162           <tr class="method-row config-row-alt0 expandable notInherited">
 163             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 164
 165
 166             <td class="sig">
 167                 <a id="Roo.data-method-MemoryProxy"   name=".MemoryProxy"></a>
 168                 <div class="fixedFont">
 169                         <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">MemoryProxy</b>
 170
 171                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
 172
 173
 174
 175                 </div>
 176                 <div class="mdesc">
 177
 178
 179                         <div class="short">Create a new Roo.data.MemoryProxy</div>
 180
 181
 182                     <div class="long">
 183
 184
 185
 186                                 Create a new Roo.data.MemoryProxy
 187
 188
 189                                 <dl class="detailList">
 190                                 <dt class="heading">Parameters:</dt>
 191
 192                                         <dt>
 193                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>data</b>
 194
 195                                         </dt>
 196                                         <dd>The data object which the Reader uses to construct a block of Roo.data.Records.</dd>
 197
 198                                 </dl>
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210                     </div>
 211                 </div>
 212
 213             </td>
 214             <td class="msource">
 215                 &nbsp;
 216             </td>
 217         </tr>
 218
 219
 220           <tr class="method-row config-row-alt1 expandable notInherited">
 221             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 222
 223
 224             <td class="sig">
 225                 <a id="Roo.data.MemoryProxy-method-load"   name=".load"></a>
 226                 <div class="fixedFont">
 227                         <span class="attributes"></span><b class="itemname">load</b>
 228
 229                                  (<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>)
 230
 231
 232
 233                 </div>
 234                 <div class="mdesc">
 235
 236                    <div class="short">Load data from the requested source (in this case an in-memory<br/>data object passed to the constructor), 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>
 237
 238
 239
 240                     <div class="long">
 241
 242                                 Load data from the requested source (in this case an in-memory<br/>data object passed to the constructor), 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.
 243
 244
 245
 246
 247
 248
 249                                 <dl class="detailList">
 250                                 <dt class="heading">Parameters:</dt>
 251
 252                                         <dt>
 253                                                 <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>
 254
 255                                         </dt>
 256                                         <dd>This parameter is not used by the MemoryProxy class.</dd>
 257
 258                                         <dt>
 259                                                 <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>
 260
 261                                         </dt>
 262                                         <dd>The Reader object which converts the data<br/>object into a block of Roo.data.Records.</dd>
 263
 264                                         <dt>
 265                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>callback</b>
 266
 267                                         </dt>
 268                                         <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>
 269
 270                                         <dt>
 271                                                 <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>
 272
 273                                         </dt>
 274                                         <dd>The scope in which to call the callback</dd>
 275
 276                                         <dt>
 277                                                 <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>
 278
 279                                         </dt>
 280                                         <dd>An optional argument which is passed to the callback as its second parameter.</dd>
 281
 282                                 </dl>
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294                     </div>
 295                 </div>
 296
 297             </td>
 298             <td class="msource">
 299
 300                         Roo.data.MemoryProxy
 301                 &nbsp;
 302             </td>
 303         </tr>
 304
 305
 306     </table>
 307
 308
 309   <!-- ============================== events summary / details ======================== -->
 310
 311
 312   <a id="Roo.data.MemoryProxy-events"></a>
 313
 314
 315
 316
 317
 318      <table cellspacing="0" class="member-table">
 319       <caption class="Empty">Events - Has None</caption>
 320      </table>
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330 <!-- ============================== footer ================================= -->
 331                 <div class="fineprint" style="clear:both">
 332
 333                         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)
 334                         Based on
 335                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 336                 </div>
 337         </body>
 338 </html>