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