git.roojs.org Git - roojs1/blob - docs/symbols/Roo.tree.DefaultSelectionModel.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.tree.DefaultSelectionModel</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.tree.DefaultSelectionModel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.tree.DefaultSelectionModel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.tree.DefaultSelectionModel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.tree.DefaultSelectionModel-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.tree.DefaultSelectionModel
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.tree.DefaultSelectionModel
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.tree</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_tree_TreeSelectionModel.js.html">Roo/tree/TreeSelectionModel.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">DefaultSelectionModel</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         The default single selection for a TreePanel.
  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.tree.DefaultSelectionModel';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.tree" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.tree.DefaultSelectionModel.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.tree.DefaultSelectionModel-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <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>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <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>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 152
 153                     </td>
 154                 </tr>
 155
 156
 157     </table>
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167   <!-- ============================== public properties ==================== -->
 168
 169
 170
 171     <a id="Roo.tree.DefaultSelectionModel-props"></a>
 172
 173
 174
 175
 176
 177      <table cellspacing="0" class="member-table">
 178       <caption class="Empty">Public Properties - Has None</caption>
 179      </table>
 180
 181
 182
 183
 184   <!-- ============================== methods summary / details ======================== -->
 185
 186
 187   <a id="Roo.tree.DefaultSelectionModel-methods"></a>
 188         <!-- constructor?? -->
 189
 190         <!-- static's first
 191
 192
 193         -->
 194
 195         <!-- then dynamics first -->
 196
 197
 198
 199
 200
 201
 202       <table cellspacing="0" class="member-table">
 203       <caption>Public Methods</caption>
 204         <tr>
 205             <th class="sig-header" colspan="2">Method</th>
 206             <th class="msource-header">Defined By</th>
 207
 208         </tr>
 209
 210
 211
 212
 213
 214
 215
 216           <tr class="method-row config-row-alt0 notInherited">
 217             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 218
 219
 220             <td class="sig">
 221                 <a id="Roo.tree-method-DefaultSelectionModel"   name=".DefaultSelectionModel"></a>
 222                 <div class="fixedFont">
 223                         <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">DefaultSelectionModel</b>
 224
 225                                  ()
 226
 227
 228
 229                 </div>
 230                 <div class="mdesc">
 231
 232
 233                         <div class="short">Create a new Roo.tree.DefaultSelectionModel</div>
 234
 235
 236                     <div class="long">
 237
 238
 239
 240                                 Create a new Roo.tree.DefaultSelectionModel
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253                     </div>
 254                 </div>
 255
 256             </td>
 257             <td class="msource">
 258                 &nbsp;
 259             </td>
 260         </tr>
 261
 262
 263           <tr class="method-row config-row-alt1 expandable">
 264             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 265
 266
 267             <td class="sig">
 268                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 269                 <div class="fixedFont">
 270                         <span class="attributes"></span><b class="itemname">addEvents</b>
 271
 272                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 273
 274
 275
 276                 </div>
 277                 <div class="mdesc">
 278
 279                    <div class="short">Used to define events on this Observable</div>
 280
 281
 282
 283                     <div class="long">
 284
 285                                 Used to define events on this Observable
 286
 287
 288
 289
 290
 291
 292                                 <dl class="detailList">
 293                                 <dt class="heading">Parameters:</dt>
 294
 295                                         <dt>
 296                                                 <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>
 297
 298                                         </dt>
 299                                         <dd>The object with the events defined</dd>
 300
 301                                 </dl>
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313                     </div>
 314                 </div>
 315
 316             </td>
 317             <td class="msource">
 318
 319                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 320                 &nbsp;
 321             </td>
 322         </tr>
 323
 324
 325           <tr class="method-row config-row-alt0 expandable">
 326             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 327
 328
 329             <td class="sig">
 330                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 331                 <div class="fixedFont">
 332                         <span class="attributes"></span><b class="itemname">addListener</b>
 333
 334                                  (<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>)
 335
 336
 337
 338                 </div>
 339                 <div class="mdesc">
 340
 341                    <div class="short">Appends an event handler to this component</div>
 342
 343
 344
 345                     <div class="long">
 346
 347                                 Appends an event handler to this component
 348
 349
 350
 351
 352
 353
 354                                 <dl class="detailList">
 355                                 <dt class="heading">Parameters:</dt>
 356
 357                                         <dt>
 358                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 359
 360                                         </dt>
 361                                         <dd>The type of event to listen for</dd>
 362
 363                                         <dt>
 364                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 365
 366                                         </dt>
 367                                         <dd>The method the event invokes</dd>
 368
 369                                         <dt>
 370                                                 <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>
 371
 372                                         </dt>
 373                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 374
 375                                         <dt>
 376                                                 <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>
 377
 378                                         </dt>
 379                                         <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>
 380
 381                                 </dl>
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393                     </div>
 394                 </div>
 395
 396             </td>
 397             <td class="msource">
 398
 399                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 400                 &nbsp;
 401             </td>
 402         </tr>
 403
 404
 405           <tr class="method-row config-row-alt1 expandable notInherited">
 406             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 407
 408
 409             <td class="sig">
 410                 <a id="Roo.tree.DefaultSelectionModel-method-clearSelections"   name=".clearSelections"></a>
 411                 <div class="fixedFont">
 412                         <span class="attributes"></span><b class="itemname">clearSelections</b>
 413
 414                                  ()
 415
 416
 417
 418                 </div>
 419                 <div class="mdesc">
 420
 421                    <div class="short">Clear all selections</div>
 422
 423
 424
 425                     <div class="long">
 426
 427                                 Clear all selections
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444                     </div>
 445                 </div>
 446
 447             </td>
 448             <td class="msource">
 449
 450                         Roo.tree.DefaultSelectionModel
 451                 &nbsp;
 452             </td>
 453         </tr>
 454
 455
 456           <tr class="method-row config-row-alt0 expandable">
 457             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 458
 459
 460             <td class="sig">
 461                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 462                 <div class="fixedFont">
 463                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 464
 465                                  (<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>)
 466
 467
 468                                          :
 469
 470
 471                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 472
 473
 474
 475
 476
 477                 </div>
 478                 <div class="mdesc">
 479
 480                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 481
 482
 483
 484                     <div class="long">
 485
 486                                 Fires the specified event with the passed parameters (minus the event name).
 487
 488
 489
 490
 491
 492
 493                                 <dl class="detailList">
 494                                 <dt class="heading">Parameters:</dt>
 495
 496                                         <dt>
 497                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 498
 499                                         </dt>
 500                                         <dd></dd>
 501
 502                                         <dt>
 503                                                 <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>
 504
 505                                         </dt>
 506                                         <dd>Variable number of parameters are passed to handlers</dd>
 507
 508                                 </dl>
 509
 510
 511
 512
 513
 514                                 <dl class="detailList">
 515                                 <dt class="heading">Returns:</dt>
 516
 517                                         <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>
 518
 519                                 </dl>
 520
 521
 522
 523
 524
 525
 526
 527                     </div>
 528                 </div>
 529
 530             </td>
 531             <td class="msource">
 532
 533                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 534                 &nbsp;
 535             </td>
 536         </tr>
 537
 538
 539           <tr class="method-row config-row-alt1 expandable notInherited">
 540             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 541
 542
 543             <td class="sig">
 544                 <a id="Roo.tree.DefaultSelectionModel-method-getSelectedNode"   name=".getSelectedNode"></a>
 545                 <div class="fixedFont">
 546                         <span class="attributes"></span><b class="itemname">getSelectedNode</b>
 547
 548                                  ()
 549
 550
 551                                          :
 552
 553
 554                                                 TreeNode
 555
 556
 557
 558
 559
 560                 </div>
 561                 <div class="mdesc">
 562
 563                    <div class="short">Get the selected node</div>
 564
 565
 566
 567                     <div class="long">
 568
 569                                 Get the selected node
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580                                 <dl class="detailList">
 581                                 <dt class="heading">Returns:</dt>
 582
 583                                         <dd><span class="fixedFont">TreeNode</span>  The selected node</dd>
 584
 585                                 </dl>
 586
 587
 588
 589
 590
 591
 592
 593                     </div>
 594                 </div>
 595
 596             </td>
 597             <td class="msource">
 598
 599                         Roo.tree.DefaultSelectionModel
 600                 &nbsp;
 601             </td>
 602         </tr>
 603
 604
 605           <tr class="method-row config-row-alt0 expandable">
 606             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 607
 608
 609             <td class="sig">
 610                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
 611                 <div class="fixedFont">
 612                         <span class="attributes"></span><b class="itemname">hasListener</b>
 613
 614                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
 615
 616
 617                                          :
 618
 619
 620                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 621
 622
 623
 624
 625
 626                 </div>
 627                 <div class="mdesc">
 628
 629                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
 630
 631
 632
 633                     <div class="long">
 634
 635                                 Checks to see if this object has any listeners for a specified event
 636
 637
 638
 639
 640
 641
 642                                 <dl class="detailList">
 643                                 <dt class="heading">Parameters:</dt>
 644
 645                                         <dt>
 646                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 647
 648                                         </dt>
 649                                         <dd>The name of the event to check for</dd>
 650
 651                                 </dl>
 652
 653
 654
 655
 656
 657                                 <dl class="detailList">
 658                                 <dt class="heading">Returns:</dt>
 659
 660                                         <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>
 661
 662                                 </dl>
 663
 664
 665
 666
 667
 668
 669
 670                     </div>
 671                 </div>
 672
 673             </td>
 674             <td class="msource">
 675
 676                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 677                 &nbsp;
 678             </td>
 679         </tr>
 680
 681
 682           <tr class="method-row config-row-alt1 expandable notInherited">
 683             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 684
 685
 686             <td class="sig">
 687                 <a id="Roo.tree.DefaultSelectionModel-method-isSelected"   name=".isSelected"></a>
 688                 <div class="fixedFont">
 689                         <span class="attributes"></span><b class="itemname">isSelected</b>
 690
 691                                  (TreeNode <B><i>node</i></B>)
 692
 693
 694                                          :
 695
 696
 697                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 698
 699
 700
 701
 702
 703                 </div>
 704                 <div class="mdesc">
 705
 706                    <div class="short">Returns true if the node is selected</div>
 707
 708
 709
 710                     <div class="long">
 711
 712                                 Returns true if the node is selected
 713
 714
 715
 716
 717
 718
 719                                 <dl class="detailList">
 720                                 <dt class="heading">Parameters:</dt>
 721
 722                                         <dt>
 723                                                 <span class="fixedFont">TreeNode</span>  <b>node</b>
 724
 725                                         </dt>
 726                                         <dd>The node to check</dd>
 727
 728                                 </dl>
 729
 730
 731
 732
 733
 734                                 <dl class="detailList">
 735                                 <dt class="heading">Returns:</dt>
 736
 737                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 738
 739                                 </dl>
 740
 741
 742
 743
 744
 745
 746
 747                     </div>
 748                 </div>
 749
 750             </td>
 751             <td class="msource">
 752
 753                         Roo.tree.DefaultSelectionModel
 754                 &nbsp;
 755             </td>
 756         </tr>
 757
 758
 759           <tr class="method-row config-row-alt0 expandable">
 760             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 761
 762
 763             <td class="sig">
 764                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
 765                 <div class="fixedFont">
 766                         <span class="attributes"></span><b class="itemname">on</b>
 767
 768                                  (<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>)
 769
 770
 771
 772                 </div>
 773                 <div class="mdesc">
 774
 775                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
 776
 777
 778
 779                     <div class="long">
 780
 781                                 Appends an event handler to this element (shorthand for addListener)
 782
 783
 784
 785
 786
 787
 788                                 <dl class="detailList">
 789                                 <dt class="heading">Parameters:</dt>
 790
 791                                         <dt>
 792                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 793
 794                                         </dt>
 795                                         <dd>The type of event to listen for</dd>
 796
 797                                         <dt>
 798                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 799
 800                                         </dt>
 801                                         <dd>The method the event invokes</dd>
 802
 803                                         <dt>
 804                                                 <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>
 805
 806                                         </dt>
 807                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 808
 809                                         <dt>
 810                                                 <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>
 811
 812                                         </dt>
 813                                         <dd>(optional)</dd>
 814
 815                                 </dl>
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827                     </div>
 828                 </div>
 829
 830             </td>
 831             <td class="msource">
 832
 833                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 834                 &nbsp;
 835             </td>
 836         </tr>
 837
 838
 839           <tr class="method-row config-row-alt1 expandable">
 840             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 841
 842
 843             <td class="sig">
 844                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
 845                 <div class="fixedFont">
 846                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
 847
 848                                  ()
 849
 850
 851
 852                 </div>
 853                 <div class="mdesc">
 854
 855                    <div class="short">Removes all listeners for this object</div>
 856
 857
 858
 859                     <div class="long">
 860
 861                                 Removes all listeners for this object
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878                     </div>
 879                 </div>
 880
 881             </td>
 882             <td class="msource">
 883
 884                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 885                 &nbsp;
 886             </td>
 887         </tr>
 888
 889
 890           <tr class="method-row config-row-alt0 expandable">
 891             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 892
 893
 894             <td class="sig">
 895                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
 896                 <div class="fixedFont">
 897                         <span class="attributes"></span><b class="itemname">removeListener</b>
 898
 899                                  (<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>)
 900
 901
 902
 903                 </div>
 904                 <div class="mdesc">
 905
 906                    <div class="short">Removes a listener</div>
 907
 908
 909
 910                     <div class="long">
 911
 912                                 Removes a listener
 913
 914
 915
 916
 917
 918
 919                                 <dl class="detailList">
 920                                 <dt class="heading">Parameters:</dt>
 921
 922                                         <dt>
 923                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 924
 925                                         </dt>
 926                                         <dd>The type of event to listen for</dd>
 927
 928                                         <dt>
 929                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 930
 931                                         </dt>
 932                                         <dd>The handler to remove</dd>
 933
 934                                         <dt>
 935                                                 <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>
 936
 937                                         </dt>
 938                                         <dd>(optional) The scope (this object) for the handler</dd>
 939
 940                                 </dl>
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952                     </div>
 953                 </div>
 954
 955             </td>
 956             <td class="msource">
 957
 958                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 959                 &nbsp;
 960             </td>
 961         </tr>
 962
 963
 964           <tr class="method-row config-row-alt1 expandable notInherited">
 965             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 966
 967
 968             <td class="sig">
 969                 <a id="Roo.tree.DefaultSelectionModel-method-select"   name=".select"></a>
 970                 <div class="fixedFont">
 971                         <span class="attributes"></span><b class="itemname">select</b>
 972
 973                                  (TreeNode <B><i>node</i></B>)
 974
 975
 976                                          :
 977
 978
 979                                                 TreeNode
 980
 981
 982
 983
 984
 985                 </div>
 986                 <div class="mdesc">
 987
 988                    <div class="short">Select a node.</div>
 989
 990
 991
 992                     <div class="long">
 993
 994                                 Select a node.
 995
 996
 997
 998
 999
1000
1001                                 <dl class="detailList">
1002                                 <dt class="heading">Parameters:</dt>
1003
1004                                         <dt>
1005                                                 <span class="fixedFont">TreeNode</span>  <b>node</b>
1006
1007                                         </dt>
1008                                         <dd>The node to select</dd>
1009
1010                                 </dl>
1011
1012
1013
1014
1015
1016                                 <dl class="detailList">
1017                                 <dt class="heading">Returns:</dt>
1018
1019                                         <dd><span class="fixedFont">TreeNode</span>  The selected node</dd>
1020
1021                                 </dl>
1022
1023
1024
1025
1026
1027
1028
1029                     </div>
1030                 </div>
1031
1032             </td>
1033             <td class="msource">
1034
1035                         Roo.tree.DefaultSelectionModel
1036                 &nbsp;
1037             </td>
1038         </tr>
1039
1040
1041           <tr class="method-row config-row-alt0 expandable notInherited">
1042             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1043
1044
1045             <td class="sig">
1046                 <a id="Roo.tree.DefaultSelectionModel-method-selectNext"   name=".selectNext"></a>
1047                 <div class="fixedFont">
1048                         <span class="attributes"></span><b class="itemname">selectNext</b>
1049
1050                                  ()
1051
1052
1053                                          :
1054
1055
1056
1057
1058
1059
1060
1061
1062                 </div>
1063                 <div class="mdesc">
1064
1065                    <div class="short">Selects the node above the selected node in the tree, intelligently walking the nodes</div>
1066
1067
1068
1069                     <div class="long">
1070
1071                                 Selects the node above the selected node in the tree, intelligently walking the nodes
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082                                 <dl class="detailList">
1083                                 <dt class="heading">Returns:</dt>
1084
1085                                         <dd> TreeNode The new selection</dd>
1086
1087                                 </dl>
1088
1089
1090
1091
1092
1093
1094
1095                     </div>
1096                 </div>
1097
1098             </td>
1099             <td class="msource">
1100
1101                         Roo.tree.DefaultSelectionModel
1102                 &nbsp;
1103             </td>
1104         </tr>
1105
1106
1107           <tr class="method-row config-row-alt1 expandable notInherited">
1108             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1109
1110
1111             <td class="sig">
1112                 <a id="Roo.tree.DefaultSelectionModel-method-selectPrevious"   name=".selectPrevious"></a>
1113                 <div class="fixedFont">
1114                         <span class="attributes"></span><b class="itemname">selectPrevious</b>
1115
1116                                  ()
1117
1118
1119                                          :
1120
1121
1122
1123
1124
1125
1126
1127
1128                 </div>
1129                 <div class="mdesc">
1130
1131                    <div class="short">Selects the node above the selected node in the tree, intelligently walking the nodes</div>
1132
1133
1134
1135                     <div class="long">
1136
1137                                 Selects the node above the selected node in the tree, intelligently walking the nodes
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148                                 <dl class="detailList">
1149                                 <dt class="heading">Returns:</dt>
1150
1151                                         <dd> TreeNode The new selection</dd>
1152
1153                                 </dl>
1154
1155
1156
1157
1158
1159
1160
1161                     </div>
1162                 </div>
1163
1164             </td>
1165             <td class="msource">
1166
1167                         Roo.tree.DefaultSelectionModel
1168                 &nbsp;
1169             </td>
1170         </tr>
1171
1172
1173           <tr class="method-row config-row-alt0 expandable">
1174             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1175
1176
1177             <td class="sig">
1178                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1179                 <div class="fixedFont">
1180                         <span class="attributes"></span><b class="itemname">un</b>
1181
1182                                  (<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>)
1183
1184
1185
1186                 </div>
1187                 <div class="mdesc">
1188
1189                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1190
1191
1192
1193                     <div class="long">
1194
1195                                 Removes a listener (shorthand for removeListener)
1196
1197
1198
1199
1200
1201
1202                                 <dl class="detailList">
1203                                 <dt class="heading">Parameters:</dt>
1204
1205                                         <dt>
1206                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1207
1208                                         </dt>
1209                                         <dd>The type of event to listen for</dd>
1210
1211                                         <dt>
1212                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1213
1214                                         </dt>
1215                                         <dd>The handler to remove</dd>
1216
1217                                         <dt>
1218                                                 <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>
1219
1220                                         </dt>
1221                                         <dd>(optional) The scope (this object) for the handler</dd>
1222
1223                                 </dl>
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235                     </div>
1236                 </div>
1237
1238             </td>
1239             <td class="msource">
1240
1241                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1242                 &nbsp;
1243             </td>
1244         </tr>
1245
1246
1247           <tr class="method-row config-row-alt1 expandable notInherited">
1248             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1249
1250
1251             <td class="sig">
1252                 <a id="Roo.tree.DefaultSelectionModel-method-unselect"   name=".unselect"></a>
1253                 <div class="fixedFont">
1254                         <span class="attributes"></span><b class="itemname">unselect</b>
1255
1256                                  (TreeNode <B><i>node</i></B>)
1257
1258
1259
1260                 </div>
1261                 <div class="mdesc">
1262
1263                    <div class="short">Deselect a node.</div>
1264
1265
1266
1267                     <div class="long">
1268
1269                                 Deselect a node.
1270
1271
1272
1273
1274
1275
1276                                 <dl class="detailList">
1277                                 <dt class="heading">Parameters:</dt>
1278
1279                                         <dt>
1280                                                 <span class="fixedFont">TreeNode</span>  <b>node</b>
1281
1282                                         </dt>
1283                                         <dd>The node to unselect</dd>
1284
1285                                 </dl>
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297                     </div>
1298                 </div>
1299
1300             </td>
1301             <td class="msource">
1302
1303                         Roo.tree.DefaultSelectionModel
1304                 &nbsp;
1305             </td>
1306         </tr>
1307
1308
1309     </table>
1310
1311
1312   <!-- ============================== events summary / details ======================== -->
1313
1314
1315   <a id="Roo.tree.DefaultSelectionModel-events"></a>
1316
1317
1318
1319
1320
1321
1322
1323
1324       <table cellspacing="0" class="member-table">
1325                 <caption>Events</caption>
1326               <thead>
1327                 <tr>
1328                     <th class="sig-header" colspan="2">Event</th>
1329                     <th class="msource-header">Defined By</th>
1330
1331                 </tr>
1332               </thead>
1333
1334
1335
1336
1337
1338           <tr class="method-row expandable config-row-alt0 notInherited">
1339             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1340
1341             <td class="sig">
1342                 <a id="Roo.tree.DefaultSelectionModel-event-*beforeselect"></a>
1343
1344                <div class="fixedFont">
1345                 <b class="itemname">beforeselect</b> (DefaultSelectionModel <B><i>this</i></B>, TreeNode <B><i>node</i></B>, TreeNode <B><i>node</i></B>)
1346
1347                 </div>
1348
1349                 <div class="mdesc">
1350
1351                    <div class="short">Fires before the selected node changes, return false to cancel the change
1352
1353                 </div>
1354
1355                     <div class="long">
1356
1357                         Fires before the selected node changes, return false to cancel the change
1358
1359
1360
1361
1362
1363                                 <dl class="detailList">
1364                                 <dt class="heading">Parameters:</dt>
1365
1366                                         <dt>
1367                                                 <span class="fixedFont">DefaultSelectionModel</span> <b>this</b>
1368
1369                                         </dt>
1370                                         <dd></dd>
1371
1372                                         <dt>
1373                                                 <span class="fixedFont">TreeNode</span> <b>node</b>
1374
1375                                         </dt>
1376                                         <dd>the new selection</dd>
1377
1378                                         <dt>
1379                                                 <span class="fixedFont">TreeNode</span> <b>node</b>
1380
1381                                         </dt>
1382                                         <dd>the old selection</dd>
1383
1384                                 </dl>
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396                     </div>
1397                 </div>
1398
1399             </td>
1400             <td class="msource">
1401                 Roo.tree.DefaultSelectionModel
1402             </td>
1403         </tr>
1404
1405           <tr class="method-row expandable config-row-alt1 notInherited">
1406             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1407
1408             <td class="sig">
1409                 <a id="Roo.tree.DefaultSelectionModel-event-*selectionchange"></a>
1410
1411                <div class="fixedFont">
1412                 <b class="itemname">selectionchange</b> (DefaultSelectionModel <B><i>this</i></B>, TreeNode <B><i>node</i></B>)
1413
1414                 </div>
1415
1416                 <div class="mdesc">
1417
1418                    <div class="short">Fires when the selected node changes
1419
1420                 </div>
1421
1422                     <div class="long">
1423
1424                         Fires when the selected node changes
1425
1426
1427
1428
1429
1430                                 <dl class="detailList">
1431                                 <dt class="heading">Parameters:</dt>
1432
1433                                         <dt>
1434                                                 <span class="fixedFont">DefaultSelectionModel</span> <b>this</b>
1435
1436                                         </dt>
1437                                         <dd></dd>
1438
1439                                         <dt>
1440                                                 <span class="fixedFont">TreeNode</span> <b>node</b>
1441
1442                                         </dt>
1443                                         <dd>the new selection</dd>
1444
1445                                 </dl>
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457                     </div>
1458                 </div>
1459
1460             </td>
1461             <td class="msource">
1462                 Roo.tree.DefaultSelectionModel
1463             </td>
1464         </tr>
1465
1466
1467     </table>
1468
1469
1470
1471
1472
1473 <!-- ============================== footer ================================= -->
1474                 <div class="fineprint" style="clear:both">
1475
1476                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:09 GMT+0800 (HKT)
1477                         Based on
1478                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1479                 </div>
1480         </body>
1481 </html>