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

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