git.roojs.org Git - roojs1/blob - docs/symbols/Roo.View.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.View</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.View-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.View-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.View-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.View-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.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.View
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.View
  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_View.js.html">Roo/View.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">View</td></tr>
  70
  71
  72         <tr><td class="label">Subclasses:</td><td class="hd-info">
  73                 <a href="./Roo.JsonView.html#constructor" roo:cls="Roo.JsonView.html#constructor">Roo.JsonView</a>
  74
  75
  76
  77         </td></tr>
  78
  79
  80
  81                 <tr><td class="label">Extends:</td><td class="hd-info">
  82                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  83
  84                 </td></tr>
  85
  86
  87     </table>
  88
  89
  90 <!-- ============================== class summary ========================== -->
  91     <div class="description">
  92         Create a "View" for an element based on a data model or UpdateManager and the supplied DomHelper template. <br/>This class also supports single and multi selection modes. <br><br/>Create a data model bound view:<br/> <pre><code><br/> var store = new Roo.data.Store(...);<br/><br/> var view = new Roo.View("my-element",<br/> '&lt;div id="{0}"&gt;{2} - {1}&lt;/div&gt;', // auto create template<br/> {<br/> singleSelect: true,<br/> selectedClass: "ydataview-selected",<br/> store: store<br/> });<br/><br/> // listen for node click?<br/> view.on("click", function(vw, index, node, e){<br/> alert('Node "' + node.id + '" at index: ' + index + " was clicked.");<br/> });<br/><br/> // load XML data<br/> dataModel.load("foobar.xml");<br/> </code></pre><br/> For an example of creating a JSON/UpdateManager view, see {<b>link</b> Roo.JsonView}.<br/><br><br><br/><b>Note: The root of your template must be a single node. Table/row implementations may work but are not supported due to<br/>IE"s limited insertion support with tables and Opera"s faulty event bubbling.</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.View';">[Add Your comment/notes about this class]</u>
 101         <br/>
 102         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
 103                 src="/blog.php/GtkDjsComments/Roo.View.html"></iframe>
 104 </div>
 105
 106
 107
 108 <!-- ============================== config options ========================== -->
 109
 110
 111
 112
 113     <div class="hr"></div>
 114     <a id="Roo.View-configs"></a>
 115
 116
 117
 118
 119
 120       <table cellspacing="0" class="member-table">
 121       <caption>Config Options (Usually are also Properties)</caption>
 122
 123
 124         <tr>
 125             <th class="sig-header" colspan="2">Options</th>
 126
 127             <th class="msource-header">Defined By</th>
 128         </tr>
 129
 130
 131
 132
 133
 134                 <tr class="config-row expandable config-row-alt0">
 135                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 136                     <td class="sig">
 137
 138                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 139                         <div class="fixedFont">
 140                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 141
 142
 143                         </div>
 144
 145                         <div class="mdesc">
 146                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div>
 147                         </div>
 148
 149                         <div class="mdesc">
 150                             <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre></div>
 151                         </div>
 152
 153
 154
 155                     </td>
 156                     <td class="msource">
 157
 158                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 159
 160                     </td>
 161                 </tr>
 162
 163
 164     </table>
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174   <!-- ============================== public properties ==================== -->
 175
 176
 177
 178     <a id="Roo.View-props"></a>
 179
 180
 181
 182
 183
 184      <table cellspacing="0" class="member-table">
 185       <caption class="Empty">Public Properties - Has None</caption>
 186      </table>
 187
 188
 189
 190
 191   <!-- ============================== methods summary / details ======================== -->
 192
 193
 194   <a id="Roo.View-methods"></a>
 195         <!-- constructor?? -->
 196
 197         <!-- static's first
 198
 199
 200         -->
 201
 202         <!-- then dynamics first -->
 203
 204
 205
 206
 207
 208
 209       <table cellspacing="0" class="member-table">
 210       <caption>Public Methods</caption>
 211         <tr>
 212             <th class="sig-header" colspan="2">Method</th>
 213             <th class="msource-header">Defined By</th>
 214
 215         </tr>
 216
 217
 218
 219
 220
 221
 222
 223           <tr class="method-row config-row-alt0 expandable notInherited">
 224             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 225
 226
 227             <td class="sig">
 228                 <a id="Roo-method-View"   name=".View"></a>
 229                 <div class="fixedFont">
 230                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">View</b>
 231
 232                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/DomHelper.Template <B><i>tpl</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 233
 234
 235
 236                 </div>
 237                 <div class="mdesc">
 238
 239
 240                         <div class="short">Create a new Roo.View</div>
 241
 242
 243                     <div class="long">
 244
 245
 246
 247                                 Create a new Roo.View
 248
 249
 250                                 <dl class="detailList">
 251                                 <dt class="heading">Parameters:</dt>
 252
 253                                         <dt>
 254                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>container</b>
 255
 256                                         </dt>
 257                                         <dd>The container element where the view is to be rendered.</dd>
 258
 259                                         <dt>
 260                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/DomHelper.Template</span>  <b>tpl</b>
 261
 262                                         </dt>
 263                                         <dd>The rendering template or a string to create a template with</dd>
 264
 265                                         <dt>
 266                                                 <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>
 267
 268                                         </dt>
 269                                         <dd>The config object</dd>
 270
 271                                 </dl>
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283                     </div>
 284                 </div>
 285
 286             </td>
 287             <td class="msource">
 288                 &nbsp;
 289             </td>
 290         </tr>
 291
 292
 293           <tr class="method-row config-row-alt1 expandable">
 294             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 295
 296
 297             <td class="sig">
 298                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 299                 <div class="fixedFont">
 300                         <span class="attributes"></span><b class="itemname">addEvents</b>
 301
 302                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 303
 304
 305
 306                 </div>
 307                 <div class="mdesc">
 308
 309                    <div class="short">Used to define events on this Observable</div>
 310
 311
 312
 313                     <div class="long">
 314
 315                                 Used to define events on this Observable
 316
 317
 318
 319
 320
 321
 322                                 <dl class="detailList">
 323                                 <dt class="heading">Parameters:</dt>
 324
 325                                         <dt>
 326                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
 327
 328                                         </dt>
 329                                         <dd>The object with the events defined</dd>
 330
 331                                 </dl>
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343                     </div>
 344                 </div>
 345
 346             </td>
 347             <td class="msource">
 348
 349                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 350                 &nbsp;
 351             </td>
 352         </tr>
 353
 354
 355           <tr class="method-row config-row-alt0 expandable">
 356             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 357
 358
 359             <td class="sig">
 360                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 361                 <div class="fixedFont">
 362                         <span class="attributes"></span><b class="itemname">addListener</b>
 363
 364                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>options</i></B>)
 365
 366
 367
 368                 </div>
 369                 <div class="mdesc">
 370
 371                    <div class="short">Appends an event handler to this component</div>
 372
 373
 374
 375                     <div class="long">
 376
 377                                 Appends an event handler to this component
 378
 379
 380
 381
 382
 383
 384                                 <dl class="detailList">
 385                                 <dt class="heading">Parameters:</dt>
 386
 387                                         <dt>
 388                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 389
 390                                         </dt>
 391                                         <dd>The type of event to listen for</dd>
 392
 393                                         <dt>
 394                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 395
 396                                         </dt>
 397                                         <dd>The method the event invokes</dd>
 398
 399                                         <dt>
 400                                                 <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>
 401
 402                                         </dt>
 403                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 404
 405                                         <dt>
 406                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
 407
 408                                         </dt>
 409                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<br/>                </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/>               el.on({<br/>                    'click': {<br/>                 fn: this.onClick,<br/>                  scope: this,<br/>                       delay: 100<br/>                 }, <br/>                'mouseover': {<br/>                     fn: this.onMouseOver,<br/>                      scope: this<br/>                },<br/>                 'mouseout': {<br/>                      fn: this.onMouseOut,<br/>                       scope: this<br/>                }<br/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
 410
 411                                 </dl>
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423                     </div>
 424                 </div>
 425
 426             </td>
 427             <td class="msource">
 428
 429                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 430                 &nbsp;
 431             </td>
 432         </tr>
 433
 434
 435           <tr class="method-row config-row-alt1 expandable notInherited">
 436             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 437
 438
 439             <td class="sig">
 440                 <a id="Roo.View-method-clearSelections"   name=".clearSelections"></a>
 441                 <div class="fixedFont">
 442                         <span class="attributes"></span><b class="itemname">clearSelections</b>
 443
 444                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
 445
 446
 447
 448                 </div>
 449                 <div class="mdesc">
 450
 451                    <div class="short">Clear all selections</div>
 452
 453
 454
 455                     <div class="long">
 456
 457                                 Clear all selections
 458
 459
 460
 461
 462
 463
 464                                 <dl class="detailList">
 465                                 <dt class="heading">Parameters:</dt>
 466
 467                                         <dt>
 468                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>suppressEvent</b>
 469
 470                                         </dt>
 471                                         <dd>(optional) true to skip firing of the selectionchange event</dd>
 472
 473                                 </dl>
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485                     </div>
 486                 </div>
 487
 488             </td>
 489             <td class="msource">
 490
 491                         Roo.View
 492                 &nbsp;
 493             </td>
 494         </tr>
 495
 496
 497           <tr class="method-row config-row-alt0 expandable notInherited">
 498             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 499
 500
 501             <td class="sig">
 502                 <a id="Roo.View-method-findItemFromChild"   name=".findItemFromChild"></a>
 503                 <div class="fixedFont">
 504                         <span class="attributes"></span><b class="itemname">findItemFromChild</b>
 505
 506                                  (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
 507
 508
 509                                          :
 510
 511
 512                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
 513
 514
 515
 516
 517
 518                 </div>
 519                 <div class="mdesc">
 520
 521                    <div class="short">Returns the template node the passed child belongs to or null if it doesn't belong to one.</div>
 522
 523
 524
 525                     <div class="long">
 526
 527                                 Returns the template node the passed child belongs to or null if it doesn't belong to one.
 528
 529
 530
 531
 532
 533
 534                                 <dl class="detailList">
 535                                 <dt class="heading">Parameters:</dt>
 536
 537                                         <dt>
 538                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>node</b>
 539
 540                                         </dt>
 541                                         <dd></dd>
 542
 543                                 </dl>
 544
 545
 546
 547
 548
 549                                 <dl class="detailList">
 550                                 <dt class="heading">Returns:</dt>
 551
 552                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  The template node</dd>
 553
 554                                 </dl>
 555
 556
 557
 558
 559
 560
 561
 562                     </div>
 563                 </div>
 564
 565             </td>
 566             <td class="msource">
 567
 568                         Roo.View
 569                 &nbsp;
 570             </td>
 571         </tr>
 572
 573
 574           <tr class="method-row config-row-alt1 expandable">
 575             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 576
 577
 578             <td class="sig">
 579                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 580                 <div class="fixedFont">
 581                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 582
 583                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
 584
 585
 586                                          :
 587
 588
 589                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 590
 591
 592
 593
 594
 595                 </div>
 596                 <div class="mdesc">
 597
 598                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 599
 600
 601
 602                     <div class="long">
 603
 604                                 Fires the specified event with the passed parameters (minus the event name).
 605
 606
 607
 608
 609
 610
 611                                 <dl class="detailList">
 612                                 <dt class="heading">Parameters:</dt>
 613
 614                                         <dt>
 615                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 616
 617                                         </dt>
 618                                         <dd></dd>
 619
 620                                         <dt>
 621                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
 622
 623                                         </dt>
 624                                         <dd>Variable number of parameters are passed to handlers</dd>
 625
 626                                 </dl>
 627
 628
 629
 630
 631
 632                                 <dl class="detailList">
 633                                 <dt class="heading">Returns:</dt>
 634
 635                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
 636
 637                                 </dl>
 638
 639
 640
 641
 642
 643
 644
 645                     </div>
 646                 </div>
 647
 648             </td>
 649             <td class="msource">
 650
 651                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 652                 &nbsp;
 653             </td>
 654         </tr>
 655
 656
 657           <tr class="method-row config-row-alt0 expandable notInherited">
 658             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 659
 660
 661             <td class="sig">
 662                 <a id="Roo.View-method-getEl"   name=".getEl"></a>
 663                 <div class="fixedFont">
 664                         <span class="attributes"></span><b class="itemname">getEl</b>
 665
 666                                  ()
 667
 668
 669                                          :
 670
 671
 672                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 673
 674
 675
 676
 677
 678                 </div>
 679                 <div class="mdesc">
 680
 681                    <div class="short">Returns the element this view is bound to.</div>
 682
 683
 684
 685                     <div class="long">
 686
 687                                 Returns the element this view is bound to.
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698                                 <dl class="detailList">
 699                                 <dt class="heading">Returns:</dt>
 700
 701                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  </dd>
 702
 703                                 </dl>
 704
 705
 706
 707
 708
 709
 710
 711                     </div>
 712                 </div>
 713
 714             </td>
 715             <td class="msource">
 716
 717                         Roo.View
 718                 &nbsp;
 719             </td>
 720         </tr>
 721
 722
 723           <tr class="method-row config-row-alt1 expandable notInherited">
 724             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 725
 726
 727             <td class="sig">
 728                 <a id="Roo.View-method-getNode"   name=".getNode"></a>
 729                 <div class="fixedFont">
 730                         <span class="attributes"></span><b class="itemname">getNode</b>
 731
 732                                  (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number <B><i>nodeInfo</i></B>)
 733
 734
 735                                          :
 736
 737
 738                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
 739
 740
 741
 742
 743
 744                 </div>
 745                 <div class="mdesc">
 746
 747                    <div class="short">Gets a template node.</div>
 748
 749
 750
 751                     <div class="long">
 752
 753                                 Gets a template node.
 754
 755
 756
 757
 758
 759
 760                                 <dl class="detailList">
 761                                 <dt class="heading">Parameters:</dt>
 762
 763                                         <dt>
 764                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number</span>  <b>nodeInfo</b>
 765
 766                                         </dt>
 767                                         <dd>An HTMLElement template node, index of a template node or the id of a template node</dd>
 768
 769                                 </dl>
 770
 771
 772
 773
 774
 775                                 <dl class="detailList">
 776                                 <dt class="heading">Returns:</dt>
 777
 778                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  The node or null if it wasn't found</dd>
 779
 780                                 </dl>
 781
 782
 783
 784
 785
 786
 787
 788                     </div>
 789                 </div>
 790
 791             </td>
 792             <td class="msource">
 793
 794                         Roo.View
 795                 &nbsp;
 796             </td>
 797         </tr>
 798
 799
 800           <tr class="method-row config-row-alt0 expandable notInherited">
 801             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 802
 803
 804             <td class="sig">
 805                 <a id="Roo.View-method-getNodes"   name=".getNodes"></a>
 806                 <div class="fixedFont">
 807                         <span class="attributes"></span><b class="itemname">getNodes</b>
 808
 809                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>startIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>endIndex</i></B>)
 810
 811
 812                                          :
 813
 814
 815                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 816
 817
 818
 819
 820
 821                 </div>
 822                 <div class="mdesc">
 823
 824                    <div class="short">Gets a range template nodes.</div>
 825
 826
 827
 828                     <div class="long">
 829
 830                                 Gets a range template nodes.
 831
 832
 833
 834
 835
 836
 837                                 <dl class="detailList">
 838                                 <dt class="heading">Parameters:</dt>
 839
 840                                         <dt>
 841                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>startIndex</b>
 842
 843                                         </dt>
 844                                         <dd></dd>
 845
 846                                         <dt>
 847                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>endIndex</b>
 848
 849                                         </dt>
 850                                         <dd></dd>
 851
 852                                 </dl>
 853
 854
 855
 856
 857
 858                                 <dl class="detailList">
 859                                 <dt class="heading">Returns:</dt>
 860
 861                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  An array of nodes</dd>
 862
 863                                 </dl>
 864
 865
 866
 867
 868
 869
 870
 871                     </div>
 872                 </div>
 873
 874             </td>
 875             <td class="msource">
 876
 877                         Roo.View
 878                 &nbsp;
 879             </td>
 880         </tr>
 881
 882
 883           <tr class="method-row config-row-alt1 expandable notInherited">
 884             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 885
 886
 887             <td class="sig">
 888                 <a id="Roo.View-method-getSelectedIndexes"   name=".getSelectedIndexes"></a>
 889                 <div class="fixedFont">
 890                         <span class="attributes"></span><b class="itemname">getSelectedIndexes</b>
 891
 892                                  ()
 893
 894
 895                                          :
 896
 897
 898                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 899
 900
 901
 902
 903
 904                 </div>
 905                 <div class="mdesc">
 906
 907                    <div class="short">Get the indexes of the selected nodes.</div>
 908
 909
 910
 911                     <div class="long">
 912
 913                                 Get the indexes of the selected nodes.
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924                                 <dl class="detailList">
 925                                 <dt class="heading">Returns:</dt>
 926
 927                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  </dd>
 928
 929                                 </dl>
 930
 931
 932
 933
 934
 935
 936
 937                     </div>
 938                 </div>
 939
 940             </td>
 941             <td class="msource">
 942
 943                         Roo.View
 944                 &nbsp;
 945             </td>
 946         </tr>
 947
 948
 949           <tr class="method-row config-row-alt0 expandable notInherited">
 950             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 951
 952
 953             <td class="sig">
 954                 <a id="Roo.View-method-getSelectedNodes"   name=".getSelectedNodes"></a>
 955                 <div class="fixedFont">
 956                         <span class="attributes"></span><b class="itemname">getSelectedNodes</b>
 957
 958                                  ()
 959
 960
 961                                          :
 962
 963
 964                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 965
 966
 967
 968
 969
 970                 </div>
 971                 <div class="mdesc">
 972
 973                    <div class="short">Get the currently selected nodes.</div>
 974
 975
 976
 977                     <div class="long">
 978
 979                                 Get the currently selected nodes.
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990                                 <dl class="detailList">
 991                                 <dt class="heading">Returns:</dt>
 992
 993                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  An array of HTMLElements</dd>
 994
 995                                 </dl>
 996
 997
 998
 999
1000
1001
1002
1003                     </div>
1004                 </div>
1005
1006             </td>
1007             <td class="msource">
1008
1009                         Roo.View
1010                 &nbsp;
1011             </td>
1012         </tr>
1013
1014
1015           <tr class="method-row config-row-alt1 expandable notInherited">
1016             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1017
1018
1019             <td class="sig">
1020                 <a id="Roo.View-method-getSelectionCount"   name=".getSelectionCount"></a>
1021                 <div class="fixedFont">
1022                         <span class="attributes"></span><b class="itemname">getSelectionCount</b>
1023
1024                                  ()
1025
1026
1027                                          :
1028
1029
1030                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1031
1032
1033
1034
1035
1036                 </div>
1037                 <div class="mdesc">
1038
1039                    <div class="short">Get the number of selected nodes.</div>
1040
1041
1042
1043                     <div class="long">
1044
1045                                 Get the number of selected nodes.
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056                                 <dl class="detailList">
1057                                 <dt class="heading">Returns:</dt>
1058
1059                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  </dd>
1060
1061                                 </dl>
1062
1063
1064
1065
1066
1067
1068
1069                     </div>
1070                 </div>
1071
1072             </td>
1073             <td class="msource">
1074
1075                         Roo.View
1076                 &nbsp;
1077             </td>
1078         </tr>
1079
1080
1081           <tr class="method-row config-row-alt0 expandable">
1082             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1083
1084
1085             <td class="sig">
1086                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
1087                 <div class="fixedFont">
1088                         <span class="attributes"></span><b class="itemname">hasListener</b>
1089
1090                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1091
1092
1093                                          :
1094
1095
1096                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1097
1098
1099
1100
1101
1102                 </div>
1103                 <div class="mdesc">
1104
1105                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
1106
1107
1108
1109                     <div class="long">
1110
1111                                 Checks to see if this object has any listeners for a specified event
1112
1113
1114
1115
1116
1117
1118                                 <dl class="detailList">
1119                                 <dt class="heading">Parameters:</dt>
1120
1121                                         <dt>
1122                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1123
1124                                         </dt>
1125                                         <dd>The name of the event to check for</dd>
1126
1127                                 </dl>
1128
1129
1130
1131
1132
1133                                 <dl class="detailList">
1134                                 <dt class="heading">Returns:</dt>
1135
1136                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if the event is being listened for, else false</dd>
1137
1138                                 </dl>
1139
1140
1141
1142
1143
1144
1145
1146                     </div>
1147                 </div>
1148
1149             </td>
1150             <td class="msource">
1151
1152                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1153                 &nbsp;
1154             </td>
1155         </tr>
1156
1157
1158           <tr class="method-row config-row-alt1 expandable notInherited">
1159             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1160
1161
1162             <td class="sig">
1163                 <a id="Roo.View-method-indexOf"   name=".indexOf"></a>
1164                 <div class="fixedFont">
1165                         <span class="attributes"></span><b class="itemname">indexOf</b>
1166
1167                                  (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number <B><i>nodeInfo</i></B>)
1168
1169
1170                                          :
1171
1172
1173                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1174
1175
1176
1177
1178
1179                 </div>
1180                 <div class="mdesc">
1181
1182                    <div class="short">Finds the index of the passed node</div>
1183
1184
1185
1186                     <div class="long">
1187
1188                                 Finds the index of the passed node
1189
1190
1191
1192
1193
1194
1195                                 <dl class="detailList">
1196                                 <dt class="heading">Parameters:</dt>
1197
1198                                         <dt>
1199                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/String/Number</span>  <b>nodeInfo</b>
1200
1201                                         </dt>
1202                                         <dd>An HTMLElement template node, index of a template node or the id of a template node</dd>
1203
1204                                 </dl>
1205
1206
1207
1208
1209
1210                                 <dl class="detailList">
1211                                 <dt class="heading">Returns:</dt>
1212
1213                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  The index of the node or -1</dd>
1214
1215                                 </dl>
1216
1217
1218
1219
1220
1221
1222
1223                     </div>
1224                 </div>
1225
1226             </td>
1227             <td class="msource">
1228
1229                         Roo.View
1230                 &nbsp;
1231             </td>
1232         </tr>
1233
1234
1235           <tr class="method-row config-row-alt0 expandable notInherited">
1236             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1237
1238
1239             <td class="sig">
1240                 <a id="Roo.View-method-isSelected"   name=".isSelected"></a>
1241                 <div class="fixedFont">
1242                         <span class="attributes"></span><b class="itemname">isSelected</b>
1243
1244                                  (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Number <B><i>node</i></B>)
1245
1246
1247                                          :
1248
1249
1250                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1251
1252
1253
1254
1255
1256                 </div>
1257                 <div class="mdesc">
1258
1259                    <div class="short">Returns true if the passed node is selected</div>
1260
1261
1262
1263                     <div class="long">
1264
1265                                 Returns true if the passed node is selected
1266
1267
1268
1269
1270
1271
1272                                 <dl class="detailList">
1273                                 <dt class="heading">Parameters:</dt>
1274
1275                                         <dt>
1276                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>/Number</span>  <b>node</b>
1277
1278                                         </dt>
1279                                         <dd>The node or node index</dd>
1280
1281                                 </dl>
1282
1283
1284
1285
1286
1287                                 <dl class="detailList">
1288                                 <dt class="heading">Returns:</dt>
1289
1290                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
1291
1292                                 </dl>
1293
1294
1295
1296
1297
1298
1299
1300                     </div>
1301                 </div>
1302
1303             </td>
1304             <td class="msource">
1305
1306                         Roo.View
1307                 &nbsp;
1308             </td>
1309         </tr>
1310
1311
1312           <tr class="method-row config-row-alt1 expandable">
1313             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1314
1315
1316             <td class="sig">
1317                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
1318                 <div class="fixedFont">
1319                         <span class="attributes"></span><b class="itemname">on</b>
1320
1321                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>options</i></B>)
1322
1323
1324
1325                 </div>
1326                 <div class="mdesc">
1327
1328                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1329
1330
1331
1332                     <div class="long">
1333
1334                                 Appends an event handler to this element (shorthand for addListener)
1335
1336
1337
1338
1339
1340
1341                                 <dl class="detailList">
1342                                 <dt class="heading">Parameters:</dt>
1343
1344                                         <dt>
1345                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1346
1347                                         </dt>
1348                                         <dd>The type of event to listen for</dd>
1349
1350                                         <dt>
1351                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1352
1353                                         </dt>
1354                                         <dd>The method the event invokes</dd>
1355
1356                                         <dt>
1357                                                 <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>
1358
1359                                         </dt>
1360                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1361
1362                                         <dt>
1363                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
1364
1365                                         </dt>
1366                                         <dd>(optional)</dd>
1367
1368                                 </dl>
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380                     </div>
1381                 </div>
1382
1383             </td>
1384             <td class="msource">
1385
1386                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1387                 &nbsp;
1388             </td>
1389         </tr>
1390
1391
1392           <tr class="method-row config-row-alt0 expandable notInherited">
1393             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1394
1395
1396             <td class="sig">
1397                 <a id="Roo.View-method-prepareData"   name=".prepareData"></a>
1398                 <div class="fixedFont">
1399                         <span class="attributes"></span><b class="itemname">prepareData</b>
1400
1401                                  (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object <B><i>data</i></B>)
1402
1403
1404
1405                 </div>
1406                 <div class="mdesc">
1407
1408                    <div class="short">Function to override to reformat the data that is sent to<br/>the template for each node.</div>
1409
1410
1411
1412                     <div class="long">
1413
1414                                 Function to override to reformat the data that is sent to<br/>the template for each node.
1415
1416
1417
1418
1419
1420
1421                                 <dl class="detailList">
1422                                 <dt class="heading">Parameters:</dt>
1423
1424                                         <dt>
1425                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/Object</span>  <b>data</b>
1426
1427                                         </dt>
1428                                         <dd>The raw data (array of colData for a data model bound view or<br/>a JSON object for an UpdateManager bound view).</dd>
1429
1430                                 </dl>
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442                     </div>
1443                 </div>
1444
1445             </td>
1446             <td class="msource">
1447
1448                         Roo.View
1449                 &nbsp;
1450             </td>
1451         </tr>
1452
1453
1454           <tr class="method-row config-row-alt1 expandable">
1455             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1456
1457
1458             <td class="sig">
1459                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1460                 <div class="fixedFont">
1461                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1462
1463                                  ()
1464
1465
1466
1467                 </div>
1468                 <div class="mdesc">
1469
1470                    <div class="short">Removes all listeners for this object</div>
1471
1472
1473
1474                     <div class="long">
1475
1476                                 Removes all listeners for this object
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493                     </div>
1494                 </div>
1495
1496             </td>
1497             <td class="msource">
1498
1499                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1500                 &nbsp;
1501             </td>
1502         </tr>
1503
1504
1505           <tr class="method-row config-row-alt0 expandable notInherited">
1506             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1507
1508
1509             <td class="sig">
1510                 <a id="Roo.View-method-refresh"   name=".refresh"></a>
1511                 <div class="fixedFont">
1512                         <span class="attributes"></span><b class="itemname">refresh</b>
1513
1514                                  ()
1515
1516
1517
1518                 </div>
1519                 <div class="mdesc">
1520
1521                    <div class="short">Refreshes the view.</div>
1522
1523
1524
1525                     <div class="long">
1526
1527                                 Refreshes the view.
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544                     </div>
1545                 </div>
1546
1547             </td>
1548             <td class="msource">
1549
1550                         Roo.View
1551                 &nbsp;
1552             </td>
1553         </tr>
1554
1555
1556           <tr class="method-row config-row-alt1 expandable notInherited">
1557             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1558
1559
1560             <td class="sig">
1561                 <a id="Roo.View-method-refreshNode"   name=".refreshNode"></a>
1562                 <div class="fixedFont">
1563                         <span class="attributes"></span><b class="itemname">refreshNode</b>
1564
1565                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
1566
1567
1568
1569                 </div>
1570                 <div class="mdesc">
1571
1572                    <div class="short">Refresh an individual node.</div>
1573
1574
1575
1576                     <div class="long">
1577
1578                                 Refresh an individual node.
1579
1580
1581
1582
1583
1584
1585                                 <dl class="detailList">
1586                                 <dt class="heading">Parameters:</dt>
1587
1588                                         <dt>
1589                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>index</b>
1590
1591                                         </dt>
1592                                         <dd></dd>
1593
1594                                 </dl>
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606                     </div>
1607                 </div>
1608
1609             </td>
1610             <td class="msource">
1611
1612                         Roo.View
1613                 &nbsp;
1614             </td>
1615         </tr>
1616
1617
1618           <tr class="method-row config-row-alt0 expandable">
1619             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1620
1621
1622             <td class="sig">
1623                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1624                 <div class="fixedFont">
1625                         <span class="attributes"></span><b class="itemname">removeListener</b>
1626
1627                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>)
1628
1629
1630
1631                 </div>
1632                 <div class="mdesc">
1633
1634                    <div class="short">Removes a listener</div>
1635
1636
1637
1638                     <div class="long">
1639
1640                                 Removes a listener
1641
1642
1643
1644
1645
1646
1647                                 <dl class="detailList">
1648                                 <dt class="heading">Parameters:</dt>
1649
1650                                         <dt>
1651                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1652
1653                                         </dt>
1654                                         <dd>The type of event to listen for</dd>
1655
1656                                         <dt>
1657                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1658
1659                                         </dt>
1660                                         <dd>The handler to remove</dd>
1661
1662                                         <dt>
1663                                                 <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>
1664
1665                                         </dt>
1666                                         <dd>(optional) The scope (this object) for the handler</dd>
1667
1668                                 </dl>
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680                     </div>
1681                 </div>
1682
1683             </td>
1684             <td class="msource">
1685
1686                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1687                 &nbsp;
1688             </td>
1689         </tr>
1690
1691
1692           <tr class="method-row config-row-alt1 expandable notInherited">
1693             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1694
1695
1696             <td class="sig">
1697                 <a id="Roo.View-method-select"   name=".select"></a>
1698                 <div class="fixedFont">
1699                         <span class="attributes"></span><b class="itemname">select</b>
1700
1701                                  (<a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/HTMLElement/String/Number <B><i>nodeInfo</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>keepExisting</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
1702
1703
1704
1705                 </div>
1706                 <div class="mdesc">
1707
1708                    <div class="short">Selects nodes.</div>
1709
1710
1711
1712                     <div class="long">
1713
1714                                 Selects nodes.
1715
1716
1717
1718
1719
1720
1721                                 <dl class="detailList">
1722                                 <dt class="heading">Parameters:</dt>
1723
1724                                         <dt>
1725                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>/HTMLElement/String/Number</span>  <b>nodeInfo</b>
1726
1727                                         </dt>
1728                                         <dd>An HTMLElement template node, index of a template node, id of a template node or an array of any of those to select</dd>
1729
1730                                         <dt>
1731                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>keepExisting</b>
1732
1733                                         </dt>
1734                                         <dd>(optional) true to keep existing selections</dd>
1735
1736                                         <dt>
1737                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>suppressEvent</b>
1738
1739                                         </dt>
1740                                         <dd>(optional) true to skip firing of the selectionchange vent</dd>
1741
1742                                 </dl>
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754                     </div>
1755                 </div>
1756
1757             </td>
1758             <td class="msource">
1759
1760                         Roo.View
1761                 &nbsp;
1762             </td>
1763         </tr>
1764
1765
1766           <tr class="method-row config-row-alt0 expandable notInherited">
1767             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1768
1769
1770             <td class="sig">
1771                 <a id="Roo.View-method-setStore"   name=".setStore"></a>
1772                 <div class="fixedFont">
1773                         <span class="attributes"></span><b class="itemname">setStore</b>
1774
1775                                  (Store <B><i>store</i></B>)
1776
1777
1778
1779                 </div>
1780                 <div class="mdesc">
1781
1782                    <div class="short">Changes the data store this view uses and refresh the view.</div>
1783
1784
1785
1786                     <div class="long">
1787
1788                                 Changes the data store this view uses and refresh the view.
1789
1790
1791
1792
1793
1794
1795                                 <dl class="detailList">
1796                                 <dt class="heading">Parameters:</dt>
1797
1798                                         <dt>
1799                                                 <span class="fixedFont">Store</span>  <b>store</b>
1800
1801                                         </dt>
1802                                         <dd></dd>
1803
1804                                 </dl>
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816                     </div>
1817                 </div>
1818
1819             </td>
1820             <td class="msource">
1821
1822                         Roo.View
1823                 &nbsp;
1824             </td>
1825         </tr>
1826
1827
1828           <tr class="method-row config-row-alt1 expandable">
1829             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1830
1831
1832             <td class="sig">
1833                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1834                 <div class="fixedFont">
1835                         <span class="attributes"></span><b class="itemname">un</b>
1836
1837                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>)
1838
1839
1840
1841                 </div>
1842                 <div class="mdesc">
1843
1844                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1845
1846
1847
1848                     <div class="long">
1849
1850                                 Removes a listener (shorthand for removeListener)
1851
1852
1853
1854
1855
1856
1857                                 <dl class="detailList">
1858                                 <dt class="heading">Parameters:</dt>
1859
1860                                         <dt>
1861                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1862
1863                                         </dt>
1864                                         <dd>The type of event to listen for</dd>
1865
1866                                         <dt>
1867                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1868
1869                                         </dt>
1870                                         <dd>The handler to remove</dd>
1871
1872                                         <dt>
1873                                                 <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>
1874
1875                                         </dt>
1876                                         <dd>(optional) The scope (this object) for the handler</dd>
1877
1878                                 </dl>
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890                     </div>
1891                 </div>
1892
1893             </td>
1894             <td class="msource">
1895
1896                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1897                 &nbsp;
1898             </td>
1899         </tr>
1900
1901
1902     </table>
1903
1904
1905   <!-- ============================== events summary / details ======================== -->
1906
1907
1908   <a id="Roo.View-events"></a>
1909
1910
1911
1912
1913
1914
1915
1916
1917       <table cellspacing="0" class="member-table">
1918                 <caption>Events</caption>
1919               <thead>
1920                 <tr>
1921                     <th class="sig-header" colspan="2">Event</th>
1922                     <th class="msource-header">Defined By</th>
1923
1924                 </tr>
1925               </thead>
1926
1927
1928
1929
1930
1931           <tr class="method-row expandable config-row-alt0 notInherited">
1932             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1933
1934             <td class="sig">
1935                 <a id="Roo.View-event-*beforeclick"></a>
1936
1937                <div class="fixedFont">
1938                 <b class="itemname">beforeclick</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
1939
1940                 </div>
1941
1942                 <div class="mdesc">
1943
1944                    <div class="short">Fires before a click is processed.
1945
1946                 </div>
1947
1948                     <div class="long">
1949
1950                         Fires before a click is processed. Returns false to cancel the default action.
1951
1952
1953
1954
1955
1956                                 <dl class="detailList">
1957                                 <dt class="heading">Parameters:</dt>
1958
1959                                         <dt>
1960                                                 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
1961
1962                                         </dt>
1963                                         <dd></dd>
1964
1965                                         <dt>
1966                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
1967
1968                                         </dt>
1969                                         <dd>The index of the target node</dd>
1970
1971                                         <dt>
1972                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
1973
1974                                         </dt>
1975                                         <dd>The target node</dd>
1976
1977                                         <dt>
1978                                                 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
1979
1980                                         </dt>
1981                                         <dd>The raw event object</dd>
1982
1983                                 </dl>
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995                     </div>
1996                 </div>
1997
1998             </td>
1999             <td class="msource">
2000                 Roo.View
2001             </td>
2002         </tr>
2003
2004           <tr class="method-row expandable config-row-alt1 notInherited">
2005             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2006
2007             <td class="sig">
2008                 <a id="Roo.View-event-*beforeselect"></a>
2009
2010                <div class="fixedFont">
2011                 <b class="itemname">beforeselect</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>selections</i></B>)
2012
2013                 </div>
2014
2015                 <div class="mdesc">
2016
2017                    <div class="short">Fires before a selection is made.
2018
2019                 </div>
2020
2021                     <div class="long">
2022
2023                         Fires before a selection is made. If any handlers return false, the selection is cancelled.
2024
2025
2026
2027
2028
2029                                 <dl class="detailList">
2030                                 <dt class="heading">Parameters:</dt>
2031
2032                                         <dt>
2033                                                 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2034
2035                                         </dt>
2036                                         <dd></dd>
2037
2038                                         <dt>
2039                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2040
2041                                         </dt>
2042                                         <dd>The node to be selected</dd>
2043
2044                                         <dt>
2045                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>selections</b>
2046
2047                                         </dt>
2048                                         <dd>Array of currently selected nodes</dd>
2049
2050                                 </dl>
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062                     </div>
2063                 </div>
2064
2065             </td>
2066             <td class="msource">
2067                 Roo.View
2068             </td>
2069         </tr>
2070
2071           <tr class="method-row expandable config-row-alt0 notInherited">
2072             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2073
2074             <td class="sig">
2075                 <a id="Roo.View-event-*click"></a>
2076
2077                <div class="fixedFont">
2078                 <b class="itemname">click</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2079
2080                 </div>
2081
2082                 <div class="mdesc">
2083
2084                    <div class="short">Fires when a template node is clicked.
2085
2086                 </div>
2087
2088                     <div class="long">
2089
2090                         Fires when a template node is clicked.
2091
2092
2093
2094
2095
2096                                 <dl class="detailList">
2097                                 <dt class="heading">Parameters:</dt>
2098
2099                                         <dt>
2100                                                 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2101
2102                                         </dt>
2103                                         <dd></dd>
2104
2105                                         <dt>
2106                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2107
2108                                         </dt>
2109                                         <dd>The index of the target node</dd>
2110
2111                                         <dt>
2112                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2113
2114                                         </dt>
2115                                         <dd>The target node</dd>
2116
2117                                         <dt>
2118                                                 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2119
2120                                         </dt>
2121                                         <dd>The raw event object</dd>
2122
2123                                 </dl>
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135                     </div>
2136                 </div>
2137
2138             </td>
2139             <td class="msource">
2140                 Roo.View
2141             </td>
2142         </tr>
2143
2144           <tr class="method-row expandable config-row-alt1 notInherited">
2145             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2146
2147             <td class="sig">
2148                 <a id="Roo.View-event-*contextmenu"></a>
2149
2150                <div class="fixedFont">
2151                 <b class="itemname">contextmenu</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2152
2153                 </div>
2154
2155                 <div class="mdesc">
2156
2157                    <div class="short">Fires when a template node is right clicked.
2158
2159                 </div>
2160
2161                     <div class="long">
2162
2163                         Fires when a template node is right clicked.
2164
2165
2166
2167
2168
2169                                 <dl class="detailList">
2170                                 <dt class="heading">Parameters:</dt>
2171
2172                                         <dt>
2173                                                 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2174
2175                                         </dt>
2176                                         <dd></dd>
2177
2178                                         <dt>
2179                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2180
2181                                         </dt>
2182                                         <dd>The index of the target node</dd>
2183
2184                                         <dt>
2185                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2186
2187                                         </dt>
2188                                         <dd>The target node</dd>
2189
2190                                         <dt>
2191                                                 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2192
2193                                         </dt>
2194                                         <dd>The raw event object</dd>
2195
2196                                 </dl>
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208                     </div>
2209                 </div>
2210
2211             </td>
2212             <td class="msource">
2213                 Roo.View
2214             </td>
2215         </tr>
2216
2217           <tr class="method-row expandable config-row-alt0 notInherited">
2218             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2219
2220             <td class="sig">
2221                 <a id="Roo.View-event-*dblclick"></a>
2222
2223                <div class="fixedFont">
2224                 <b class="itemname">dblclick</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2225
2226                 </div>
2227
2228                 <div class="mdesc">
2229
2230                    <div class="short">Fires when a template node is double clicked.
2231
2232                 </div>
2233
2234                     <div class="long">
2235
2236                         Fires when a template node is double clicked.
2237
2238
2239
2240
2241
2242                                 <dl class="detailList">
2243                                 <dt class="heading">Parameters:</dt>
2244
2245                                         <dt>
2246                                                 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2247
2248                                         </dt>
2249                                         <dd></dd>
2250
2251                                         <dt>
2252                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
2253
2254                                         </dt>
2255                                         <dd>The index of the target node</dd>
2256
2257                                         <dt>
2258                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span> <b>node</b>
2259
2260                                         </dt>
2261                                         <dd>The target node</dd>
2262
2263                                         <dt>
2264                                                 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2265
2266                                         </dt>
2267                                         <dd>The raw event object</dd>
2268
2269                                 </dl>
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281                     </div>
2282                 </div>
2283
2284             </td>
2285             <td class="msource">
2286                 Roo.View
2287             </td>
2288         </tr>
2289
2290           <tr class="method-row expandable config-row-alt1 notInherited">
2291             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2292
2293             <td class="sig">
2294                 <a id="Roo.View-event-*selectionchange"></a>
2295
2296                <div class="fixedFont">
2297                 <b class="itemname">selectionchange</b> (<a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a> <B><i>this</i></B>, <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>selections</i></B>)
2298
2299                 </div>
2300
2301                 <div class="mdesc">
2302
2303                    <div class="short">Fires when the selected nodes change.
2304
2305                 </div>
2306
2307                     <div class="long">
2308
2309                         Fires when the selected nodes change.
2310
2311
2312
2313
2314
2315                                 <dl class="detailList">
2316                                 <dt class="heading">Parameters:</dt>
2317
2318                                         <dt>
2319                                                 <span class="fixedFont"><a href="./Roo.View.html#constructor" roo:cls="Roo.View.html#constructor">Roo.View</a></span> <b>this</b>
2320
2321                                         </dt>
2322                                         <dd></dd>
2323
2324                                         <dt>
2325                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>selections</b>
2326
2327                                         </dt>
2328                                         <dd>Array of the selected nodes</dd>
2329
2330                                 </dl>
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342                     </div>
2343                 </div>
2344
2345             </td>
2346             <td class="msource">
2347                 Roo.View
2348             </td>
2349         </tr>
2350
2351
2352     </table>
2353
2354
2355
2356
2357
2358 <!-- ============================== footer ================================= -->
2359                 <div class="fineprint" style="clear:both">
2360
2361                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Mon Jul 19 2010 11:50:46 GMT+0800 (HKT)
2362                         Based on
2363                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
2364                 </div>
2365         </body>
2366 </html>