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

   1 {
   2   "name" : "Roo.grid.Grid",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "This class represents the primary interface of a component based grid control.\n<br><br>Usage:<pre><code>\n var grid = new Roo.grid.Grid(\"my-container-id\", {\n     ds: myDataStore,\n     cm: myColModel,\n     selModel: mySelectionModel,\n     autoSizeColumns: true,\n     monitorWindowResize: false,\n     trackMouseOver: true\n });\n // set any options\n grid.render();\n</code></pre>\n<b>Common Problems:</b><br/>\n- Grid does not resize properly when going smaller: Setting overflow hidden on the container\nelement will correct this<br/>\n- If you get el.style[camel]= NaNpx or -2px or something related, be certain you have given your container element\ndimensions. The grid adapts to your container's size, if your container has no size defined then the results\nare unpredictable.<br/>\n- Do not render the grid into an element with display:none. Try using visibility:hidden. Otherwise there is no way for the\ngrid to calculate dimensions/offsets.<br/>",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "Grid",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "container",
  18       "type" : "String/HTMLElement/Roo.Element",
  19       "desc" : "The element into which this grid will be rendered -\nThe container MUST have some type of size defined for the grid to fill. The container will be\nautomatically set to position relative if it isn't already.",
  20       "isOptional" : false
  21     },
  22     {
  23       "name" : "config",
  24       "type" : "Object",
  25       "desc" : "A config object that sets properties on this grid.",
  26       "isOptional" : false
  27     }
  28   ],
  29   "returns" : [
  30   ],
  31   "config" : [
  32     {
  33       "name" : "autoSizeColumns",
  34       "type" : "Boolean",
  35       "desc" : "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option.  Default is false.",
  36       "memberOf" : "Roo.grid.Grid",
  37       "values" : [
  38       ]
  39     },
  40     {
  41       "name" : "listeners",
  42       "type" : "Object",
  43       "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>",
  44       "memberOf" : "Roo.util.Observable",
  45       "values" : [
  46       ]
  47     },
  48     {
  49       "name" : "maxRowsToMeasure",
  50       "type" : "Boolean",
  51       "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
  52       "memberOf" : "Roo.grid.Grid",
  53       "values" : [
  54       ]
  55     },
  56     {
  57       "name" : "minColumnWidth",
  58       "type" : "Number",
  59       "desc" : "The minimum width a column can be resized to. Default is 25.",
  60       "memberOf" : "Roo.grid.Grid",
  61       "values" : [
  62       ]
  63     },
  64     {
  65       "name" : "autoExpandColumn",
  66       "type" : "String",
  67       "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
  68       "memberOf" : "Roo.grid.Grid",
  69       "values" : [
  70       ]
  71     },
  72     {
  73       "name" : "autoExpandMax",
  74       "type" : "Number",
  75       "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
  76       "memberOf" : "Roo.grid.Grid",
  77       "values" : [
  78       ]
  79     },
  80     {
  81       "name" : "enableRowHeightSync",
  82       "type" : "Boolean",
  83       "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
  84       "memberOf" : "Roo.grid.Grid",
  85       "values" : [
  86       ]
  87     },
  88     {
  89       "name" : "monitorWindowResize",
  90       "type" : "Boolean",
  91       "desc" : "True to autoSize the grid when the window resizes. Default is true.",
  92       "memberOf" : "Roo.grid.Grid",
  93       "values" : [
  94       ]
  95     },
  96     {
  97       "name" : "autoExpandMin",
  98       "type" : "Number",
  99       "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
 100       "memberOf" : "Roo.grid.Grid",
 101       "values" : [
 102       ]
 103     },
 104     {
 105       "name" : "view",
 106       "type" : "Object",
 107       "desc" : "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
 108       "memberOf" : "Roo.grid.Grid",
 109       "values" : [
 110       ]
 111     },
 112     {
 113       "name" : "autoWidth",
 114       "type" : "Boolean",
 115       "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
 116       "memberOf" : "Roo.grid.Grid",
 117       "values" : [
 118       ]
 119     },
 120     {
 121       "name" : "ddGroup",
 122       "type" : "String",
 123       "desc" : "- drag drop group.",
 124       "memberOf" : "Roo.grid.Grid",
 125       "values" : [
 126       ]
 127     },
 128     {
 129       "name" : "enableDrag",
 130       "type" : "Boolean",
 131       "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
 132       "memberOf" : "Roo.grid.Grid",
 133       "values" : [
 134       ]
 135     },
 136     {
 137       "name" : "maxHeight",
 138       "type" : "Number",
 139       "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
 140       "memberOf" : "Roo.grid.Grid",
 141       "values" : [
 142       ]
 143     },
 144     {
 145       "name" : "trackMouseOver",
 146       "type" : "Boolean",
 147       "desc" : "True to highlight rows when the mouse is over. Default is true.",
 148       "memberOf" : "Roo.grid.Grid",
 149       "values" : [
 150       ]
 151     },
 152     {
 153       "name" : "loadMask",
 154       "type" : "Object",
 155       "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
 156       "memberOf" : "Roo.grid.Grid",
 157       "values" : [
 158       ]
 159     },
 160     {
 161       "name" : "stripeRows",
 162       "type" : "Boolean",
 163       "desc" : "True to stripe the rows.  Default is true.",
 164       "memberOf" : "Roo.grid.Grid",
 165       "values" : [
 166       ]
 167     },
 168     {
 169       "name" : "enableColumnMove",
 170       "type" : "Boolean",
 171       "desc" : "True to enable drag and drop reorder of columns. Default is true.",
 172       "memberOf" : "Roo.grid.Grid",
 173       "values" : [
 174       ]
 175     },
 176     {
 177       "name" : "enableColumnHide",
 178       "type" : "Boolean",
 179       "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
 180       "memberOf" : "Roo.grid.Grid",
 181       "values" : [
 182       ]
 183     },
 184     {
 185       "name" : "autoSizeHeaders",
 186       "type" : "Boolean",
 187       "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
 188       "memberOf" : "Roo.grid.Grid",
 189       "values" : [
 190       ]
 191     },
 192     {
 193       "name" : "enableDragDrop",
 194       "type" : "Boolean",
 195       "desc" : "True to enable drag and drop of rows. Default is false.",
 196       "memberOf" : "Roo.grid.Grid",
 197       "values" : [
 198       ]
 199     },
 200     {
 201       "name" : "dropTarget",
 202       "type" : "Roo.dd.DropTarget",
 203       "desc" : "An {@link Roo.dd.DropTarget} config",
 204       "memberOf" : "Roo.grid.Grid",
 205       "values" : [
 206       ]
 207     },
 208     {
 209       "name" : "autoHeight",
 210       "type" : "Boolean",
 211       "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
 212       "memberOf" : "Roo.grid.Grid",
 213       "values" : [
 214       ]
 215     }
 216   ],
 217   "methods" : [
 218     {
 219       "name" : "getSelectionModel",
 220       "desc" : "Returns the grid's SelectionModel.",
 221       "isStatic" : false,
 222       "isConstructor" : false,
 223       "isPrivate" : false,
 224       "memberOf" : "Roo.grid.Grid",
 225       "example" : "",
 226       "deprecated" : "",
 227       "since" : "",
 228       "see" : "",
 229       "params" : [
 230       ],
 231       "returns" : [
 232         {
 233           "name" : "",
 234           "type" : "SelectionModel",
 235           "desc" : ""
 236         }
 237       ]
 238     },
 239     {
 240       "name" : "destroy",
 241       "desc" : "Destroy this grid.",
 242       "isStatic" : false,
 243       "isConstructor" : false,
 244       "isPrivate" : false,
 245       "memberOf" : "Roo.grid.Grid",
 246       "example" : "",
 247       "deprecated" : "",
 248       "since" : "",
 249       "see" : "",
 250       "params" : [
 251         {
 252           "name" : "removeEl",
 253           "type" : "Boolean",
 254           "desc" : "True to remove the element",
 255           "isOptional" : false
 256         }
 257       ],
 258       "returns" : [
 259       ]
 260     },
 261     {
 262       "name" : "getColumnModel",
 263       "desc" : "Returns the grid's ColumnModel.",
 264       "isStatic" : false,
 265       "isConstructor" : false,
 266       "isPrivate" : false,
 267       "memberOf" : "Roo.grid.Grid",
 268       "example" : "",
 269       "deprecated" : "",
 270       "since" : "",
 271       "see" : "",
 272       "params" : [
 273       ],
 274       "returns" : [
 275         {
 276           "name" : "",
 277           "type" : "ColumnModel",
 278           "desc" : ""
 279         }
 280       ]
 281     },
 282     {
 283       "name" : "getGridEl",
 284       "desc" : "Returns the grid's underlying element.",
 285       "isStatic" : false,
 286       "isConstructor" : false,
 287       "isPrivate" : false,
 288       "memberOf" : "Roo.grid.Grid",
 289       "example" : "",
 290       "deprecated" : "",
 291       "since" : "",
 292       "see" : "",
 293       "params" : [
 294       ],
 295       "returns" : [
 296         {
 297           "name" : "",
 298           "type" : "Element",
 299           "desc" : "The element"
 300         }
 301       ]
 302     },
 303     {
 304       "name" : "getDataSource",
 305       "desc" : "Returns the grid's DataSource.",
 306       "isStatic" : false,
 307       "isConstructor" : false,
 308       "isPrivate" : false,
 309       "memberOf" : "Roo.grid.Grid",
 310       "example" : "",
 311       "deprecated" : "",
 312       "since" : "",
 313       "see" : "",
 314       "params" : [
 315       ],
 316       "returns" : [
 317         {
 318           "name" : "",
 319           "type" : "DataSource",
 320           "desc" : ""
 321         }
 322       ]
 323     },
 324     {
 325       "name" : "autoSize",
 326       "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
 327       "isStatic" : false,
 328       "isConstructor" : false,
 329       "isPrivate" : false,
 330       "memberOf" : "Roo.grid.Grid",
 331       "example" : "",
 332       "deprecated" : "",
 333       "since" : "",
 334       "see" : "",
 335       "params" : [
 336       ],
 337       "returns" : [
 338       ]
 339     },
 340     {
 341       "name" : "getView",
 342       "desc" : "Returns the grid's GridView object.",
 343       "isStatic" : false,
 344       "isConstructor" : false,
 345       "isPrivate" : false,
 346       "memberOf" : "Roo.grid.Grid",
 347       "example" : "",
 348       "deprecated" : "",
 349       "since" : "",
 350       "see" : "",
 351       "params" : [
 352       ],
 353       "returns" : [
 354         {
 355           "name" : "",
 356           "type" : "GridView",
 357           "desc" : ""
 358         }
 359       ]
 360     },
 361     {
 362       "name" : "getDragDropText",
 363       "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
 364       "isStatic" : false,
 365       "isConstructor" : false,
 366       "isPrivate" : false,
 367       "memberOf" : "Roo.grid.Grid",
 368       "example" : "",
 369       "deprecated" : "",
 370       "since" : "",
 371       "see" : "",
 372       "params" : [
 373       ],
 374       "returns" : [
 375         {
 376           "name" : "",
 377           "type" : "String",
 378           "desc" : ""
 379         }
 380       ]
 381     },
 382     {
 383       "name" : "reconfigure",
 384       "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
 385       "isStatic" : false,
 386       "isConstructor" : false,
 387       "isPrivate" : false,
 388       "memberOf" : "Roo.grid.Grid",
 389       "example" : "",
 390       "deprecated" : "",
 391       "since" : "",
 392       "see" : "",
 393       "params" : [
 394         {
 395           "name" : "dataSource",
 396           "type" : "Roo.data.Store",
 397           "desc" : "The new {@link Roo.data.Store} object",
 398           "isOptional" : false
 399         },
 400         {
 401           "name" : "The",
 402           "type" : "Roo.grid.ColumnModel",
 403           "desc" : "new {@link Roo.grid.ColumnModel} object",
 404           "isOptional" : false
 405         }
 406       ],
 407       "returns" : [
 408       ]
 409     },
 410     {
 411       "name" : "addColumns",
 412       "desc" : "addColumns\nAdd's a column, default at the end..",
 413       "isStatic" : false,
 414       "isConstructor" : false,
 415       "isPrivate" : false,
 416       "memberOf" : "Roo.grid.Grid",
 417       "example" : "",
 418       "deprecated" : "",
 419       "since" : "",
 420       "see" : "",
 421       "params" : [
 422         {
 423           "name" : "position",
 424           "type" : "int",
 425           "desc" : "to add (default end)",
 426           "isOptional" : false
 427         },
 428         {
 429           "name" : "of",
 430           "type" : "Array",
 431           "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
 432           "isOptional" : false
 433         }
 434       ],
 435       "returns" : [
 436       ]
 437     },
 438     {
 439       "name" : "render",
 440       "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
 441       "isStatic" : false,
 442       "isConstructor" : false,
 443       "isPrivate" : false,
 444       "memberOf" : "Roo.grid.Grid",
 445       "example" : "",
 446       "deprecated" : "",
 447       "since" : "",
 448       "see" : "",
 449       "params" : [
 450       ],
 451       "returns" : [
 452         {
 453           "name" : "",
 454           "type" : "Roo.grid.Grid",
 455           "desc" : "this"
 456         }
 457       ]
 458     },
 459     {
 460       "name" : "purgeListeners",
 461       "desc" : "Removes all listeners for this object",
 462       "isStatic" : false,
 463       "isConstructor" : false,
 464       "isPrivate" : false,
 465       "memberOf" : "Roo.util.Observable",
 466       "example" : "",
 467       "deprecated" : "",
 468       "since" : "",
 469       "see" : "",
 470       "params" : [
 471       ],
 472       "returns" : [
 473       ]
 474     },
 475     {
 476       "name" : "on",
 477       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 478       "isStatic" : false,
 479       "isConstructor" : false,
 480       "isPrivate" : false,
 481       "memberOf" : "Roo.util.Observable",
 482       "example" : "",
 483       "deprecated" : "",
 484       "since" : "",
 485       "see" : "",
 486       "params" : [
 487         {
 488           "name" : "eventName",
 489           "type" : "String",
 490           "desc" : "The type of event to listen for",
 491           "isOptional" : false
 492         },
 493         {
 494           "name" : "handler",
 495           "type" : "Function",
 496           "desc" : "The method the event invokes",
 497           "isOptional" : false
 498         },
 499         {
 500           "name" : "scope",
 501           "type" : "Object",
 502           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 503           "isOptional" : false
 504         },
 505         {
 506           "name" : "options",
 507           "type" : "Object",
 508           "desc" : "(optional)",
 509           "isOptional" : false
 510         }
 511       ],
 512       "returns" : [
 513       ]
 514     },
 515     {
 516       "name" : "un",
 517       "desc" : "Removes a listener (shorthand for removeListener)",
 518       "isStatic" : false,
 519       "isConstructor" : false,
 520       "isPrivate" : false,
 521       "memberOf" : "Roo.util.Observable",
 522       "example" : "",
 523       "deprecated" : "",
 524       "since" : "",
 525       "see" : "",
 526       "params" : [
 527         {
 528           "name" : "eventName",
 529           "type" : "String",
 530           "desc" : "The type of event to listen for",
 531           "isOptional" : false
 532         },
 533         {
 534           "name" : "handler",
 535           "type" : "Function",
 536           "desc" : "The handler to remove",
 537           "isOptional" : false
 538         },
 539         {
 540           "name" : "scope",
 541           "type" : "Object",
 542           "desc" : "(optional) The scope (this object) for the handler",
 543           "isOptional" : false
 544         }
 545       ],
 546       "returns" : [
 547       ]
 548     },
 549     {
 550       "name" : "addEvents",
 551       "desc" : "Used to define events on this Observable",
 552       "isStatic" : false,
 553       "isConstructor" : false,
 554       "isPrivate" : false,
 555       "memberOf" : "Roo.util.Observable",
 556       "example" : "",
 557       "deprecated" : "",
 558       "since" : "",
 559       "see" : "",
 560       "params" : [
 561         {
 562           "name" : "object",
 563           "type" : "Object",
 564           "desc" : "The object with the events defined",
 565           "isOptional" : false
 566         }
 567       ],
 568       "returns" : [
 569       ]
 570     },
 571     {
 572       "name" : "releaseCapture",
 573       "desc" : "Removes <b>all</b> added captures from the Observable.",
 574       "isStatic" : true,
 575       "isConstructor" : false,
 576       "isPrivate" : false,
 577       "memberOf" : "Roo.util.Observable",
 578       "example" : "",
 579       "deprecated" : "",
 580       "since" : "",
 581       "see" : "",
 582       "params" : [
 583         {
 584           "name" : "o",
 585           "type" : "Observable",
 586           "desc" : "The Observable to release",
 587           "isOptional" : false
 588         }
 589       ],
 590       "returns" : [
 591       ]
 592     },
 593     {
 594       "name" : "removeListener",
 595       "desc" : "Removes a listener",
 596       "isStatic" : false,
 597       "isConstructor" : false,
 598       "isPrivate" : false,
 599       "memberOf" : "Roo.util.Observable",
 600       "example" : "",
 601       "deprecated" : "",
 602       "since" : "",
 603       "see" : "",
 604       "params" : [
 605         {
 606           "name" : "eventName",
 607           "type" : "String",
 608           "desc" : "The type of event to listen for",
 609           "isOptional" : false
 610         },
 611         {
 612           "name" : "handler",
 613           "type" : "Function",
 614           "desc" : "The handler to remove",
 615           "isOptional" : false
 616         },
 617         {
 618           "name" : "scope",
 619           "type" : "Object",
 620           "desc" : "(optional) The scope (this object) for the handler",
 621           "isOptional" : false
 622         }
 623       ],
 624       "returns" : [
 625       ]
 626     },
 627     {
 628       "name" : "fireEvent",
 629       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 630       "isStatic" : false,
 631       "isConstructor" : false,
 632       "isPrivate" : false,
 633       "memberOf" : "Roo.util.Observable",
 634       "example" : "",
 635       "deprecated" : "",
 636       "since" : "",
 637       "see" : "",
 638       "params" : [
 639         {
 640           "name" : "eventName",
 641           "type" : "String",
 642           "desc" : "",
 643           "isOptional" : false
 644         },
 645         {
 646           "name" : "args",
 647           "type" : "Object...",
 648           "desc" : "Variable number of parameters are passed to handlers",
 649           "isOptional" : false
 650         }
 651       ],
 652       "returns" : [
 653         {
 654           "name" : "",
 655           "type" : "Boolean",
 656           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 657         }
 658       ]
 659     },
 660     {
 661       "name" : "hasListener",
 662       "desc" : "Checks to see if this object has any listeners for a specified event",
 663       "isStatic" : false,
 664       "isConstructor" : false,
 665       "isPrivate" : false,
 666       "memberOf" : "Roo.util.Observable",
 667       "example" : "",
 668       "deprecated" : "",
 669       "since" : "",
 670       "see" : "",
 671       "params" : [
 672         {
 673           "name" : "eventName",
 674           "type" : "String",
 675           "desc" : "The name of the event to check for",
 676           "isOptional" : false
 677         }
 678       ],
 679       "returns" : [
 680         {
 681           "name" : "",
 682           "type" : "Boolean",
 683           "desc" : "True if the event is being listened for, else false"
 684         }
 685       ]
 686     },
 687     {
 688       "name" : "capture",
 689       "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.",
 690       "isStatic" : true,
 691       "isConstructor" : false,
 692       "isPrivate" : false,
 693       "memberOf" : "Roo.util.Observable",
 694       "example" : "",
 695       "deprecated" : "",
 696       "since" : "",
 697       "see" : "",
 698       "params" : [
 699         {
 700           "name" : "o",
 701           "type" : "Observable",
 702           "desc" : "The Observable to capture",
 703           "isOptional" : false
 704         },
 705         {
 706           "name" : "fn",
 707           "type" : "Function",
 708           "desc" : "The function to call",
 709           "isOptional" : false
 710         },
 711         {
 712           "name" : "scope",
 713           "type" : "Object",
 714           "desc" : "(optional) The scope (this object) for the fn",
 715           "isOptional" : false
 716         }
 717       ],
 718       "returns" : [
 719       ]
 720     },
 721     {
 722       "name" : "addListener",
 723       "desc" : "Appends an event handler to this component",
 724       "isStatic" : false,
 725       "isConstructor" : false,
 726       "isPrivate" : false,
 727       "memberOf" : "Roo.util.Observable",
 728       "example" : "",
 729       "deprecated" : "",
 730       "since" : "",
 731       "see" : "",
 732       "params" : [
 733         {
 734           "name" : "eventName",
 735           "type" : "String",
 736           "desc" : "The type of event to listen for",
 737           "isOptional" : false
 738         },
 739         {
 740           "name" : "handler",
 741           "type" : "Function",
 742           "desc" : "The method the event invokes",
 743           "isOptional" : false
 744         },
 745         {
 746           "name" : "scope",
 747           "type" : "Object",
 748           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 749           "isOptional" : false
 750         },
 751         {
 752           "name" : "options",
 753           "type" : "Object",
 754           "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>",
 755           "isOptional" : false
 756         }
 757       ],
 758       "returns" : [
 759       ]
 760     }
 761   ],
 762   "events" : [
 763     {
 764       "name" : "rowcontextmenu",
 765       "desc" : "Fires when a row is right clicked",
 766       "memberOf" : "Roo.grid.Grid",
 767       "example" : "",
 768       "deprecated" : "",
 769       "since" : "",
 770       "see" : "",
 771       "params" : [
 772         {
 773           "name" : "this",
 774           "type" : "Grid",
 775           "desc" : "",
 776           "isOptional" : false
 777         },
 778         {
 779           "name" : "rowIndex",
 780           "type" : "Number",
 781           "desc" : "",
 782           "isOptional" : false
 783         },
 784         {
 785           "name" : "e",
 786           "type" : "Roo.EventObject",
 787           "desc" : "",
 788           "isOptional" : false
 789         }
 790       ],
 791       "returns" : [
 792       ]
 793     },
 794     {
 795       "name" : "columnmove",
 796       "desc" : "Fires when the user moves a column",
 797       "memberOf" : "Roo.grid.Grid",
 798       "example" : "",
 799       "deprecated" : "",
 800       "since" : "",
 801       "see" : "",
 802       "params" : [
 803         {
 804           "name" : "oldIndex",
 805           "type" : "Number",
 806           "desc" : "",
 807           "isOptional" : false
 808         },
 809         {
 810           "name" : "newIndex",
 811           "type" : "Number",
 812           "desc" : "",
 813           "isOptional" : false
 814         }
 815       ],
 816       "returns" : [
 817       ]
 818     },
 819     {
 820       "name" : "headercontextmenu",
 821       "desc" : "Fires when a header is right clicked",
 822       "memberOf" : "Roo.grid.Grid",
 823       "example" : "",
 824       "deprecated" : "",
 825       "since" : "",
 826       "see" : "",
 827       "params" : [
 828         {
 829           "name" : "this",
 830           "type" : "Grid",
 831           "desc" : "",
 832           "isOptional" : false
 833         },
 834         {
 835           "name" : "columnIndex",
 836           "type" : "Number",
 837           "desc" : "",
 838           "isOptional" : false
 839         },
 840         {
 841           "name" : "e",
 842           "type" : "Roo.EventObject",
 843           "desc" : "",
 844           "isOptional" : false
 845         }
 846       ],
 847       "returns" : [
 848       ]
 849     },
 850     {
 851       "name" : "render",
 852       "desc" : "Fires when the grid is rendered",
 853       "memberOf" : "Roo.grid.Grid",
 854       "example" : "",
 855       "deprecated" : "",
 856       "since" : "",
 857       "see" : "",
 858       "params" : [
 859         {
 860           "name" : "grid",
 861           "type" : "Grid",
 862           "desc" : "",
 863           "isOptional" : false
 864         }
 865       ],
 866       "returns" : [
 867       ]
 868     },
 869     {
 870       "name" : "bodyscroll",
 871       "desc" : "Fires when the body element is scrolled",
 872       "memberOf" : "Roo.grid.Grid",
 873       "example" : "",
 874       "deprecated" : "",
 875       "since" : "",
 876       "see" : "",
 877       "params" : [
 878         {
 879           "name" : "scrollLeft",
 880           "type" : "Number",
 881           "desc" : "",
 882           "isOptional" : false
 883         },
 884         {
 885           "name" : "scrollTop",
 886           "type" : "Number",
 887           "desc" : "",
 888           "isOptional" : false
 889         }
 890       ],
 891       "returns" : [
 892       ]
 893     },
 894     {
 895       "name" : "columnresize",
 896       "desc" : "Fires when the user resizes a column",
 897       "memberOf" : "Roo.grid.Grid",
 898       "example" : "",
 899       "deprecated" : "",
 900       "since" : "",
 901       "see" : "",
 902       "params" : [
 903         {
 904           "name" : "columnIndex",
 905           "type" : "Number",
 906           "desc" : "",
 907           "isOptional" : false
 908         },
 909         {
 910           "name" : "newSize",
 911           "type" : "Number",
 912           "desc" : "",
 913           "isOptional" : false
 914         }
 915       ],
 916       "returns" : [
 917       ]
 918     },
 919     {
 920       "name" : "enddrag",
 921       "desc" : "Fires when a drag operation is complete",
 922       "memberOf" : "Roo.grid.Grid",
 923       "example" : "",
 924       "deprecated" : "",
 925       "since" : "",
 926       "see" : "",
 927       "params" : [
 928         {
 929           "name" : "this",
 930           "type" : "Grid",
 931           "desc" : "",
 932           "isOptional" : false
 933         },
 934         {
 935           "name" : "dd",
 936           "type" : "Roo.GridDD",
 937           "desc" : "The drag drop object",
 938           "isOptional" : false
 939         },
 940         {
 941           "name" : "e",
 942           "type" : "event",
 943           "desc" : "The raw browser event",
 944           "isOptional" : false
 945         }
 946       ],
 947       "returns" : [
 948       ]
 949     },
 950     {
 951       "name" : "mouseout",
 952       "desc" : "The raw mouseout event for the entire grid.",
 953       "memberOf" : "Roo.grid.Grid",
 954       "example" : "",
 955       "deprecated" : "",
 956       "since" : "",
 957       "see" : "",
 958       "params" : [
 959         {
 960           "name" : "e",
 961           "type" : "Roo.EventObject",
 962           "desc" : "",
 963           "isOptional" : false
 964         }
 965       ],
 966       "returns" : [
 967       ]
 968     },
 969     {
 970       "name" : "cellclick",
 971       "desc" : "Fires when a cell is clicked",
 972       "memberOf" : "Roo.grid.Grid",
 973       "example" : "",
 974       "deprecated" : "",
 975       "since" : "",
 976       "see" : "",
 977       "params" : [
 978         {
 979           "name" : "this",
 980           "type" : "Grid",
 981           "desc" : "",
 982           "isOptional" : false
 983         },
 984         {
 985           "name" : "rowIndex",
 986           "type" : "Number",
 987           "desc" : "",
 988           "isOptional" : false
 989         },
 990         {
 991           "name" : "columnIndex",
 992           "type" : "Number",
 993           "desc" : "",
 994           "isOptional" : false
 995         },
 996         {
 997           "name" : "e",
 998           "type" : "Roo.EventObject",
 999           "desc" : "",
1000           "isOptional" : false
1001         }
1002       ],
1003       "returns" : [
1004       ]
1005     },
1006     {
1007       "name" : "dragover",
1008       "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
1009       "memberOf" : "Roo.grid.Grid",
1010       "example" : "",
1011       "deprecated" : "",
1012       "since" : "",
1013       "see" : "",
1014       "params" : [
1015         {
1016           "name" : "this",
1017           "type" : "Grid",
1018           "desc" : "",
1019           "isOptional" : false
1020         },
1021         {
1022           "name" : "dd",
1023           "type" : "Roo.GridDD",
1024           "desc" : "The drag drop object",
1025           "isOptional" : false
1026         },
1027         {
1028           "name" : "targetId",
1029           "type" : "String",
1030           "desc" : "The target drag drop object",
1031           "isOptional" : false
1032         },
1033         {
1034           "name" : "e",
1035           "type" : "event",
1036           "desc" : "The raw browser event",
1037           "isOptional" : false
1038         }
1039       ],
1040       "returns" : [
1041       ]
1042     },
1043     {
1044       "name" : "rowclass",
1045       "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1046       "memberOf" : "Roo.grid.Grid",
1047       "example" : "",
1048       "deprecated" : "",
1049       "since" : "",
1050       "see" : "",
1051       "params" : [
1052         {
1053           "name" : "gridview",
1054           "type" : "GridView",
1055           "desc" : "The grid view",
1056           "isOptional" : false
1057         },
1058         {
1059           "name" : "rowcfg",
1060           "type" : "Object",
1061           "desc" : "contains record  rowIndex and rowClass - set rowClass to add a style.",
1062           "isOptional" : false
1063         }
1064       ],
1065       "returns" : [
1066       ]
1067     },
1068     {
1069       "name" : "keydown",
1070       "desc" : "The raw keydown event for the entire grid.",
1071       "memberOf" : "Roo.grid.Grid",
1072       "example" : "",
1073       "deprecated" : "",
1074       "since" : "",
1075       "see" : "",
1076       "params" : [
1077         {
1078           "name" : "e",
1079           "type" : "Roo.EventObject",
1080           "desc" : "",
1081           "isOptional" : false
1082         }
1083       ],
1084       "returns" : [
1085       ]
1086     },
1087     {
1088       "name" : "mousedown",
1089       "desc" : "The raw mousedown event for the entire grid.",
1090       "memberOf" : "Roo.grid.Grid",
1091       "example" : "",
1092       "deprecated" : "",
1093       "since" : "",
1094       "see" : "",
1095       "params" : [
1096         {
1097           "name" : "e",
1098           "type" : "Roo.EventObject",
1099           "desc" : "",
1100           "isOptional" : false
1101         }
1102       ],
1103       "returns" : [
1104       ]
1105     },
1106     {
1107       "name" : "dragenter",
1108       "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
1109       "memberOf" : "Roo.grid.Grid",
1110       "example" : "",
1111       "deprecated" : "",
1112       "since" : "",
1113       "see" : "",
1114       "params" : [
1115         {
1116           "name" : "this",
1117           "type" : "Grid",
1118           "desc" : "",
1119           "isOptional" : false
1120         },
1121         {
1122           "name" : "dd",
1123           "type" : "Roo.GridDD",
1124           "desc" : "The drag drop object",
1125           "isOptional" : false
1126         },
1127         {
1128           "name" : "targetId",
1129           "type" : "String",
1130           "desc" : "The target drag drop object",
1131           "isOptional" : false
1132         },
1133         {
1134           "name" : "e",
1135           "type" : "event",
1136           "desc" : "The raw browser event",
1137           "isOptional" : false
1138         }
1139       ],
1140       "returns" : [
1141       ]
1142     },
1143     {
1144       "name" : "dragout",
1145       "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
1146       "memberOf" : "Roo.grid.Grid",
1147       "example" : "",
1148       "deprecated" : "",
1149       "since" : "",
1150       "see" : "",
1151       "params" : [
1152         {
1153           "name" : "this",
1154           "type" : "Grid",
1155           "desc" : "",
1156           "isOptional" : false
1157         },
1158         {
1159           "name" : "dd",
1160           "type" : "Roo.GridDD",
1161           "desc" : "The drag drop object",
1162           "isOptional" : false
1163         },
1164         {
1165           "name" : "targetId",
1166           "type" : "String",
1167           "desc" : "The target drag drop object",
1168           "isOptional" : false
1169         },
1170         {
1171           "name" : "e",
1172           "type" : "event",
1173           "desc" : "The raw browser event",
1174           "isOptional" : false
1175         }
1176       ],
1177       "returns" : [
1178       ]
1179     },
1180     {
1181       "name" : "mouseup",
1182       "desc" : "The raw mouseup event for the entire grid.",
1183       "memberOf" : "Roo.grid.Grid",
1184       "example" : "",
1185       "deprecated" : "",
1186       "since" : "",
1187       "see" : "",
1188       "params" : [
1189         {
1190           "name" : "e",
1191           "type" : "Roo.EventObject",
1192           "desc" : "",
1193           "isOptional" : false
1194         }
1195       ],
1196       "returns" : [
1197       ]
1198     },
1199     {
1200       "name" : "keypress",
1201       "desc" : "The raw keypress event for the entire grid.",
1202       "memberOf" : "Roo.grid.Grid",
1203       "example" : "",
1204       "deprecated" : "",
1205       "since" : "",
1206       "see" : "",
1207       "params" : [
1208         {
1209           "name" : "e",
1210           "type" : "Roo.EventObject",
1211           "desc" : "",
1212           "isOptional" : false
1213         }
1214       ],
1215       "returns" : [
1216       ]
1217     },
1218     {
1219       "name" : "headerclick",
1220       "desc" : "Fires when a header is clicked",
1221       "memberOf" : "Roo.grid.Grid",
1222       "example" : "",
1223       "deprecated" : "",
1224       "since" : "",
1225       "see" : "",
1226       "params" : [
1227         {
1228           "name" : "this",
1229           "type" : "Grid",
1230           "desc" : "",
1231           "isOptional" : false
1232         },
1233         {
1234           "name" : "columnIndex",
1235           "type" : "Number",
1236           "desc" : "",
1237           "isOptional" : false
1238         },
1239         {
1240           "name" : "e",
1241           "type" : "Roo.EventObject",
1242           "desc" : "",
1243           "isOptional" : false
1244         }
1245       ],
1246       "returns" : [
1247       ]
1248     },
1249     {
1250       "name" : "mouseover",
1251       "desc" : "The raw mouseover event for the entire grid.",
1252       "memberOf" : "Roo.grid.Grid",
1253       "example" : "",
1254       "deprecated" : "",
1255       "since" : "",
1256       "see" : "",
1257       "params" : [
1258         {
1259           "name" : "e",
1260           "type" : "Roo.EventObject",
1261           "desc" : "",
1262           "isOptional" : false
1263         }
1264       ],
1265       "returns" : [
1266       ]
1267     },
1268     {
1269       "name" : "headerdblclick",
1270       "desc" : "Fires when a header cell is double clicked",
1271       "memberOf" : "Roo.grid.Grid",
1272       "example" : "",
1273       "deprecated" : "",
1274       "since" : "",
1275       "see" : "",
1276       "params" : [
1277         {
1278           "name" : "this",
1279           "type" : "Grid",
1280           "desc" : "",
1281           "isOptional" : false
1282         },
1283         {
1284           "name" : "columnIndex",
1285           "type" : "Number",
1286           "desc" : "",
1287           "isOptional" : false
1288         },
1289         {
1290           "name" : "e",
1291           "type" : "Roo.EventObject",
1292           "desc" : "",
1293           "isOptional" : false
1294         }
1295       ],
1296       "returns" : [
1297       ]
1298     },
1299     {
1300       "name" : "dragdrop",
1301       "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
1302       "memberOf" : "Roo.grid.Grid",
1303       "example" : "",
1304       "deprecated" : "",
1305       "since" : "",
1306       "see" : "",
1307       "params" : [
1308         {
1309           "name" : "this",
1310           "type" : "Grid",
1311           "desc" : "",
1312           "isOptional" : false
1313         },
1314         {
1315           "name" : "dd",
1316           "type" : "Roo.GridDD",
1317           "desc" : "The drag drop object",
1318           "isOptional" : false
1319         },
1320         {
1321           "name" : "targetId",
1322           "type" : "String",
1323           "desc" : "The target drag drop object",
1324           "isOptional" : false
1325         },
1326         {
1327           "name" : "e",
1328           "type" : "event",
1329           "desc" : "The raw browser event",
1330           "isOptional" : false
1331         }
1332       ],
1333       "returns" : [
1334       ]
1335     },
1336     {
1337       "name" : "rowclick",
1338       "desc" : "Fires when a row is clicked",
1339       "memberOf" : "Roo.grid.Grid",
1340       "example" : "",
1341       "deprecated" : "",
1342       "since" : "",
1343       "see" : "",
1344       "params" : [
1345         {
1346           "name" : "this",
1347           "type" : "Grid",
1348           "desc" : "",
1349           "isOptional" : false
1350         },
1351         {
1352           "name" : "rowIndex",
1353           "type" : "Number",
1354           "desc" : "",
1355           "isOptional" : false
1356         },
1357         {
1358           "name" : "e",
1359           "type" : "Roo.EventObject",
1360           "desc" : "",
1361           "isOptional" : false
1362         }
1363       ],
1364       "returns" : [
1365       ]
1366     },
1367     {
1368       "name" : "click",
1369       "desc" : "The raw click event for the entire grid.",
1370       "memberOf" : "Roo.grid.Grid",
1371       "example" : "",
1372       "deprecated" : "",
1373       "since" : "",
1374       "see" : "",
1375       "params" : [
1376         {
1377           "name" : "e",
1378           "type" : "Roo.EventObject",
1379           "desc" : "",
1380           "isOptional" : false
1381         }
1382       ],
1383       "returns" : [
1384       ]
1385     },
1386     {
1387       "name" : "rowdblclick",
1388       "desc" : "Fires when a row is double clicked",
1389       "memberOf" : "Roo.grid.Grid",
1390       "example" : "",
1391       "deprecated" : "",
1392       "since" : "",
1393       "see" : "",
1394       "params" : [
1395         {
1396           "name" : "this",
1397           "type" : "Grid",
1398           "desc" : "",
1399           "isOptional" : false
1400         },
1401         {
1402           "name" : "rowIndex",
1403           "type" : "Number",
1404           "desc" : "",
1405           "isOptional" : false
1406         },
1407         {
1408           "name" : "e",
1409           "type" : "Roo.EventObject",
1410           "desc" : "",
1411           "isOptional" : false
1412         }
1413       ],
1414       "returns" : [
1415       ]
1416     },
1417     {
1418       "name" : "startdrag",
1419       "desc" : "Fires when row(s) start being dragged",
1420       "memberOf" : "Roo.grid.Grid",
1421       "example" : "",
1422       "deprecated" : "",
1423       "since" : "",
1424       "see" : "",
1425       "params" : [
1426         {
1427           "name" : "this",
1428           "type" : "Grid",
1429           "desc" : "",
1430           "isOptional" : false
1431         },
1432         {
1433           "name" : "dd",
1434           "type" : "Roo.GridDD",
1435           "desc" : "The drag drop object",
1436           "isOptional" : false
1437         },
1438         {
1439           "name" : "e",
1440           "type" : "event",
1441           "desc" : "The raw browser event",
1442           "isOptional" : false
1443         }
1444       ],
1445       "returns" : [
1446       ]
1447     },
1448     {
1449       "name" : "dblclick",
1450       "desc" : "The raw dblclick event for the entire grid.",
1451       "memberOf" : "Roo.grid.Grid",
1452       "example" : "",
1453       "deprecated" : "",
1454       "since" : "",
1455       "see" : "",
1456       "params" : [
1457         {
1458           "name" : "e",
1459           "type" : "Roo.EventObject",
1460           "desc" : "",
1461           "isOptional" : false
1462         }
1463       ],
1464       "returns" : [
1465       ]
1466     },
1467     {
1468       "name" : "cellcontextmenu",
1469       "desc" : "Fires when a cell is right clicked",
1470       "memberOf" : "Roo.grid.Grid",
1471       "example" : "",
1472       "deprecated" : "",
1473       "since" : "",
1474       "see" : "",
1475       "params" : [
1476         {
1477           "name" : "this",
1478           "type" : "Grid",
1479           "desc" : "",
1480           "isOptional" : false
1481         },
1482         {
1483           "name" : "rowIndex",
1484           "type" : "Number",
1485           "desc" : "",
1486           "isOptional" : false
1487         },
1488         {
1489           "name" : "cellIndex",
1490           "type" : "Number",
1491           "desc" : "",
1492           "isOptional" : false
1493         },
1494         {
1495           "name" : "e",
1496           "type" : "Roo.EventObject",
1497           "desc" : "",
1498           "isOptional" : false
1499         }
1500       ],
1501       "returns" : [
1502       ]
1503     },
1504     {
1505       "name" : "contextmenu",
1506       "desc" : "The raw contextmenu event for the entire grid.",
1507       "memberOf" : "Roo.grid.Grid",
1508       "example" : "",
1509       "deprecated" : "",
1510       "since" : "",
1511       "see" : "",
1512       "params" : [
1513         {
1514           "name" : "e",
1515           "type" : "Roo.EventObject",
1516           "desc" : "",
1517           "isOptional" : false
1518         }
1519       ],
1520       "returns" : [
1521       ]
1522     },
1523     {
1524       "name" : "celldblclick",
1525       "desc" : "Fires when a cell is double clicked",
1526       "memberOf" : "Roo.grid.Grid",
1527       "example" : "",
1528       "deprecated" : "",
1529       "since" : "",
1530       "see" : "",
1531       "params" : [
1532         {
1533           "name" : "this",
1534           "type" : "Grid",
1535           "desc" : "",
1536           "isOptional" : false
1537         },
1538         {
1539           "name" : "rowIndex",
1540           "type" : "Number",
1541           "desc" : "",
1542           "isOptional" : false
1543         },
1544         {
1545           "name" : "columnIndex",
1546           "type" : "Number",
1547           "desc" : "",
1548           "isOptional" : false
1549         },
1550         {
1551           "name" : "e",
1552           "type" : "Roo.EventObject",
1553           "desc" : "",
1554           "isOptional" : false
1555         }
1556       ],
1557       "returns" : [
1558       ]
1559     }
1560   ]
1561 }