git.roojs.org Git - roojs1/blob - docs/symbols/Roo.grid.RowSelectionModel.json

   1 {
   2   "name" : "Roo.grid.RowSelectionModel",
   3   "augments" : [
   4     "Roo.grid.AbstractSelectionModel",
   5     "Roo.util.Observable"
   6   ],
   7   "desc" : "The default SelectionModel used by {@link Roo.grid.Grid}.\nIt supports multiple selections and keyboard selection/navigation.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "RowSelectionModel",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "config",
  19       "type" : "Object",
  20       "desc" : "",
  21       "isOptional" : false
  22     }
  23   ],
  24   "returns" : [],
  25   "throws" : "",
  26   "requires" : "",
  27   "config" : [
  28     {
  29       "name" : "listeners",
  30       "type" : "Object",
  31       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  32       "memberOf" : "Roo.util.Observable"
  33     },
  34     {
  35       "name" : "singleSelect",
  36       "type" : "Boolean",
  37       "desc" : "True to allow selection of only one row at a time (defaults to false)",
  38       "memberOf" : ""
  39     }
  40   ],
  41   "methods" : [
  42     {
  43       "name" : "selectRange",
  44       "type" : "function",
  45       "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
  46       "sig" : "(startRow, endRow, keepExisting)",
  47       "static" : false,
  48       "memberOf" : "",
  49       "isStatic" : false,
  50       "isConstructor" : false,
  51       "isPrivate" : false,
  52       "example" : "",
  53       "deprecated" : "",
  54       "since" : "",
  55       "see" : "",
  56       "exceptions" : "",
  57       "requires" : "",
  58       "params" : [
  59         {
  60           "name" : "startRow",
  61           "type" : "Number",
  62           "desc" : "The index of the first row in the range",
  63           "isOptional" : false
  64         },
  65         {
  66           "name" : "endRow",
  67           "type" : "Number",
  68           "desc" : "The index of the last row in the range",
  69           "isOptional" : false
  70         },
  71         {
  72           "name" : "keepExisting",
  73           "type" : "Boolean",
  74           "desc" : "(optional) True to retain existing selections",
  75           "isOptional" : false
  76         }
  77       ],
  78       "returns" : []
  79     },
  80     {
  81       "name" : "selectFirstRow",
  82       "type" : "function",
  83       "desc" : "Selects the first row in the grid.",
  84       "sig" : "()\n{\n\n}",
  85       "static" : false,
  86       "memberOf" : "",
  87       "isStatic" : false,
  88       "isConstructor" : false,
  89       "isPrivate" : false,
  90       "example" : "",
  91       "deprecated" : "",
  92       "since" : "",
  93       "see" : "",
  94       "exceptions" : "",
  95       "requires" : "",
  96       "params" : [],
  97       "returns" : []
  98     },
  99     {
 100       "name" : "deselectRow",
 101       "type" : "function",
 102       "desc" : "Deselects a row.",
 103       "sig" : "(row)",
 104       "static" : false,
 105       "memberOf" : "",
 106       "isStatic" : false,
 107       "isConstructor" : false,
 108       "isPrivate" : false,
 109       "example" : "",
 110       "deprecated" : "",
 111       "since" : "",
 112       "see" : "",
 113       "exceptions" : "",
 114       "requires" : "",
 115       "params" : [
 116         {
 117           "name" : "row",
 118           "type" : "Number",
 119           "desc" : "The index of the row to deselect",
 120           "isOptional" : false
 121         }
 122       ],
 123       "returns" : []
 124     },
 125     {
 126       "name" : "getCount",
 127       "type" : "function",
 128       "desc" : "Gets the number of selected rows.",
 129       "sig" : "()\n{\n\n}",
 130       "static" : false,
 131       "memberOf" : "",
 132       "isStatic" : false,
 133       "isConstructor" : false,
 134       "isPrivate" : false,
 135       "example" : "",
 136       "deprecated" : "",
 137       "since" : "",
 138       "see" : "",
 139       "exceptions" : "",
 140       "requires" : "",
 141       "params" : [],
 142       "returns" : [
 143         {
 144           "name" : "",
 145           "type" : "Number",
 146           "desc" : ""
 147         }
 148       ]
 149     },
 150     {
 151       "name" : "isSelected",
 152       "type" : "function",
 153       "desc" : "Returns True if the specified row is selected.",
 154       "sig" : "(record)",
 155       "static" : false,
 156       "memberOf" : "",
 157       "isStatic" : false,
 158       "isConstructor" : false,
 159       "isPrivate" : false,
 160       "example" : "",
 161       "deprecated" : "",
 162       "since" : "",
 163       "see" : "",
 164       "exceptions" : "",
 165       "requires" : "",
 166       "params" : [
 167         {
 168           "name" : "record",
 169           "type" : "Number/Record",
 170           "desc" : "The record or index of the record to check",
 171           "isOptional" : false
 172         }
 173       ],
 174       "returns" : [
 175         {
 176           "name" : "",
 177           "type" : "Boolean",
 178           "desc" : ""
 179         }
 180       ]
 181     },
 182     {
 183       "name" : "selectLastRow",
 184       "type" : "function",
 185       "desc" : "Select the last row.",
 186       "sig" : "(keepExisting)",
 187       "static" : false,
 188       "memberOf" : "",
 189       "isStatic" : false,
 190       "isConstructor" : false,
 191       "isPrivate" : false,
 192       "example" : "",
 193       "deprecated" : "",
 194       "since" : "",
 195       "see" : "",
 196       "exceptions" : "",
 197       "requires" : "",
 198       "params" : [
 199         {
 200           "name" : "keepExisting",
 201           "type" : "Boolean",
 202           "desc" : "(optional) True to keep existing selections",
 203           "isOptional" : false
 204         }
 205       ],
 206       "returns" : []
 207     },
 208     {
 209       "name" : "hasSelection",
 210       "type" : "function",
 211       "desc" : "Returns True if there is a selection.",
 212       "sig" : "()\n{\n\n}",
 213       "static" : false,
 214       "memberOf" : "",
 215       "isStatic" : false,
 216       "isConstructor" : false,
 217       "isPrivate" : false,
 218       "example" : "",
 219       "deprecated" : "",
 220       "since" : "",
 221       "see" : "",
 222       "exceptions" : "",
 223       "requires" : "",
 224       "params" : [],
 225       "returns" : [
 226         {
 227           "name" : "",
 228           "type" : "Boolean",
 229           "desc" : ""
 230         }
 231       ]
 232     },
 233     {
 234       "name" : "isIdSelected",
 235       "type" : "function",
 236       "desc" : "Returns True if the specified record id is selected.",
 237       "sig" : "(id)",
 238       "static" : false,
 239       "memberOf" : "",
 240       "isStatic" : false,
 241       "isConstructor" : false,
 242       "isPrivate" : false,
 243       "example" : "",
 244       "deprecated" : "",
 245       "since" : "",
 246       "see" : "",
 247       "exceptions" : "",
 248       "requires" : "",
 249       "params" : [
 250         {
 251           "name" : "id",
 252           "type" : "String",
 253           "desc" : "The id of record to check",
 254           "isOptional" : false
 255         }
 256       ],
 257       "returns" : [
 258         {
 259           "name" : "",
 260           "type" : "Boolean",
 261           "desc" : ""
 262         }
 263       ]
 264     },
 265     {
 266       "name" : "getSelected",
 267       "type" : "function",
 268       "desc" : "Returns the first selected record.",
 269       "sig" : "()\n{\n\n}",
 270       "static" : false,
 271       "memberOf" : "",
 272       "isStatic" : false,
 273       "isConstructor" : false,
 274       "isPrivate" : false,
 275       "example" : "",
 276       "deprecated" : "",
 277       "since" : "",
 278       "see" : "",
 279       "exceptions" : "",
 280       "requires" : "",
 281       "params" : [],
 282       "returns" : [
 283         {
 284           "name" : "",
 285           "type" : "Record",
 286           "desc" : ""
 287         }
 288       ]
 289     },
 290     {
 291       "name" : "selectRecords",
 292       "type" : "function",
 293       "desc" : "Select records.",
 294       "sig" : "(records, keepExisting)",
 295       "static" : false,
 296       "memberOf" : "",
 297       "isStatic" : false,
 298       "isConstructor" : false,
 299       "isPrivate" : false,
 300       "example" : "",
 301       "deprecated" : "",
 302       "since" : "",
 303       "see" : "",
 304       "exceptions" : "",
 305       "requires" : "",
 306       "params" : [
 307         {
 308           "name" : "records",
 309           "type" : "Array",
 310           "desc" : "The records to select",
 311           "isOptional" : false
 312         },
 313         {
 314           "name" : "keepExisting",
 315           "type" : "Boolean",
 316           "desc" : "(optional) True to keep existing selections",
 317           "isOptional" : false
 318         }
 319       ],
 320       "returns" : []
 321     },
 322     {
 323       "name" : "clearSelections",
 324       "type" : "function",
 325       "desc" : "Clears all selections.",
 326       "sig" : "()\n{\n\n}",
 327       "static" : false,
 328       "memberOf" : "",
 329       "isStatic" : false,
 330       "isConstructor" : false,
 331       "isPrivate" : false,
 332       "example" : "",
 333       "deprecated" : "",
 334       "since" : "",
 335       "see" : "",
 336       "exceptions" : "",
 337       "requires" : "",
 338       "params" : [],
 339       "returns" : []
 340     },
 341     {
 342       "name" : "deselectRange",
 343       "type" : "function",
 344       "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
 345       "sig" : "(startRow, endRow)",
 346       "static" : false,
 347       "memberOf" : "",
 348       "isStatic" : false,
 349       "isConstructor" : false,
 350       "isPrivate" : false,
 351       "example" : "",
 352       "deprecated" : "",
 353       "since" : "",
 354       "see" : "",
 355       "exceptions" : "",
 356       "requires" : "",
 357       "params" : [
 358         {
 359           "name" : "startRow",
 360           "type" : "Number",
 361           "desc" : "The index of the first row in the range",
 362           "isOptional" : false
 363         },
 364         {
 365           "name" : "endRow",
 366           "type" : "Number",
 367           "desc" : "The index of the last row in the range",
 368           "isOptional" : false
 369         }
 370       ],
 371       "returns" : []
 372     },
 373     {
 374       "name" : "getSelections",
 375       "type" : "function",
 376       "desc" : "Returns the selected records",
 377       "sig" : "()\n{\n\n}",
 378       "static" : false,
 379       "memberOf" : "",
 380       "isStatic" : false,
 381       "isConstructor" : false,
 382       "isPrivate" : false,
 383       "example" : "",
 384       "deprecated" : "",
 385       "since" : "",
 386       "see" : "",
 387       "exceptions" : "",
 388       "requires" : "",
 389       "params" : [],
 390       "returns" : [
 391         {
 392           "name" : "",
 393           "type" : "Array",
 394           "desc" : "Array of selected records"
 395         }
 396       ]
 397     },
 398     {
 399       "name" : "selectNext",
 400       "type" : "function",
 401       "desc" : "Selects the row immediately following the last selected row.",
 402       "sig" : "(keepExisting)",
 403       "static" : false,
 404       "memberOf" : "",
 405       "isStatic" : false,
 406       "isConstructor" : false,
 407       "isPrivate" : false,
 408       "example" : "",
 409       "deprecated" : "",
 410       "since" : "",
 411       "see" : "",
 412       "exceptions" : "",
 413       "requires" : "",
 414       "params" : [
 415         {
 416           "name" : "keepExisting",
 417           "type" : "Boolean",
 418           "desc" : "(optional) True to keep existing selections",
 419           "isOptional" : false
 420         }
 421       ],
 422       "returns" : []
 423     },
 424     {
 425       "name" : "selectAll",
 426       "type" : "function",
 427       "desc" : "Selects all rows.",
 428       "sig" : "()\n{\n\n}",
 429       "static" : false,
 430       "memberOf" : "",
 431       "isStatic" : false,
 432       "isConstructor" : false,
 433       "isPrivate" : false,
 434       "example" : "",
 435       "deprecated" : "",
 436       "since" : "",
 437       "see" : "",
 438       "exceptions" : "",
 439       "requires" : "",
 440       "params" : [],
 441       "returns" : []
 442     },
 443     {
 444       "name" : "selectRow",
 445       "type" : "function",
 446       "desc" : "Selects a row.",
 447       "sig" : "(row, keepExisting)",
 448       "static" : false,
 449       "memberOf" : "",
 450       "isStatic" : false,
 451       "isConstructor" : false,
 452       "isPrivate" : false,
 453       "example" : "",
 454       "deprecated" : "",
 455       "since" : "",
 456       "see" : "",
 457       "exceptions" : "",
 458       "requires" : "",
 459       "params" : [
 460         {
 461           "name" : "row",
 462           "type" : "Number",
 463           "desc" : "The index of the row to select",
 464           "isOptional" : false
 465         },
 466         {
 467           "name" : "keepExisting",
 468           "type" : "Boolean",
 469           "desc" : "(optional) True to keep existing selections",
 470           "isOptional" : false
 471         }
 472       ],
 473       "returns" : []
 474     },
 475     {
 476       "name" : "selectRows",
 477       "type" : "function",
 478       "desc" : "Selects multiple rows.",
 479       "sig" : "(rows, keepExisting)",
 480       "static" : false,
 481       "memberOf" : "",
 482       "isStatic" : false,
 483       "isConstructor" : false,
 484       "isPrivate" : false,
 485       "example" : "",
 486       "deprecated" : "",
 487       "since" : "",
 488       "see" : "",
 489       "exceptions" : "",
 490       "requires" : "",
 491       "params" : [
 492         {
 493           "name" : "rows",
 494           "type" : "Array",
 495           "desc" : "Array of the indexes of the row to select",
 496           "isOptional" : false
 497         },
 498         {
 499           "name" : "keepExisting",
 500           "type" : "Boolean",
 501           "desc" : "(optional) True to keep existing selections",
 502           "isOptional" : false
 503         }
 504       ],
 505       "returns" : []
 506     },
 507     {
 508       "name" : "selectPrevious",
 509       "type" : "function",
 510       "desc" : "Selects the row that precedes the last selected row.",
 511       "sig" : "(keepExisting)",
 512       "static" : false,
 513       "memberOf" : "",
 514       "isStatic" : false,
 515       "isConstructor" : false,
 516       "isPrivate" : false,
 517       "example" : "",
 518       "deprecated" : "",
 519       "since" : "",
 520       "see" : "",
 521       "exceptions" : "",
 522       "requires" : "",
 523       "params" : [
 524         {
 525           "name" : "keepExisting",
 526           "type" : "Boolean",
 527           "desc" : "(optional) True to keep existing selections",
 528           "isOptional" : false
 529         }
 530       ],
 531       "returns" : []
 532     },
 533     {
 534       "name" : "lock",
 535       "type" : "function",
 536       "desc" : "Locks the selections.",
 537       "sig" : "()\n{\n\n}",
 538       "static" : false,
 539       "memberOf" : "Roo.grid.AbstractSelectionModel",
 540       "isStatic" : false,
 541       "isConstructor" : false,
 542       "isPrivate" : false,
 543       "example" : "",
 544       "deprecated" : "",
 545       "since" : "",
 546       "see" : "",
 547       "exceptions" : "",
 548       "requires" : "",
 549       "params" : [],
 550       "returns" : []
 551     },
 552     {
 553       "name" : "isLocked",
 554       "type" : "function",
 555       "desc" : "Returns true if the selections are locked.",
 556       "sig" : "()\n{\n\n}",
 557       "static" : false,
 558       "memberOf" : "Roo.grid.AbstractSelectionModel",
 559       "isStatic" : false,
 560       "isConstructor" : false,
 561       "isPrivate" : false,
 562       "example" : "",
 563       "deprecated" : "",
 564       "since" : "",
 565       "see" : "",
 566       "exceptions" : "",
 567       "requires" : "",
 568       "params" : [],
 569       "returns" : [
 570         {
 571           "name" : "",
 572           "type" : "Boolean",
 573           "desc" : ""
 574         }
 575       ]
 576     },
 577     {
 578       "name" : "unlock",
 579       "type" : "function",
 580       "desc" : "Unlocks the selections.",
 581       "sig" : "()\n{\n\n}",
 582       "static" : false,
 583       "memberOf" : "Roo.grid.AbstractSelectionModel",
 584       "isStatic" : false,
 585       "isConstructor" : false,
 586       "isPrivate" : false,
 587       "example" : "",
 588       "deprecated" : "",
 589       "since" : "",
 590       "see" : "",
 591       "exceptions" : "",
 592       "requires" : "",
 593       "params" : [],
 594       "returns" : []
 595     },
 596     {
 597       "name" : "purgeListeners",
 598       "type" : "function",
 599       "desc" : "Removes all listeners for this object",
 600       "sig" : "()\n{\n\n}",
 601       "static" : false,
 602       "memberOf" : "Roo.util.Observable",
 603       "isStatic" : false,
 604       "isConstructor" : false,
 605       "isPrivate" : false,
 606       "example" : "",
 607       "deprecated" : "",
 608       "since" : "",
 609       "see" : "",
 610       "exceptions" : "",
 611       "requires" : "",
 612       "params" : [],
 613       "returns" : []
 614     },
 615     {
 616       "name" : "on",
 617       "type" : "function",
 618       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 619       "sig" : "(eventName, handler, scope, options)",
 620       "static" : false,
 621       "memberOf" : "Roo.util.Observable",
 622       "isStatic" : false,
 623       "isConstructor" : false,
 624       "isPrivate" : false,
 625       "example" : "",
 626       "deprecated" : "",
 627       "since" : "",
 628       "see" : "",
 629       "exceptions" : "",
 630       "requires" : "",
 631       "params" : [
 632         {
 633           "name" : "eventName",
 634           "type" : "String",
 635           "desc" : "The type of event to listen for",
 636           "isOptional" : false
 637         },
 638         {
 639           "name" : "handler",
 640           "type" : "Function",
 641           "desc" : "The method the event invokes",
 642           "isOptional" : false
 643         },
 644         {
 645           "name" : "scope",
 646           "type" : "Object",
 647           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 648           "isOptional" : false
 649         },
 650         {
 651           "name" : "options",
 652           "type" : "Object",
 653           "desc" : "(optional)",
 654           "isOptional" : false
 655         }
 656       ],
 657       "returns" : []
 658     },
 659     {
 660       "name" : "un",
 661       "type" : "function",
 662       "desc" : "Removes a listener (shorthand for removeListener)",
 663       "sig" : "(eventName, handler, scope)",
 664       "static" : false,
 665       "memberOf" : "Roo.util.Observable",
 666       "isStatic" : false,
 667       "isConstructor" : false,
 668       "isPrivate" : false,
 669       "example" : "",
 670       "deprecated" : "",
 671       "since" : "",
 672       "see" : "",
 673       "exceptions" : "",
 674       "requires" : "",
 675       "params" : [
 676         {
 677           "name" : "eventName",
 678           "type" : "String",
 679           "desc" : "The type of event to listen for",
 680           "isOptional" : false
 681         },
 682         {
 683           "name" : "handler",
 684           "type" : "Function",
 685           "desc" : "The handler to remove",
 686           "isOptional" : false
 687         },
 688         {
 689           "name" : "scope",
 690           "type" : "Object",
 691           "desc" : "(optional) The scope (this object) for the handler",
 692           "isOptional" : false
 693         }
 694       ],
 695       "returns" : []
 696     },
 697     {
 698       "name" : "addEvents",
 699       "type" : "function",
 700       "desc" : "Used to define events on this Observable",
 701       "sig" : "(object)",
 702       "static" : false,
 703       "memberOf" : "Roo.util.Observable",
 704       "isStatic" : false,
 705       "isConstructor" : false,
 706       "isPrivate" : false,
 707       "example" : "",
 708       "deprecated" : "",
 709       "since" : "",
 710       "see" : "",
 711       "exceptions" : "",
 712       "requires" : "",
 713       "params" : [
 714         {
 715           "name" : "object",
 716           "type" : "Object",
 717           "desc" : "The object with the events defined",
 718           "isOptional" : false
 719         }
 720       ],
 721       "returns" : []
 722     },
 723     {
 724       "name" : "releaseCapture",
 725       "type" : "function",
 726       "desc" : "Removes <b>all</b> added captures from the Observable.",
 727       "sig" : "(o)",
 728       "static" : true,
 729       "memberOf" : "Roo.util.Observable",
 730       "isStatic" : true,
 731       "isConstructor" : false,
 732       "isPrivate" : false,
 733       "example" : "",
 734       "deprecated" : "",
 735       "since" : "",
 736       "see" : "",
 737       "exceptions" : "",
 738       "requires" : "",
 739       "params" : [
 740         {
 741           "name" : "o",
 742           "type" : "Observable",
 743           "desc" : "The Observable to release",
 744           "isOptional" : false
 745         }
 746       ],
 747       "returns" : []
 748     },
 749     {
 750       "name" : "removeListener",
 751       "type" : "function",
 752       "desc" : "Removes a listener",
 753       "sig" : "(eventName, handler, scope)",
 754       "static" : false,
 755       "memberOf" : "Roo.util.Observable",
 756       "isStatic" : false,
 757       "isConstructor" : false,
 758       "isPrivate" : false,
 759       "example" : "",
 760       "deprecated" : "",
 761       "since" : "",
 762       "see" : "",
 763       "exceptions" : "",
 764       "requires" : "",
 765       "params" : [
 766         {
 767           "name" : "eventName",
 768           "type" : "String",
 769           "desc" : "The type of event to listen for",
 770           "isOptional" : false
 771         },
 772         {
 773           "name" : "handler",
 774           "type" : "Function",
 775           "desc" : "The handler to remove",
 776           "isOptional" : false
 777         },
 778         {
 779           "name" : "scope",
 780           "type" : "Object",
 781           "desc" : "(optional) The scope (this object) for the handler",
 782           "isOptional" : false
 783         }
 784       ],
 785       "returns" : []
 786     },
 787     {
 788       "name" : "fireEvent",
 789       "type" : "function",
 790       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 791       "sig" : "(eventName, args)",
 792       "static" : false,
 793       "memberOf" : "Roo.util.Observable",
 794       "isStatic" : false,
 795       "isConstructor" : false,
 796       "isPrivate" : false,
 797       "example" : "",
 798       "deprecated" : "",
 799       "since" : "",
 800       "see" : "",
 801       "exceptions" : "",
 802       "requires" : "",
 803       "params" : [
 804         {
 805           "name" : "eventName",
 806           "type" : "String",
 807           "desc" : "",
 808           "isOptional" : false
 809         },
 810         {
 811           "name" : "args",
 812           "type" : "Object...",
 813           "desc" : "Variable number of parameters are passed to handlers",
 814           "isOptional" : false
 815         }
 816       ],
 817       "returns" : [
 818         {
 819           "name" : "",
 820           "type" : "Boolean",
 821           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 822         }
 823       ]
 824     },
 825     {
 826       "name" : "hasListener",
 827       "type" : "function",
 828       "desc" : "Checks to see if this object has any listeners for a specified event",
 829       "sig" : "(eventName)",
 830       "static" : false,
 831       "memberOf" : "Roo.util.Observable",
 832       "isStatic" : false,
 833       "isConstructor" : false,
 834       "isPrivate" : false,
 835       "example" : "",
 836       "deprecated" : "",
 837       "since" : "",
 838       "see" : "",
 839       "exceptions" : "",
 840       "requires" : "",
 841       "params" : [
 842         {
 843           "name" : "eventName",
 844           "type" : "String",
 845           "desc" : "The name of the event to check for",
 846           "isOptional" : false
 847         }
 848       ],
 849       "returns" : [
 850         {
 851           "name" : "",
 852           "type" : "Boolean",
 853           "desc" : "True if the event is being listened for, else false"
 854         }
 855       ]
 856     },
 857     {
 858       "name" : "capture",
 859       "type" : "function",
 860       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
 861       "sig" : "(o, fn, scope)",
 862       "static" : true,
 863       "memberOf" : "Roo.util.Observable",
 864       "isStatic" : true,
 865       "isConstructor" : false,
 866       "isPrivate" : false,
 867       "example" : "",
 868       "deprecated" : "",
 869       "since" : "",
 870       "see" : "",
 871       "exceptions" : "",
 872       "requires" : "",
 873       "params" : [
 874         {
 875           "name" : "o",
 876           "type" : "Observable",
 877           "desc" : "The Observable to capture",
 878           "isOptional" : false
 879         },
 880         {
 881           "name" : "fn",
 882           "type" : "Function",
 883           "desc" : "The function to call",
 884           "isOptional" : false
 885         },
 886         {
 887           "name" : "scope",
 888           "type" : "Object",
 889           "desc" : "(optional) The scope (this object) for the fn",
 890           "isOptional" : false
 891         }
 892       ],
 893       "returns" : []
 894     },
 895     {
 896       "name" : "addListener",
 897       "type" : "function",
 898       "desc" : "Appends an event handler to this component",
 899       "sig" : "(eventName, handler, scope, options)",
 900       "static" : false,
 901       "memberOf" : "Roo.util.Observable",
 902       "isStatic" : false,
 903       "isConstructor" : false,
 904       "isPrivate" : false,
 905       "example" : "",
 906       "deprecated" : "",
 907       "since" : "",
 908       "see" : "",
 909       "exceptions" : "",
 910       "requires" : "",
 911       "params" : [
 912         {
 913           "name" : "eventName",
 914           "type" : "String",
 915           "desc" : "The type of event to listen for",
 916           "isOptional" : false
 917         },
 918         {
 919           "name" : "handler",
 920           "type" : "Function",
 921           "desc" : "The method the event invokes",
 922           "isOptional" : false
 923         },
 924         {
 925           "name" : "scope",
 926           "type" : "Object",
 927           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 928           "isOptional" : false
 929         },
 930         {
 931           "name" : "options",
 932           "type" : "Object",
 933           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
 934           "isOptional" : false
 935         }
 936       ],
 937       "returns" : []
 938     }
 939   ],
 940   "events" : [
 941     {
 942       "name" : "selectionchange",
 943       "type" : "function",
 944       "desc" : "Fires when the selection changes",
 945       "sig" : "function (_self)\n{\n\n}",
 946       "memberOf" : "",
 947       "example" : "",
 948       "deprecated" : "",
 949       "since" : "",
 950       "see" : "",
 951       "params" : [
 952         {
 953           "name" : "this",
 954           "type" : "SelectionModel",
 955           "desc" : "",
 956           "isOptional" : false
 957         }
 958       ],
 959       "returns" : []
 960     },
 961     {
 962       "name" : "rowselect",
 963       "type" : "function",
 964       "desc" : "Fires when a row is selected.",
 965       "sig" : "function (_self, rowIndex, r)\n{\n\n}",
 966       "memberOf" : "",
 967       "example" : "",
 968       "deprecated" : "",
 969       "since" : "",
 970       "see" : "",
 971       "params" : [
 972         {
 973           "name" : "this",
 974           "type" : "SelectionModel",
 975           "desc" : "",
 976           "isOptional" : false
 977         },
 978         {
 979           "name" : "rowIndex",
 980           "type" : "Number",
 981           "desc" : "The selected index",
 982           "isOptional" : false
 983         },
 984         {
 985           "name" : "r",
 986           "type" : "Roo.data.Record",
 987           "desc" : "The record",
 988           "isOptional" : false
 989         }
 990       ],
 991       "returns" : []
 992     },
 993     {
 994       "name" : "beforerowselect",
 995       "type" : "function",
 996       "desc" : "Fires when a row is selected being selected, return false to cancel.",
 997       "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}",
 998       "memberOf" : "",
 999       "example" : "",
1000       "deprecated" : "",
1001       "since" : "",
1002       "see" : "",
1003       "params" : [
1004         {
1005           "name" : "this",
1006           "type" : "SelectionModel",
1007           "desc" : "",
1008           "isOptional" : false
1009         },
1010         {
1011           "name" : "rowIndex",
1012           "type" : "Number",
1013           "desc" : "The selected index",
1014           "isOptional" : false
1015         },
1016         {
1017           "name" : "keepExisting",
1018           "type" : "Boolean",
1019           "desc" : "False if other selections will be cleared",
1020           "isOptional" : false
1021         }
1022       ],
1023       "returns" : []
1024     },
1025     {
1026       "name" : "afterselectionchange",
1027       "type" : "function",
1028       "desc" : "Fires after the selection changes (eg. by key press or clicking)",
1029       "sig" : "function (_self)\n{\n\n}",
1030       "memberOf" : "",
1031       "example" : "",
1032       "deprecated" : "",
1033       "since" : "",
1034       "see" : "",
1035       "params" : [
1036         {
1037           "name" : "this",
1038           "type" : "SelectionModel",
1039           "desc" : "",
1040           "isOptional" : false
1041         }
1042       ],
1043       "returns" : []
1044     },
1045     {
1046       "name" : "rowdeselect",
1047       "type" : "function",
1048       "desc" : "Fires when a row is deselected.",
1049       "sig" : "function (_self, rowIndex)\n{\n\n}",
1050       "memberOf" : "",
1051       "example" : "",
1052       "deprecated" : "",
1053       "since" : "",
1054       "see" : "",
1055       "params" : [
1056         {
1057           "name" : "this",
1058           "type" : "SelectionModel",
1059           "desc" : "",
1060           "isOptional" : false
1061         },
1062         {
1063           "name" : "rowIndex",
1064           "type" : "Number",
1065           "desc" : "The selected index",
1066           "isOptional" : false
1067         }
1068       ],
1069       "returns" : []
1070     }
1071   ]
1072 }