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