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