git.roojs.org Git - roojs1/blob - docs/symbols/Roo.tree.MultiSelectionModel.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.MultiSelectionModel</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.MultiSelectionModel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.tree.MultiSelectionModel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.tree.MultiSelectionModel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.tree.MultiSelectionModel-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.MultiSelectionModel
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.tree.MultiSelectionModel
  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">MultiSelectionModel</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         Multi 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.MultiSelectionModel';">[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.MultiSelectionModel.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.tree.MultiSelectionModel-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.MultiSelectionModel-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.MultiSelectionModel-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 expandable 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-MultiSelectionModel"   name=".MultiSelectionModel"></a>
 222                 <div class="fixedFont">
 223                         <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">MultiSelectionModel</b>
 224
 225                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>cfg</i></B>)
 226
 227
 228
 229                 </div>
 230                 <div class="mdesc">
 231
 232
 233                         <div class="short">Create a new Roo.tree.MultiSelectionModel</div>
 234
 235
 236                     <div class="long">
 237
 238
 239
 240                                 Create a new Roo.tree.MultiSelectionModel
 241
 242
 243                                 <dl class="detailList">
 244                                 <dt class="heading">Parameters:</dt>
 245
 246                                         <dt>
 247                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>cfg</b>
 248
 249                                         </dt>
 250                                         <dd>Configuration</dd>
 251
 252                                 </dl>
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264                     </div>
 265                 </div>
 266
 267             </td>
 268             <td class="msource">
 269                 &nbsp;
 270             </td>
 271         </tr>
 272
 273
 274           <tr class="method-row config-row-alt1 expandable">
 275             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 276
 277
 278             <td class="sig">
 279                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 280                 <div class="fixedFont">
 281                         <span class="attributes"></span><b class="itemname">addEvents</b>
 282
 283                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 284
 285
 286
 287                 </div>
 288                 <div class="mdesc">
 289
 290                    <div class="short">Used to define events on this Observable</div>
 291
 292
 293
 294                     <div class="long">
 295
 296                                 Used to define events on this Observable
 297
 298
 299
 300
 301
 302
 303                                 <dl class="detailList">
 304                                 <dt class="heading">Parameters:</dt>
 305
 306                                         <dt>
 307                                                 <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>
 308
 309                                         </dt>
 310                                         <dd>The object with the events defined</dd>
 311
 312                                 </dl>
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324                     </div>
 325                 </div>
 326
 327             </td>
 328             <td class="msource">
 329
 330                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 331                 &nbsp;
 332             </td>
 333         </tr>
 334
 335
 336           <tr class="method-row config-row-alt0 expandable">
 337             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 338
 339
 340             <td class="sig">
 341                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 342                 <div class="fixedFont">
 343                         <span class="attributes"></span><b class="itemname">addListener</b>
 344
 345                                  (<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>)
 346
 347
 348
 349                 </div>
 350                 <div class="mdesc">
 351
 352                    <div class="short">Appends an event handler to this component</div>
 353
 354
 355
 356                     <div class="long">
 357
 358                                 Appends an event handler to this component
 359
 360
 361
 362
 363
 364
 365                                 <dl class="detailList">
 366                                 <dt class="heading">Parameters:</dt>
 367
 368                                         <dt>
 369                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 370
 371                                         </dt>
 372                                         <dd>The type of event to listen for</dd>
 373
 374                                         <dt>
 375                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 376
 377                                         </dt>
 378                                         <dd>The method the event invokes</dd>
 379
 380                                         <dt>
 381                                                 <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>
 382
 383                                         </dt>
 384                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 385
 386                                         <dt>
 387                                                 <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>
 388
 389                                         </dt>
 390                                         <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>
 391
 392                                 </dl>
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404                     </div>
 405                 </div>
 406
 407             </td>
 408             <td class="msource">
 409
 410                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 411                 &nbsp;
 412             </td>
 413         </tr>
 414
 415
 416           <tr class="method-row config-row-alt1 expandable notInherited">
 417             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 418
 419
 420             <td class="sig">
 421                 <a id="Roo.tree.MultiSelectionModel-method-clearSelections"   name=".clearSelections"></a>
 422                 <div class="fixedFont">
 423                         <span class="attributes"></span><b class="itemname">clearSelections</b>
 424
 425                                  ()
 426
 427
 428
 429                 </div>
 430                 <div class="mdesc">
 431
 432                    <div class="short">Clear all selections</div>
 433
 434
 435
 436                     <div class="long">
 437
 438                                 Clear all selections
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455                     </div>
 456                 </div>
 457
 458             </td>
 459             <td class="msource">
 460
 461                         Roo.tree.MultiSelectionModel
 462                 &nbsp;
 463             </td>
 464         </tr>
 465
 466
 467           <tr class="method-row config-row-alt0 expandable">
 468             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 469
 470
 471             <td class="sig">
 472                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 473                 <div class="fixedFont">
 474                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 475
 476                                  (<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>)
 477
 478
 479                                          :
 480
 481
 482                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 483
 484
 485
 486
 487
 488                 </div>
 489                 <div class="mdesc">
 490
 491                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 492
 493
 494
 495                     <div class="long">
 496
 497                                 Fires the specified event with the passed parameters (minus the event name).
 498
 499
 500
 501
 502
 503
 504                                 <dl class="detailList">
 505                                 <dt class="heading">Parameters:</dt>
 506
 507                                         <dt>
 508                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 509
 510                                         </dt>
 511                                         <dd></dd>
 512
 513                                         <dt>
 514                                                 <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>
 515
 516                                         </dt>
 517                                         <dd>Variable number of parameters are passed to handlers</dd>
 518
 519                                 </dl>
 520
 521
 522
 523
 524
 525                                 <dl class="detailList">
 526                                 <dt class="heading">Returns:</dt>
 527
 528                                         <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>
 529
 530                                 </dl>
 531
 532
 533
 534
 535
 536
 537
 538                     </div>
 539                 </div>
 540
 541             </td>
 542             <td class="msource">
 543
 544                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 545                 &nbsp;
 546             </td>
 547         </tr>
 548
 549
 550           <tr class="method-row config-row-alt1 expandable notInherited">
 551             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 552
 553
 554             <td class="sig">
 555                 <a id="Roo.tree.MultiSelectionModel-method-getSelectedNodes"   name=".getSelectedNodes"></a>
 556                 <div class="fixedFont">
 557                         <span class="attributes"></span><b class="itemname">getSelectedNodes</b>
 558
 559                                  ()
 560
 561
 562                                          :
 563
 564
 565                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 566
 567
 568
 569
 570
 571                 </div>
 572                 <div class="mdesc">
 573
 574                    <div class="short">Returns an array of the selected nodes</div>
 575
 576
 577
 578                     <div class="long">
 579
 580                                 Returns an array of the selected nodes
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591                                 <dl class="detailList">
 592                                 <dt class="heading">Returns:</dt>
 593
 594                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  </dd>
 595
 596                                 </dl>
 597
 598
 599
 600
 601
 602
 603
 604                     </div>
 605                 </div>
 606
 607             </td>
 608             <td class="msource">
 609
 610                         Roo.tree.MultiSelectionModel
 611                 &nbsp;
 612             </td>
 613         </tr>
 614
 615
 616           <tr class="method-row config-row-alt0 expandable">
 617             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 618
 619
 620             <td class="sig">
 621                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
 622                 <div class="fixedFont">
 623                         <span class="attributes"></span><b class="itemname">hasListener</b>
 624
 625                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
 626
 627
 628                                          :
 629
 630
 631                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 632
 633
 634
 635
 636
 637                 </div>
 638                 <div class="mdesc">
 639
 640                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
 641
 642
 643
 644                     <div class="long">
 645
 646                                 Checks to see if this object has any listeners for a specified event
 647
 648
 649
 650
 651
 652
 653                                 <dl class="detailList">
 654                                 <dt class="heading">Parameters:</dt>
 655
 656                                         <dt>
 657                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 658
 659                                         </dt>
 660                                         <dd>The name of the event to check for</dd>
 661
 662                                 </dl>
 663
 664
 665
 666
 667
 668                                 <dl class="detailList">
 669                                 <dt class="heading">Returns:</dt>
 670
 671                                         <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>
 672
 673                                 </dl>
 674
 675
 676
 677
 678
 679
 680
 681                     </div>
 682                 </div>
 683
 684             </td>
 685             <td class="msource">
 686
 687                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 688                 &nbsp;
 689             </td>
 690         </tr>
 691
 692
 693           <tr class="method-row config-row-alt1 expandable notInherited">
 694             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 695
 696
 697             <td class="sig">
 698                 <a id="Roo.tree.MultiSelectionModel-method-isSelected"   name=".isSelected"></a>
 699                 <div class="fixedFont">
 700                         <span class="attributes"></span><b class="itemname">isSelected</b>
 701
 702                                  (TreeNode <B><i>node</i></B>)
 703
 704
 705                                          :
 706
 707
 708                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 709
 710
 711
 712
 713
 714                 </div>
 715                 <div class="mdesc">
 716
 717                    <div class="short">Returns true if the node is selected</div>
 718
 719
 720
 721                     <div class="long">
 722
 723                                 Returns true if the node is selected
 724
 725
 726
 727
 728
 729
 730                                 <dl class="detailList">
 731                                 <dt class="heading">Parameters:</dt>
 732
 733                                         <dt>
 734                                                 <span class="fixedFont">TreeNode</span>  <b>node</b>
 735
 736                                         </dt>
 737                                         <dd>The node to check</dd>
 738
 739                                 </dl>
 740
 741
 742
 743
 744
 745                                 <dl class="detailList">
 746                                 <dt class="heading">Returns:</dt>
 747
 748                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 749
 750                                 </dl>
 751
 752
 753
 754
 755
 756
 757
 758                     </div>
 759                 </div>
 760
 761             </td>
 762             <td class="msource">
 763
 764                         Roo.tree.MultiSelectionModel
 765                 &nbsp;
 766             </td>
 767         </tr>
 768
 769
 770           <tr class="method-row config-row-alt0 expandable">
 771             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 772
 773
 774             <td class="sig">
 775                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
 776                 <div class="fixedFont">
 777                         <span class="attributes"></span><b class="itemname">on</b>
 778
 779                                  (<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>)
 780
 781
 782
 783                 </div>
 784                 <div class="mdesc">
 785
 786                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
 787
 788
 789
 790                     <div class="long">
 791
 792                                 Appends an event handler to this element (shorthand for addListener)
 793
 794
 795
 796
 797
 798
 799                                 <dl class="detailList">
 800                                 <dt class="heading">Parameters:</dt>
 801
 802                                         <dt>
 803                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 804
 805                                         </dt>
 806                                         <dd>The type of event to listen for</dd>
 807
 808                                         <dt>
 809                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 810
 811                                         </dt>
 812                                         <dd>The method the event invokes</dd>
 813
 814                                         <dt>
 815                                                 <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>
 816
 817                                         </dt>
 818                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 819
 820                                         <dt>
 821                                                 <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>
 822
 823                                         </dt>
 824                                         <dd>(optional)</dd>
 825
 826                                 </dl>
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838                     </div>
 839                 </div>
 840
 841             </td>
 842             <td class="msource">
 843
 844                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 845                 &nbsp;
 846             </td>
 847         </tr>
 848
 849
 850           <tr class="method-row config-row-alt1 expandable">
 851             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 852
 853
 854             <td class="sig">
 855                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
 856                 <div class="fixedFont">
 857                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
 858
 859                                  ()
 860
 861
 862
 863                 </div>
 864                 <div class="mdesc">
 865
 866                    <div class="short">Removes all listeners for this object</div>
 867
 868
 869
 870                     <div class="long">
 871
 872                                 Removes all listeners for this object
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889                     </div>
 890                 </div>
 891
 892             </td>
 893             <td class="msource">
 894
 895                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 896                 &nbsp;
 897             </td>
 898         </tr>
 899
 900
 901           <tr class="method-row config-row-alt0 expandable">
 902             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 903
 904
 905             <td class="sig">
 906                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
 907                 <div class="fixedFont">
 908                         <span class="attributes"></span><b class="itemname">removeListener</b>
 909
 910                                  (<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>)
 911
 912
 913
 914                 </div>
 915                 <div class="mdesc">
 916
 917                    <div class="short">Removes a listener</div>
 918
 919
 920
 921                     <div class="long">
 922
 923                                 Removes a listener
 924
 925
 926
 927
 928
 929
 930                                 <dl class="detailList">
 931                                 <dt class="heading">Parameters:</dt>
 932
 933                                         <dt>
 934                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 935
 936                                         </dt>
 937                                         <dd>The type of event to listen for</dd>
 938
 939                                         <dt>
 940                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 941
 942                                         </dt>
 943                                         <dd>The handler to remove</dd>
 944
 945                                         <dt>
 946                                                 <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>
 947
 948                                         </dt>
 949                                         <dd>(optional) The scope (this object) for the handler</dd>
 950
 951                                 </dl>
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963                     </div>
 964                 </div>
 965
 966             </td>
 967             <td class="msource">
 968
 969                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 970                 &nbsp;
 971             </td>
 972         </tr>
 973
 974
 975           <tr class="method-row config-row-alt1 expandable notInherited">
 976             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 977
 978
 979             <td class="sig">
 980                 <a id="Roo.tree.MultiSelectionModel-method-select"   name=".select"></a>
 981                 <div class="fixedFont">
 982                         <span class="attributes"></span><b class="itemname">select</b>
 983
 984                                  (TreeNode <B><i>node</i></B>, EventObject <B><i>e</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>)
 985
 986
 987                                          :
 988
 989
 990                                                 TreeNode
 991
 992
 993
 994
 995
 996                 </div>
 997                 <div class="mdesc">
 998
 999                    <div class="short">Select a node.</div>
1000
1001
1002
1003                     <div class="long">
1004
1005                                 Select a node.
1006
1007
1008
1009
1010
1011
1012                                 <dl class="detailList">
1013                                 <dt class="heading">Parameters:</dt>
1014
1015                                         <dt>
1016                                                 <span class="fixedFont">TreeNode</span>  <b>node</b>
1017
1018                                         </dt>
1019                                         <dd>The node to select</dd>
1020
1021                                         <dt>
1022                                                 <span class="fixedFont">EventObject</span>  <b>e</b>
1023
1024                                         </dt>
1025                                         <dd>(optional) An event associated with the selection</dd>
1026
1027                                         <dt>
1028                                                 <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>
1029
1030                                         </dt>
1031                                         <dd>True to retain existing selections</dd>
1032
1033                                 </dl>
1034
1035
1036
1037
1038
1039                                 <dl class="detailList">
1040                                 <dt class="heading">Returns:</dt>
1041
1042                                         <dd><span class="fixedFont">TreeNode</span>  The selected node</dd>
1043
1044                                 </dl>
1045
1046
1047
1048
1049
1050
1051
1052                     </div>
1053                 </div>
1054
1055             </td>
1056             <td class="msource">
1057
1058                         Roo.tree.MultiSelectionModel
1059                 &nbsp;
1060             </td>
1061         </tr>
1062
1063
1064           <tr class="method-row config-row-alt0 expandable">
1065             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1066
1067
1068             <td class="sig">
1069                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1070                 <div class="fixedFont">
1071                         <span class="attributes"></span><b class="itemname">un</b>
1072
1073                                  (<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>)
1074
1075
1076
1077                 </div>
1078                 <div class="mdesc">
1079
1080                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1081
1082
1083
1084                     <div class="long">
1085
1086                                 Removes a listener (shorthand for removeListener)
1087
1088
1089
1090
1091
1092
1093                                 <dl class="detailList">
1094                                 <dt class="heading">Parameters:</dt>
1095
1096                                         <dt>
1097                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1098
1099                                         </dt>
1100                                         <dd>The type of event to listen for</dd>
1101
1102                                         <dt>
1103                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1104
1105                                         </dt>
1106                                         <dd>The handler to remove</dd>
1107
1108                                         <dt>
1109                                                 <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>
1110
1111                                         </dt>
1112                                         <dd>(optional) The scope (this object) for the handler</dd>
1113
1114                                 </dl>
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126                     </div>
1127                 </div>
1128
1129             </td>
1130             <td class="msource">
1131
1132                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1133                 &nbsp;
1134             </td>
1135         </tr>
1136
1137
1138           <tr class="method-row config-row-alt1 expandable notInherited">
1139             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1140
1141
1142             <td class="sig">
1143                 <a id="Roo.tree.MultiSelectionModel-method-unselect"   name=".unselect"></a>
1144                 <div class="fixedFont">
1145                         <span class="attributes"></span><b class="itemname">unselect</b>
1146
1147                                  (TreeNode <B><i>node</i></B>)
1148
1149
1150
1151                 </div>
1152                 <div class="mdesc">
1153
1154                    <div class="short">Deselect a node.</div>
1155
1156
1157
1158                     <div class="long">
1159
1160                                 Deselect a node.
1161
1162
1163
1164
1165
1166
1167                                 <dl class="detailList">
1168                                 <dt class="heading">Parameters:</dt>
1169
1170                                         <dt>
1171                                                 <span class="fixedFont">TreeNode</span>  <b>node</b>
1172
1173                                         </dt>
1174                                         <dd>The node to unselect</dd>
1175
1176                                 </dl>
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188                     </div>
1189                 </div>
1190
1191             </td>
1192             <td class="msource">
1193
1194                         Roo.tree.MultiSelectionModel
1195                 &nbsp;
1196             </td>
1197         </tr>
1198
1199
1200     </table>
1201
1202
1203   <!-- ============================== events summary / details ======================== -->
1204
1205
1206   <a id="Roo.tree.MultiSelectionModel-events"></a>
1207
1208
1209
1210
1211
1212
1213
1214
1215       <table cellspacing="0" class="member-table">
1216                 <caption>Events</caption>
1217               <thead>
1218                 <tr>
1219                     <th class="sig-header" colspan="2">Event</th>
1220                     <th class="msource-header">Defined By</th>
1221
1222                 </tr>
1223               </thead>
1224
1225
1226
1227
1228
1229           <tr class="method-row expandable config-row-alt0 notInherited">
1230             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1231
1232             <td class="sig">
1233                 <a id="Roo.tree.MultiSelectionModel-event-*selectionchange"></a>
1234
1235                <div class="fixedFont">
1236                 <b class="itemname">selectionchange</b> (MultiSelectionModel <B><i>this</i></B>, <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a> <B><i>nodes</i></B>)
1237
1238                 </div>
1239
1240                 <div class="mdesc">
1241
1242                    <div class="short">Fires when the selected nodes change
1243
1244                 </div>
1245
1246                     <div class="long">
1247
1248                         Fires when the selected nodes change
1249
1250
1251
1252
1253
1254                                 <dl class="detailList">
1255                                 <dt class="heading">Parameters:</dt>
1256
1257                                         <dt>
1258                                                 <span class="fixedFont">MultiSelectionModel</span> <b>this</b>
1259
1260                                         </dt>
1261                                         <dd></dd>
1262
1263                                         <dt>
1264                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>nodes</b>
1265
1266                                         </dt>
1267                                         <dd>Array of the selected nodes</dd>
1268
1269                                 </dl>
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281                     </div>
1282                 </div>
1283
1284             </td>
1285             <td class="msource">
1286                 Roo.tree.MultiSelectionModel
1287             </td>
1288         </tr>
1289
1290
1291     </table>
1292
1293
1294
1295
1296
1297 <!-- ============================== footer ================================= -->
1298                 <div class="fineprint" style="clear:both">
1299
1300                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Wed May 02 2012 14:21:13 GMT+0800 (HKT)
1301                         Based on
1302                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1303                 </div>
1304         </body>
1305 </html>