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