git.roojs.org Git - roojs1/blob - docs/symbols/Roo.CompositeElementLite.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.CompositeElementLite</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.CompositeElementLite-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.CompositeElementLite-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.CompositeElementLite-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.CompositeElementLite-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"><a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.CompositeElementLite
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.CompositeElementLite
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_CompositeElementLite.js.html">Roo/CompositeElementLite.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">CompositeElementLite</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.CompositeElement.html#constructor" roo:cls="Roo.CompositeElement.html#constructor">Roo.CompositeElement</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         Flyweight composite class. Reuses the same Roo.Element for element operations.<br/> <pre><code><br/> var els = Roo.select("<b>some</b>-el div.some-class");<br/> // or select directly from an existing element<br/> var el = Roo.get('some-el');<br/> el.select('div.some-class');<br/><br/> els.setWidth(100); // all elements become 100 width<br/> els.hide(true); // all elements fade out and hide<br/> // or<br/> els.setWidth(100).hide(true);<br/> </code></pre><br><br><br/><b>NOTE: Although they are not listed, this class supports all of the set/update methods of Roo.Element. All Roo.Element<br/>actions will be performed on all the elements in this collection.</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.CompositeElementLite';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.CompositeElementLite.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.CompositeElementLite-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.CompositeElementLite-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.CompositeElementLite-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-method-CompositeElementLite"   name=".CompositeElementLite"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">CompositeElementLite</b>
 183
 184                                  ()
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.CompositeElementLite</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.CompositeElementLite
 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           <tr class="method-row config-row-alt1 expandable notInherited">
 223             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 224
 225
 226             <td class="sig">
 227                 <a id="Roo.CompositeElementLite-method-each"   name=".each"></a>
 228                 <div class="fixedFont">
 229                         <span class="attributes"></span><b class="itemname">each</b>
 230
 231                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</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>)
 232
 233
 234                                          :
 235
 236
 237                                                 CompositeElement
 238
 239
 240
 241
 242
 243                 </div>
 244                 <div class="mdesc">
 245
 246                    <div class="short">Calls the passed function passing (el, this, index) for each element in this composite.</div>
 247
 248
 249
 250                     <div class="long">
 251
 252                                 Calls the passed function passing (el, this, index) for each element in this composite. <b>The element<br/>passed is the flyweight (shared) Roo.Element instance, so if you require a<br/>a reference to the dom node, use el.dom.</b>
 253
 254
 255
 256
 257
 258
 259                                 <dl class="detailList">
 260                                 <dt class="heading">Parameters:</dt>
 261
 262                                         <dt>
 263                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
 264
 265                                         </dt>
 266                                         <dd>The function to call</dd>
 267
 268                                         <dt>
 269                                                 <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>
 270
 271                                         </dt>
 272                                         <dd>(optional) The <i>this</i> object (defaults to the element)</dd>
 273
 274                                 </dl>
 275
 276
 277
 278
 279
 280                                 <dl class="detailList">
 281                                 <dt class="heading">Returns:</dt>
 282
 283                                         <dd><span class="fixedFont">CompositeElement</span>  this</dd>
 284
 285                                 </dl>
 286
 287
 288
 289
 290
 291
 292
 293                     </div>
 294                 </div>
 295
 296             </td>
 297             <td class="msource">
 298
 299                         Roo.CompositeElementLite
 300                 &nbsp;
 301             </td>
 302         </tr>
 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.CompositeElementLite-method-item"   name=".item"></a>
 311                 <div class="fixedFont">
 312                         <span class="attributes"></span><b class="itemname">item</b>
 313
 314                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
 315
 316
 317                                          :
 318
 319
 320                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 321
 322
 323
 324
 325
 326                 </div>
 327                 <div class="mdesc">
 328
 329                    <div class="short">Returns a flyweight Element of the dom element object at the specified index</div>
 330
 331
 332
 333                     <div class="long">
 334
 335                                 Returns a flyweight Element of the dom element object at the specified index
 336
 337
 338
 339
 340
 341
 342                                 <dl class="detailList">
 343                                 <dt class="heading">Parameters:</dt>
 344
 345                                         <dt>
 346                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>index</b>
 347
 348                                         </dt>
 349                                         <dd></dd>
 350
 351                                 </dl>
 352
 353
 354
 355
 356
 357                                 <dl class="detailList">
 358                                 <dt class="heading">Returns:</dt>
 359
 360                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
 361
 362                                 </dl>
 363
 364
 365
 366
 367
 368
 369
 370                     </div>
 371                 </div>
 372
 373             </td>
 374             <td class="msource">
 375
 376                         Roo.CompositeElementLite
 377                 &nbsp;
 378             </td>
 379         </tr>
 380
 381
 382     </table>
 383
 384
 385   <!-- ============================== events summary / details ======================== -->
 386
 387
 388   <a id="Roo.CompositeElementLite-events"></a>
 389
 390
 391
 392
 393
 394      <table cellspacing="0" class="member-table">
 395       <caption class="Empty">Events - Has None</caption>
 396      </table>
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406 <!-- ============================== footer ================================= -->
 407                 <div class="fineprint" style="clear:both">
 408
 409                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:11:47 GMT+0800 (HKT)
 410                         Based on
 411                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 412                 </div>
 413         </body>
 414 </html>