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