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