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      <table cellspacing="0" class="member-table">
 112       <caption class="Empty">Config Options - Has None</caption>
 113      </table>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126   <!-- ============================== public properties ==================== -->
 127
 128
 129
 130     <a id="Roo.tree.MultiSelectionModel-props"></a>
 131
 132
 133
 134
 135
 136      <table cellspacing="0" class="member-table">
 137       <caption class="Empty">Public Properties - Has None</caption>
 138      </table>
 139
 140
 141
 142
 143   <!-- ============================== methods summary / details ======================== -->
 144
 145
 146   <a id="Roo.tree.MultiSelectionModel-methods"></a>
 147         <!-- constructor?? -->
 148
 149         <!-- static's first
 150
 151
 152         -->
 153
 154         <!-- then dynamics first -->
 155
 156
 157
 158
 159
 160
 161       <table cellspacing="0" class="member-table">
 162       <caption>Public Methods</caption>
 163         <tr>
 164             <th class="sig-header" colspan="2">Method</th>
 165             <th class="msource-header">Defined By</th>
 166
 167         </tr>
 168
 169
 170
 171
 172
 173
 174
 175           <tr class="method-row config-row-alt0 notInherited">
 176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 177
 178
 179             <td class="sig">
 180                 <a id="Roo.tree-method-MultiSelectionModel"   name=".MultiSelectionModel"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.tree.</B></span><b class="itemname">MultiSelectionModel</b>
 183
 184                                  ()
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.tree.MultiSelectionModel</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.tree.MultiSelectionModel
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212                     </div>
 213                 </div>
 214
 215             </td>
 216             <td class="msource">
 217                 &nbsp;
 218             </td>
 219         </tr>
 220
 221
 222           <tr class="method-row config-row-alt1 expandable notInherited">
 223             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 224
 225
 226             <td class="sig">
 227                 <a id="Roo.tree.MultiSelectionModel-method-clearSelections"   name=".clearSelections"></a>
 228                 <div class="fixedFont">
 229                         <span class="attributes"></span><b class="itemname">clearSelections</b>
 230
 231                                  ()
 232
 233
 234
 235                 </div>
 236                 <div class="mdesc">
 237
 238                    <div class="short">Clear all selections</div>
 239
 240
 241
 242                     <div class="long">
 243
 244                                 Clear all selections
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261                     </div>
 262                 </div>
 263
 264             </td>
 265             <td class="msource">
 266
 267                         Roo.tree.MultiSelectionModel
 268                 &nbsp;
 269             </td>
 270         </tr>
 271
 272
 273           <tr class="method-row config-row-alt0 expandable notInherited">
 274             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 275
 276
 277             <td class="sig">
 278                 <a id="Roo.tree.MultiSelectionModel-method-getSelectedNodes"   name=".getSelectedNodes"></a>
 279                 <div class="fixedFont">
 280                         <span class="attributes"></span><b class="itemname">getSelectedNodes</b>
 281
 282                                  ()
 283
 284
 285                                          :
 286
 287
 288                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 289
 290
 291
 292
 293
 294                 </div>
 295                 <div class="mdesc">
 296
 297                    <div class="short">Returns an array of the selected nodes</div>
 298
 299
 300
 301                     <div class="long">
 302
 303                                 Returns an array of the selected nodes
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314                                 <dl class="detailList">
 315                                 <dt class="heading">Returns:</dt>
 316
 317                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  </dd>
 318
 319                                 </dl>
 320
 321
 322
 323
 324
 325
 326
 327                     </div>
 328                 </div>
 329
 330             </td>
 331             <td class="msource">
 332
 333                         Roo.tree.MultiSelectionModel
 334                 &nbsp;
 335             </td>
 336         </tr>
 337
 338
 339           <tr class="method-row config-row-alt1 expandable notInherited">
 340             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 341
 342
 343             <td class="sig">
 344                 <a id="Roo.tree.MultiSelectionModel-method-isSelected"   name=".isSelected"></a>
 345                 <div class="fixedFont">
 346                         <span class="attributes"></span><b class="itemname">isSelected</b>
 347
 348                                  (TreeNode <B><i>node</i></B>)
 349
 350
 351                                          :
 352
 353
 354                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 355
 356
 357
 358
 359
 360                 </div>
 361                 <div class="mdesc">
 362
 363                    <div class="short">Returns true if the node is selected</div>
 364
 365
 366
 367                     <div class="long">
 368
 369                                 Returns true if the node is selected
 370
 371
 372
 373
 374
 375
 376                                 <dl class="detailList">
 377                                 <dt class="heading">Parameters:</dt>
 378
 379                                         <dt>
 380                                                 <span class="fixedFont">TreeNode</span>  <b>node</b>
 381
 382                                         </dt>
 383                                         <dd>The node to check</dd>
 384
 385                                 </dl>
 386
 387
 388
 389
 390
 391                                 <dl class="detailList">
 392                                 <dt class="heading">Returns:</dt>
 393
 394                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  </dd>
 395
 396                                 </dl>
 397
 398
 399
 400
 401
 402
 403
 404                     </div>
 405                 </div>
 406
 407             </td>
 408             <td class="msource">
 409
 410                         Roo.tree.MultiSelectionModel
 411                 &nbsp;
 412             </td>
 413         </tr>
 414
 415
 416           <tr class="method-row config-row-alt0 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-select"   name=".select"></a>
 422                 <div class="fixedFont">
 423                         <span class="attributes"></span><b class="itemname">select</b>
 424
 425                                  (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>)
 426
 427
 428                                          :
 429
 430
 431                                                 TreeNode
 432
 433
 434
 435
 436
 437                 </div>
 438                 <div class="mdesc">
 439
 440                    <div class="short">Select a node.</div>
 441
 442
 443
 444                     <div class="long">
 445
 446                                 Select a node.
 447
 448
 449
 450
 451
 452
 453                                 <dl class="detailList">
 454                                 <dt class="heading">Parameters:</dt>
 455
 456                                         <dt>
 457                                                 <span class="fixedFont">TreeNode</span>  <b>node</b>
 458
 459                                         </dt>
 460                                         <dd>The node to select</dd>
 461
 462                                         <dt>
 463                                                 <span class="fixedFont">EventObject</span>  <b>e</b>
 464
 465                                         </dt>
 466                                         <dd>(optional) An event associated with the selection</dd>
 467
 468                                         <dt>
 469                                                 <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>
 470
 471                                         </dt>
 472                                         <dd>True to retain existing selections</dd>
 473
 474                                 </dl>
 475
 476
 477
 478
 479
 480                                 <dl class="detailList">
 481                                 <dt class="heading">Returns:</dt>
 482
 483                                         <dd><span class="fixedFont">TreeNode</span>  The selected node</dd>
 484
 485                                 </dl>
 486
 487
 488
 489
 490
 491
 492
 493                     </div>
 494                 </div>
 495
 496             </td>
 497             <td class="msource">
 498
 499                         Roo.tree.MultiSelectionModel
 500                 &nbsp;
 501             </td>
 502         </tr>
 503
 504
 505           <tr class="method-row config-row-alt1 expandable notInherited">
 506             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 507
 508
 509             <td class="sig">
 510                 <a id="Roo.tree.MultiSelectionModel-method-unselect"   name=".unselect"></a>
 511                 <div class="fixedFont">
 512                         <span class="attributes"></span><b class="itemname">unselect</b>
 513
 514                                  (TreeNode <B><i>node</i></B>)
 515
 516
 517
 518                 </div>
 519                 <div class="mdesc">
 520
 521                    <div class="short">Deselect a node.</div>
 522
 523
 524
 525                     <div class="long">
 526
 527                                 Deselect a node.
 528
 529
 530
 531
 532
 533
 534                                 <dl class="detailList">
 535                                 <dt class="heading">Parameters:</dt>
 536
 537                                         <dt>
 538                                                 <span class="fixedFont">TreeNode</span>  <b>node</b>
 539
 540                                         </dt>
 541                                         <dd>The node to unselect</dd>
 542
 543                                 </dl>
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555                     </div>
 556                 </div>
 557
 558             </td>
 559             <td class="msource">
 560
 561                         Roo.tree.MultiSelectionModel
 562                 &nbsp;
 563             </td>
 564         </tr>
 565
 566
 567     </table>
 568
 569
 570   <!-- ============================== events summary / details ======================== -->
 571
 572
 573   <a id="Roo.tree.MultiSelectionModel-events"></a>
 574
 575
 576
 577
 578
 579
 580
 581
 582       <table cellspacing="0" class="member-table">
 583                 <caption>Events</caption>
 584               <thead>
 585                 <tr>
 586                     <th class="sig-header" colspan="2">Event</th>
 587                     <th class="msource-header">Defined By</th>
 588
 589                 </tr>
 590               </thead>
 591
 592
 593
 594
 595
 596           <tr class="method-row expandable config-row-alt0 notInherited">
 597             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 598
 599             <td class="sig">
 600                 <a id="Roo.tree.MultiSelectionModel-event-*selectionchange"></a>
 601
 602                <div class="fixedFont">
 603                 <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>)
 604
 605                 </div>
 606
 607                 <div class="mdesc">
 608
 609                    <div class="short">Fires when the selected nodes change
 610
 611                 </div>
 612
 613                     <div class="long">
 614
 615                         Fires when the selected nodes change
 616
 617
 618
 619
 620
 621                                 <dl class="detailList">
 622                                 <dt class="heading">Parameters:</dt>
 623
 624                                         <dt>
 625                                                 <span class="fixedFont">MultiSelectionModel</span> <b>this</b>
 626
 627                                         </dt>
 628                                         <dd></dd>
 629
 630                                         <dt>
 631                                                 <span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span> <b>nodes</b>
 632
 633                                         </dt>
 634                                         <dd>Array of the selected nodes</dd>
 635
 636                                 </dl>
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648                     </div>
 649                 </div>
 650
 651             </td>
 652             <td class="msource">
 653                 Roo.tree.MultiSelectionModel
 654             </td>
 655         </tr>
 656
 657
 658     </table>
 659
 660
 661
 662
 663
 664 <!-- ============================== footer ================================= -->
 665                 <div class="fineprint" style="clear:both">
 666
 667                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 19:32:57 GMT+0800 (HKT)
 668                         Based on
 669                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 670                 </div>
 671         </body>
 672 </html>