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

   1 {
   2   "name" : "Roo.grid.PropertyGrid",
   3   "augments" : [
   4     "Roo.grid.EditorGrid",
   5     "Roo.grid.Grid",
   6     "Roo.util.Observable"
   7   ],
   8   "childClasses" : {  },
   9   "tree_children" : [],
  10   "tree_parent" : [],
  11   "desc" : "This class represents the  interface of a component based property grid control.\n<br><br>Usage:<pre><code>\n var grid = new Roo.grid.PropertyGrid(\"my-container-id\", {\n      \n });\n // set any options\n grid.render();\n</code></pre>",
  12   "isSingleton" : false,
  13   "isStatic" : false,
  14   "isBuiltin" : false,
  15   "isAbstract" : false,
  16   "isBuilderTop" : false,
  17   "memberOf" : "PropertyGrid",
  18   "example" : "",
  19   "deprecated" : "",
  20   "since" : "",
  21   "see" : "",
  22   "params" : [
  23     {
  24       "name" : "container",
  25       "type" : "String/HTMLElement/Roo.Element",
  26       "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.",
  27       "isOptional" : false
  28     },
  29     {
  30       "name" : "config",
  31       "type" : "Object",
  32       "desc" : "A config object that sets properties on this grid.",
  33       "isOptional" : false
  34     }
  35   ],
  36   "returns" : [],
  37   "throws" : "",
  38   "requires" : "",
  39   "config" : [
  40     {
  41       "name" : "trackMouseOver",
  42       "type" : "Boolean",
  43       "desc" : "True to highlight rows when the mouse is over. Default is true.",
  44       "memberOf" : "Roo.grid.Grid",
  45       "isOptional" : false,
  46       "optvalues" : []
  47     },
  48     {
  49       "name" : "ddText",
  50       "type" : "String",
  51       "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
  52       "memberOf" : "Roo.grid.Grid",
  53       "isOptional" : false,
  54       "optvalues" : []
  55     },
  56     {
  57       "name" : "propertyNames",
  58       "type" : "Object",
  59       "desc" : "map of property Names to their displayed value",
  60       "memberOf" : "",
  61       "isOptional" : false,
  62       "optvalues" : []
  63     },
  64     {
  65       "name" : "autoExpandMax",
  66       "type" : "Number",
  67       "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
  68       "memberOf" : "Roo.grid.Grid",
  69       "isOptional" : false,
  70       "optvalues" : []
  71     },
  72     {
  73       "name" : "cm[]",
  74       "type" : "Roo.grid.ColumnModel",
  75       "desc" : "The columns of the grid",
  76       "memberOf" : "Roo.grid.Grid",
  77       "isOptional" : false,
  78       "optvalues" : []
  79     },
  80     {
  81       "name" : "view",
  82       "type" : "Roo.grid.GridView",
  83       "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
  84       "memberOf" : "Roo.grid.Grid",
  85       "isOptional" : false,
  86       "optvalues" : []
  87     },
  88     {
  89       "name" : "stripeRows",
  90       "type" : "Boolean",
  91       "desc" : "True to stripe the rows.  Default is true.",
  92       "memberOf" : "Roo.grid.Grid",
  93       "isOptional" : false,
  94       "optvalues" : []
  95     },
  96     {
  97       "name" : "minColumnWidth",
  98       "type" : "Number",
  99       "desc" : "The minimum width a column can be resized to. Default is 25.",
 100       "memberOf" : "Roo.grid.Grid",
 101       "isOptional" : false,
 102       "optvalues" : []
 103     },
 104     {
 105       "name" : "monitorWindowResize",
 106       "type" : "Boolean",
 107       "desc" : "True to autoSize the grid when the window resizes. Default is true.",
 108       "memberOf" : "Roo.grid.Grid",
 109       "isOptional" : false,
 110       "optvalues" : []
 111     },
 112     {
 113       "name" : "enableRowHeightSync",
 114       "type" : "Boolean",
 115       "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
 116       "memberOf" : "Roo.grid.Grid",
 117       "isOptional" : false,
 118       "optvalues" : []
 119     },
 120     {
 121       "name" : "ds",
 122       "type" : "Roo.data.Store",
 123       "desc" : "The data store for the grid",
 124       "memberOf" : "Roo.grid.Grid",
 125       "isOptional" : false,
 126       "optvalues" : []
 127     },
 128     {
 129       "name" : "autoSizeHeaders",
 130       "type" : "Boolean",
 131       "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
 132       "memberOf" : "Roo.grid.Grid",
 133       "isOptional" : false,
 134       "optvalues" : []
 135     },
 136     {
 137       "name" : "toolbar",
 138       "type" : "Roo.Toolbar",
 139       "desc" : "a toolbar for buttons etc.",
 140       "memberOf" : "Roo.grid.Grid",
 141       "isOptional" : false,
 142       "optvalues" : []
 143     },
 144     {
 145       "name" : "sm",
 146       "type" : "Roo.grid.AbstractSelectionModel",
 147       "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
 148       "memberOf" : "Roo.grid.Grid",
 149       "isOptional" : false,
 150       "optvalues" : []
 151     },
 152     {
 153       "name" : "listeners",
 154       "type" : "Object",
 155       "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>",
 156       "memberOf" : "Roo.util.Observable",
 157       "isOptional" : false,
 158       "optvalues" : []
 159     },
 160     {
 161       "name" : "enableColumnHide",
 162       "type" : "Boolean",
 163       "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
 164       "memberOf" : "Roo.grid.Grid",
 165       "isOptional" : false,
 166       "optvalues" : []
 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       "isOptional" : false,
 174       "optvalues" : []
 175     },
 176     {
 177       "name" : "dragGroup",
 178       "type" : "String",
 179       "desc" : "- drag group (?? not sure if needed.)",
 180       "memberOf" : "Roo.grid.Grid",
 181       "isOptional" : false,
 182       "optvalues" : []
 183     },
 184     {
 185       "name" : "ddGroup",
 186       "type" : "String",
 187       "desc" : "- drag drop group.",
 188       "memberOf" : "Roo.grid.Grid",
 189       "isOptional" : false,
 190       "optvalues" : []
 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       "isOptional" : false,
 198       "optvalues" : []
 199     },
 200     {
 201       "name" : "enableDrop",
 202       "type" : "Boolean",
 203       "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
 204       "memberOf" : "Roo.grid.Grid",
 205       "isOptional" : false,
 206       "optvalues" : []
 207     },
 208     {
 209       "name" : "sortColMenu",
 210       "type" : "boolean",
 211       "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
 212       "memberOf" : "Roo.grid.Grid",
 213       "isOptional" : false,
 214       "optvalues" : []
 215     },
 216     {
 217       "name" : "clicksToEdit",
 218       "type" : "Number",
 219       "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
 220       "memberOf" : "Roo.grid.EditorGrid",
 221       "isOptional" : false,
 222       "optvalues" : []
 223     },
 224     {
 225       "name" : "autoExpandColumn",
 226       "type" : "String",
 227       "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.",
 228       "memberOf" : "Roo.grid.Grid",
 229       "isOptional" : false,
 230       "optvalues" : []
 231     },
 232     {
 233       "name" : "maxRowsToMeasure",
 234       "type" : "Boolean",
 235       "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).",
 236       "memberOf" : "Roo.grid.Grid",
 237       "isOptional" : false,
 238       "optvalues" : []
 239     },
 240     {
 241       "name" : "loadMask",
 242       "type" : "Object",
 243       "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
 244       "memberOf" : "Roo.grid.Grid",
 245       "isOptional" : false,
 246       "optvalues" : []
 247     },
 248     {
 249       "name" : "customEditors",
 250       "type" : "Object",
 251       "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
 252       "memberOf" : "",
 253       "isOptional" : false,
 254       "optvalues" : []
 255     },
 256     {
 257       "name" : "autoHeight",
 258       "type" : "Boolean",
 259       "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
 260       "memberOf" : "Roo.grid.Grid",
 261       "isOptional" : false,
 262       "optvalues" : []
 263     },
 264     {
 265       "name" : "autoSizeColumns",
 266       "type" : "Boolean",
 267       "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.",
 268       "memberOf" : "Roo.grid.Grid",
 269       "isOptional" : false,
 270       "optvalues" : []
 271     },
 272     {
 273       "name" : "enableDrag",
 274       "type" : "Boolean",
 275       "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
 276       "memberOf" : "Roo.grid.Grid",
 277       "isOptional" : false,
 278       "optvalues" : []
 279     },
 280     {
 281       "name" : "dropTarget",
 282       "type" : "Roo.dd.DropTarget",
 283       "desc" : "An {@link Roo.dd.DropTarget} config",
 284       "memberOf" : "Roo.grid.Grid",
 285       "isOptional" : false,
 286       "optvalues" : []
 287     },
 288     {
 289       "name" : "autoWidth",
 290       "type" : "Boolean",
 291       "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.",
 292       "memberOf" : "Roo.grid.Grid",
 293       "isOptional" : false,
 294       "optvalues" : []
 295     },
 296     {
 297       "name" : "maxHeight",
 298       "type" : "Number",
 299       "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
 300       "memberOf" : "Roo.grid.Grid",
 301       "isOptional" : false,
 302       "optvalues" : []
 303     },
 304     {
 305       "name" : "autoExpandMin",
 306       "type" : "Number",
 307       "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
 308       "memberOf" : "Roo.grid.Grid",
 309       "isOptional" : false,
 310       "optvalues" : []
 311     }
 312   ],
 313   "methods" : [
 314     {
 315       "name" : "getSource",
 316       "type" : "function",
 317       "desc" : "Gets all the data from the grid.",
 318       "sig" : "()\n{\n\n}",
 319       "static" : false,
 320       "memberOf" : "",
 321       "isStatic" : false,
 322       "isConstructor" : false,
 323       "isPrivate" : false,
 324       "example" : "",
 325       "deprecated" : "",
 326       "since" : "",
 327       "see" : "",
 328       "exceptions" : "",
 329       "requires" : "",
 330       "params" : [],
 331       "returns" : [
 332         {
 333           "name" : "",
 334           "type" : "Object",
 335           "desc" : "data  data stored in grid"
 336         }
 337       ]
 338     },
 339     {
 340       "name" : "setSource",
 341       "type" : "function",
 342       "desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.",
 343       "sig" : "(data)",
 344       "static" : false,
 345       "memberOf" : "",
 346       "isStatic" : false,
 347       "isConstructor" : false,
 348       "isPrivate" : false,
 349       "example" : "",
 350       "deprecated" : "",
 351       "since" : "",
 352       "see" : "",
 353       "exceptions" : "",
 354       "requires" : "",
 355       "params" : [
 356         {
 357           "name" : "data",
 358           "type" : "Object",
 359           "desc" : "to appear in grid.",
 360           "isOptional" : false
 361         }
 362       ],
 363       "returns" : []
 364     },
 365     {
 366       "name" : "stopEditing",
 367       "type" : "function",
 368       "desc" : "Stops any active editing",
 369       "sig" : "()\n{\n\n}",
 370       "static" : false,
 371       "memberOf" : "Roo.grid.EditorGrid",
 372       "isStatic" : false,
 373       "isConstructor" : false,
 374       "isPrivate" : false,
 375       "example" : "",
 376       "deprecated" : "",
 377       "since" : "",
 378       "see" : "",
 379       "exceptions" : "",
 380       "requires" : "",
 381       "params" : [],
 382       "returns" : []
 383     },
 384     {
 385       "name" : "getDragDropText",
 386       "type" : "function",
 387       "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
 388       "sig" : "()\n{\n\n}",
 389       "static" : false,
 390       "memberOf" : "Roo.grid.EditorGrid",
 391       "isStatic" : false,
 392       "isConstructor" : false,
 393       "isPrivate" : false,
 394       "example" : "",
 395       "deprecated" : "",
 396       "since" : "",
 397       "see" : "",
 398       "exceptions" : "",
 399       "requires" : "",
 400       "params" : [],
 401       "returns" : [
 402         {
 403           "name" : "",
 404           "type" : "String",
 405           "desc" : ""
 406         }
 407       ]
 408     },
 409     {
 410       "name" : "startEditing",
 411       "type" : "function",
 412       "desc" : "Starts editing the specified for the specified row/column",
 413       "sig" : "(rowIndex, colIndex)",
 414       "static" : false,
 415       "memberOf" : "Roo.grid.EditorGrid",
 416       "isStatic" : false,
 417       "isConstructor" : false,
 418       "isPrivate" : false,
 419       "example" : "",
 420       "deprecated" : "",
 421       "since" : "",
 422       "see" : "",
 423       "exceptions" : "",
 424       "requires" : "",
 425       "params" : [
 426         {
 427           "name" : "rowIndex",
 428           "type" : "Number",
 429           "desc" : "",
 430           "isOptional" : false
 431         },
 432         {
 433           "name" : "colIndex",
 434           "type" : "Number",
 435           "desc" : "",
 436           "isOptional" : false
 437         }
 438       ],
 439       "returns" : []
 440     },
 441     {
 442       "name" : "getSelectionModel",
 443       "type" : "function",
 444       "desc" : "Returns the grid's SelectionModel.",
 445       "sig" : "()\n{\n\n}",
 446       "static" : false,
 447       "memberOf" : "Roo.grid.Grid",
 448       "isStatic" : false,
 449       "isConstructor" : false,
 450       "isPrivate" : false,
 451       "example" : "",
 452       "deprecated" : "",
 453       "since" : "",
 454       "see" : "",
 455       "exceptions" : "",
 456       "requires" : "",
 457       "params" : [],
 458       "returns" : [
 459         {
 460           "name" : "",
 461           "type" : "SelectionModel",
 462           "desc" : ""
 463         }
 464       ]
 465     },
 466     {
 467       "name" : "destroy",
 468       "type" : "function",
 469       "desc" : "Destroy this grid.",
 470       "sig" : "(removeEl)",
 471       "static" : false,
 472       "memberOf" : "Roo.grid.Grid",
 473       "isStatic" : false,
 474       "isConstructor" : false,
 475       "isPrivate" : false,
 476       "example" : "",
 477       "deprecated" : "",
 478       "since" : "",
 479       "see" : "",
 480       "exceptions" : "",
 481       "requires" : "",
 482       "params" : [
 483         {
 484           "name" : "removeEl",
 485           "type" : "Boolean",
 486           "desc" : "True to remove the element",
 487           "isOptional" : false
 488         }
 489       ],
 490       "returns" : []
 491     },
 492     {
 493       "name" : "getColumnModel",
 494       "type" : "function",
 495       "desc" : "Returns the grid's ColumnModel.",
 496       "sig" : "()\n{\n\n}",
 497       "static" : false,
 498       "memberOf" : "Roo.grid.Grid",
 499       "isStatic" : false,
 500       "isConstructor" : false,
 501       "isPrivate" : false,
 502       "example" : "",
 503       "deprecated" : "",
 504       "since" : "",
 505       "see" : "",
 506       "exceptions" : "",
 507       "requires" : "",
 508       "params" : [],
 509       "returns" : [
 510         {
 511           "name" : "",
 512           "type" : "ColumnModel",
 513           "desc" : ""
 514         }
 515       ]
 516     },
 517     {
 518       "name" : "getGridEl",
 519       "type" : "function",
 520       "desc" : "Returns the grid's underlying element.",
 521       "sig" : "()\n{\n\n}",
 522       "static" : false,
 523       "memberOf" : "Roo.grid.Grid",
 524       "isStatic" : false,
 525       "isConstructor" : false,
 526       "isPrivate" : false,
 527       "example" : "",
 528       "deprecated" : "",
 529       "since" : "",
 530       "see" : "",
 531       "exceptions" : "",
 532       "requires" : "",
 533       "params" : [],
 534       "returns" : [
 535         {
 536           "name" : "",
 537           "type" : "Element",
 538           "desc" : "The element"
 539         }
 540       ]
 541     },
 542     {
 543       "name" : "getDataSource",
 544       "type" : "function",
 545       "desc" : "Returns the grid's DataSource.",
 546       "sig" : "()\n{\n\n}",
 547       "static" : false,
 548       "memberOf" : "Roo.grid.Grid",
 549       "isStatic" : false,
 550       "isConstructor" : false,
 551       "isPrivate" : false,
 552       "example" : "",
 553       "deprecated" : "",
 554       "since" : "",
 555       "see" : "",
 556       "exceptions" : "",
 557       "requires" : "",
 558       "params" : [],
 559       "returns" : [
 560         {
 561           "name" : "",
 562           "type" : "DataSource",
 563           "desc" : ""
 564         }
 565       ]
 566     },
 567     {
 568       "name" : "autoSize",
 569       "type" : "function",
 570       "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.",
 571       "sig" : "()\n{\n\n}",
 572       "static" : false,
 573       "memberOf" : "Roo.grid.Grid",
 574       "isStatic" : false,
 575       "isConstructor" : false,
 576       "isPrivate" : false,
 577       "example" : "",
 578       "deprecated" : "",
 579       "since" : "",
 580       "see" : "",
 581       "exceptions" : "",
 582       "requires" : "",
 583       "params" : [],
 584       "returns" : []
 585     },
 586     {
 587       "name" : "getView",
 588       "type" : "function",
 589       "desc" : "Returns the grid's GridView object.",
 590       "sig" : "()\n{\n\n}",
 591       "static" : false,
 592       "memberOf" : "Roo.grid.Grid",
 593       "isStatic" : false,
 594       "isConstructor" : false,
 595       "isPrivate" : false,
 596       "example" : "",
 597       "deprecated" : "",
 598       "since" : "",
 599       "see" : "",
 600       "exceptions" : "",
 601       "requires" : "",
 602       "params" : [],
 603       "returns" : [
 604         {
 605           "name" : "",
 606           "type" : "GridView",
 607           "desc" : ""
 608         }
 609       ]
 610     },
 611     {
 612       "name" : "reconfigure",
 613       "type" : "function",
 614       "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
 615       "sig" : "(dataSource, The)",
 616       "static" : false,
 617       "memberOf" : "Roo.grid.Grid",
 618       "isStatic" : false,
 619       "isConstructor" : false,
 620       "isPrivate" : false,
 621       "example" : "",
 622       "deprecated" : "",
 623       "since" : "",
 624       "see" : "",
 625       "exceptions" : "",
 626       "requires" : "",
 627       "params" : [
 628         {
 629           "name" : "dataSource",
 630           "type" : "Roo.data.Store",
 631           "desc" : "The new {@link Roo.data.Store} object",
 632           "isOptional" : false
 633         },
 634         {
 635           "name" : "The",
 636           "type" : "Roo.grid.ColumnModel",
 637           "desc" : "new {@link Roo.grid.ColumnModel} object",
 638           "isOptional" : false
 639         }
 640       ],
 641       "returns" : []
 642     },
 643     {
 644       "name" : "addColumns",
 645       "type" : "function",
 646       "desc" : "addColumns\nAdd's a column, default at the end..",
 647       "sig" : "(position, of)",
 648       "static" : false,
 649       "memberOf" : "Roo.grid.Grid",
 650       "isStatic" : false,
 651       "isConstructor" : false,
 652       "isPrivate" : false,
 653       "example" : "",
 654       "deprecated" : "",
 655       "since" : "",
 656       "see" : "",
 657       "exceptions" : "",
 658       "requires" : "",
 659       "params" : [
 660         {
 661           "name" : "position",
 662           "type" : "int",
 663           "desc" : "to add (default end)",
 664           "isOptional" : false
 665         },
 666         {
 667           "name" : "of",
 668           "type" : "Array",
 669           "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
 670           "isOptional" : false
 671         }
 672       ],
 673       "returns" : []
 674     },
 675     {
 676       "name" : "render",
 677       "type" : "function",
 678       "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
 679       "sig" : "()\n{\n\n}",
 680       "static" : false,
 681       "memberOf" : "Roo.grid.Grid",
 682       "isStatic" : false,
 683       "isConstructor" : false,
 684       "isPrivate" : false,
 685       "example" : "",
 686       "deprecated" : "",
 687       "since" : "",
 688       "see" : "",
 689       "exceptions" : "",
 690       "requires" : "",
 691       "params" : [],
 692       "returns" : [
 693         {
 694           "name" : "",
 695           "type" : "Roo.grid.Grid",
 696           "desc" : "this"
 697         }
 698       ]
 699     },
 700     {
 701       "name" : "purgeListeners",
 702       "type" : "function",
 703       "desc" : "Removes all listeners for this object",
 704       "sig" : "()\n{\n\n}",
 705       "static" : false,
 706       "memberOf" : "Roo.util.Observable",
 707       "isStatic" : false,
 708       "isConstructor" : false,
 709       "isPrivate" : false,
 710       "example" : "",
 711       "deprecated" : "",
 712       "since" : "",
 713       "see" : "",
 714       "exceptions" : "",
 715       "requires" : "",
 716       "params" : [],
 717       "returns" : []
 718     },
 719     {
 720       "name" : "on",
 721       "type" : "function",
 722       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 723       "sig" : "(eventName, handler, scope, options)",
 724       "static" : false,
 725       "memberOf" : "Roo.util.Observable",
 726       "isStatic" : false,
 727       "isConstructor" : false,
 728       "isPrivate" : false,
 729       "example" : "",
 730       "deprecated" : "",
 731       "since" : "",
 732       "see" : "",
 733       "exceptions" : "",
 734       "requires" : "",
 735       "params" : [
 736         {
 737           "name" : "eventName",
 738           "type" : "String",
 739           "desc" : "The type of event to listen for",
 740           "isOptional" : false
 741         },
 742         {
 743           "name" : "handler",
 744           "type" : "Function",
 745           "desc" : "The method the event invokes",
 746           "isOptional" : false
 747         },
 748         {
 749           "name" : "scope",
 750           "type" : "Object",
 751           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 752           "isOptional" : false
 753         },
 754         {
 755           "name" : "options",
 756           "type" : "Object",
 757           "desc" : "(optional)",
 758           "isOptional" : false
 759         }
 760       ],
 761       "returns" : []
 762     },
 763     {
 764       "name" : "un",
 765       "type" : "function",
 766       "desc" : "Removes a listener (shorthand for removeListener)",
 767       "sig" : "(eventName, handler, scope)",
 768       "static" : false,
 769       "memberOf" : "Roo.util.Observable",
 770       "isStatic" : false,
 771       "isConstructor" : false,
 772       "isPrivate" : false,
 773       "example" : "",
 774       "deprecated" : "",
 775       "since" : "",
 776       "see" : "",
 777       "exceptions" : "",
 778       "requires" : "",
 779       "params" : [
 780         {
 781           "name" : "eventName",
 782           "type" : "String",
 783           "desc" : "The type of event to listen for",
 784           "isOptional" : false
 785         },
 786         {
 787           "name" : "handler",
 788           "type" : "Function",
 789           "desc" : "The handler to remove",
 790           "isOptional" : false
 791         },
 792         {
 793           "name" : "scope",
 794           "type" : "Object",
 795           "desc" : "(optional) The scope (this object) for the handler",
 796           "isOptional" : false
 797         }
 798       ],
 799       "returns" : []
 800     },
 801     {
 802       "name" : "addEvents",
 803       "type" : "function",
 804       "desc" : "Used to define events on this Observable",
 805       "sig" : "(object)",
 806       "static" : false,
 807       "memberOf" : "Roo.util.Observable",
 808       "isStatic" : false,
 809       "isConstructor" : false,
 810       "isPrivate" : false,
 811       "example" : "",
 812       "deprecated" : "",
 813       "since" : "",
 814       "see" : "",
 815       "exceptions" : "",
 816       "requires" : "",
 817       "params" : [
 818         {
 819           "name" : "object",
 820           "type" : "Object",
 821           "desc" : "The object with the events defined",
 822           "isOptional" : false
 823         }
 824       ],
 825       "returns" : []
 826     },
 827     {
 828       "name" : "releaseCapture",
 829       "type" : "function",
 830       "desc" : "Removes <b>all</b> added captures from the Observable.",
 831       "sig" : "(o)",
 832       "static" : true,
 833       "memberOf" : "Roo.util.Observable",
 834       "isStatic" : true,
 835       "isConstructor" : false,
 836       "isPrivate" : false,
 837       "example" : "",
 838       "deprecated" : "",
 839       "since" : "",
 840       "see" : "",
 841       "exceptions" : "",
 842       "requires" : "",
 843       "params" : [
 844         {
 845           "name" : "o",
 846           "type" : "Observable",
 847           "desc" : "The Observable to release",
 848           "isOptional" : false
 849         }
 850       ],
 851       "returns" : []
 852     },
 853     {
 854       "name" : "removeListener",
 855       "type" : "function",
 856       "desc" : "Removes a listener",
 857       "sig" : "(eventName, handler, scope)",
 858       "static" : false,
 859       "memberOf" : "Roo.util.Observable",
 860       "isStatic" : false,
 861       "isConstructor" : false,
 862       "isPrivate" : false,
 863       "example" : "",
 864       "deprecated" : "",
 865       "since" : "",
 866       "see" : "",
 867       "exceptions" : "",
 868       "requires" : "",
 869       "params" : [
 870         {
 871           "name" : "eventName",
 872           "type" : "String",
 873           "desc" : "The type of event to listen for",
 874           "isOptional" : false
 875         },
 876         {
 877           "name" : "handler",
 878           "type" : "Function",
 879           "desc" : "The handler to remove",
 880           "isOptional" : false
 881         },
 882         {
 883           "name" : "scope",
 884           "type" : "Object",
 885           "desc" : "(optional) The scope (this object) for the handler",
 886           "isOptional" : false
 887         }
 888       ],
 889       "returns" : []
 890     },
 891     {
 892       "name" : "fireEvent",
 893       "type" : "function",
 894       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 895       "sig" : "(eventName, args)",
 896       "static" : false,
 897       "memberOf" : "Roo.util.Observable",
 898       "isStatic" : false,
 899       "isConstructor" : false,
 900       "isPrivate" : false,
 901       "example" : "",
 902       "deprecated" : "",
 903       "since" : "",
 904       "see" : "",
 905       "exceptions" : "",
 906       "requires" : "",
 907       "params" : [
 908         {
 909           "name" : "eventName",
 910           "type" : "String",
 911           "desc" : "",
 912           "isOptional" : false
 913         },
 914         {
 915           "name" : "args",
 916           "type" : "Object...",
 917           "desc" : "Variable number of parameters are passed to handlers",
 918           "isOptional" : false
 919         }
 920       ],
 921       "returns" : [
 922         {
 923           "name" : "",
 924           "type" : "Boolean",
 925           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 926         }
 927       ]
 928     },
 929     {
 930       "name" : "hasListener",
 931       "type" : "function",
 932       "desc" : "Checks to see if this object has any listeners for a specified event",
 933       "sig" : "(eventName)",
 934       "static" : false,
 935       "memberOf" : "Roo.util.Observable",
 936       "isStatic" : false,
 937       "isConstructor" : false,
 938       "isPrivate" : false,
 939       "example" : "",
 940       "deprecated" : "",
 941       "since" : "",
 942       "see" : "",
 943       "exceptions" : "",
 944       "requires" : "",
 945       "params" : [
 946         {
 947           "name" : "eventName",
 948           "type" : "String",
 949           "desc" : "The name of the event to check for",
 950           "isOptional" : false
 951         }
 952       ],
 953       "returns" : [
 954         {
 955           "name" : "",
 956           "type" : "Boolean",
 957           "desc" : "True if the event is being listened for, else false"
 958         }
 959       ]
 960     },
 961     {
 962       "name" : "capture",
 963       "type" : "function",
 964       "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.",
 965       "sig" : "(o, fn, scope)",
 966       "static" : true,
 967       "memberOf" : "Roo.util.Observable",
 968       "isStatic" : true,
 969       "isConstructor" : false,
 970       "isPrivate" : false,
 971       "example" : "",
 972       "deprecated" : "",
 973       "since" : "",
 974       "see" : "",
 975       "exceptions" : "",
 976       "requires" : "",
 977       "params" : [
 978         {
 979           "name" : "o",
 980           "type" : "Observable",
 981           "desc" : "The Observable to capture",
 982           "isOptional" : false
 983         },
 984         {
 985           "name" : "fn",
 986           "type" : "Function",
 987           "desc" : "The function to call",
 988           "isOptional" : false
 989         },
 990         {
 991           "name" : "scope",
 992           "type" : "Object",
 993           "desc" : "(optional) The scope (this object) for the fn",
 994           "isOptional" : false
 995         }
 996       ],
 997       "returns" : []
 998     },
 999     {
1000       "name" : "addListener",
1001       "type" : "function",
1002       "desc" : "Appends an event handler to this component",
1003       "sig" : "(eventName, handler, scope, options)",
1004       "static" : false,
1005       "memberOf" : "Roo.util.Observable",
1006       "isStatic" : false,
1007       "isConstructor" : false,
1008       "isPrivate" : false,
1009       "example" : "",
1010       "deprecated" : "",
1011       "since" : "",
1012       "see" : "",
1013       "exceptions" : "",
1014       "requires" : "",
1015       "params" : [
1016         {
1017           "name" : "eventName",
1018           "type" : "String",
1019           "desc" : "The type of event to listen for",
1020           "isOptional" : false
1021         },
1022         {
1023           "name" : "handler",
1024           "type" : "Function",
1025           "desc" : "The method the event invokes",
1026           "isOptional" : false
1027         },
1028         {
1029           "name" : "scope",
1030           "type" : "Object",
1031           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1032           "isOptional" : false
1033         },
1034         {
1035           "name" : "options",
1036           "type" : "Object",
1037           "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>",
1038           "isOptional" : false
1039         }
1040       ],
1041       "returns" : []
1042     }
1043   ],
1044   "events" : [
1045     {
1046       "name" : "beforepropertychange",
1047       "type" : "function",
1048       "desc" : "Fires before a property changes (return false to stop?)",
1049       "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
1050       "memberOf" : "",
1051       "example" : "",
1052       "deprecated" : "",
1053       "since" : "",
1054       "see" : "",
1055       "params" : [
1056         {
1057           "name" : "grid",
1058           "type" : "Roo.grid.PropertyGrid",
1059           "desc" : "property grid? (check could be store)",
1060           "isOptional" : false
1061         },
1062         {
1063           "name" : "id",
1064           "type" : "String",
1065           "desc" : "Record Id",
1066           "isOptional" : false
1067         },
1068         {
1069           "name" : "newval",
1070           "type" : "String",
1071           "desc" : "New Value",
1072           "isOptional" : false
1073         },
1074         {
1075           "name" : "oldval",
1076           "type" : "String",
1077           "desc" : "Old Value",
1078           "isOptional" : false
1079         }
1080       ],
1081       "returns" : []
1082     },
1083     {
1084       "name" : "propertychange",
1085       "type" : "function",
1086       "desc" : "Fires after a property changes",
1087       "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
1088       "memberOf" : "",
1089       "example" : "",
1090       "deprecated" : "",
1091       "since" : "",
1092       "see" : "",
1093       "params" : [
1094         {
1095           "name" : "grid",
1096           "type" : "Roo.grid.PropertyGrid",
1097           "desc" : "property grid? (check could be store)",
1098           "isOptional" : false
1099         },
1100         {
1101           "name" : "id",
1102           "type" : "String",
1103           "desc" : "Record Id",
1104           "isOptional" : false
1105         },
1106         {
1107           "name" : "newval",
1108           "type" : "String",
1109           "desc" : "New Value",
1110           "isOptional" : false
1111         },
1112         {
1113           "name" : "oldval",
1114           "type" : "String",
1115           "desc" : "Old Value",
1116           "isOptional" : false
1117         }
1118       ],
1119       "returns" : []
1120     },
1121     {
1122       "name" : "validateedit",
1123       "type" : "function",
1124       "desc" : "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
1125       "sig" : "function (e)\n{\n\n}",
1126       "memberOf" : "Roo.grid.EditorGrid",
1127       "example" : "",
1128       "deprecated" : "",
1129       "since" : "",
1130       "see" : "",
1131       "params" : [
1132         {
1133           "name" : "e",
1134           "type" : "Object",
1135           "desc" : "An edit event (see above for description)",
1136           "isOptional" : false
1137         }
1138       ],
1139       "returns" : []
1140     },
1141     {
1142       "name" : "beforeedit",
1143       "type" : "function",
1144       "desc" : "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>",
1145       "sig" : "function (e)\n{\n\n}",
1146       "memberOf" : "Roo.grid.EditorGrid",
1147       "example" : "",
1148       "deprecated" : "",
1149       "since" : "",
1150       "see" : "",
1151       "params" : [
1152         {
1153           "name" : "e",
1154           "type" : "Object",
1155           "desc" : "An edit event (see above for description)",
1156           "isOptional" : false
1157         }
1158       ],
1159       "returns" : []
1160     },
1161     {
1162       "name" : "afteredit",
1163       "type" : "function",
1164       "desc" : "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>",
1165       "sig" : "function (e)\n{\n\n}",
1166       "memberOf" : "Roo.grid.EditorGrid",
1167       "example" : "",
1168       "deprecated" : "",
1169       "since" : "",
1170       "see" : "",
1171       "params" : [
1172         {
1173           "name" : "e",
1174           "type" : "Object",
1175           "desc" : "An edit event (see above for description)",
1176           "isOptional" : false
1177         }
1178       ],
1179       "returns" : []
1180     },
1181     {
1182       "name" : "rowcontextmenu",
1183       "type" : "function",
1184       "desc" : "Fires when a row is right clicked",
1185       "sig" : "function (_self, rowIndex, e)\n{\n\n}",
1186       "memberOf" : "Roo.grid.Grid",
1187       "example" : "",
1188       "deprecated" : "",
1189       "since" : "",
1190       "see" : "",
1191       "params" : [
1192         {
1193           "name" : "this",
1194           "type" : "Grid",
1195           "desc" : "",
1196           "isOptional" : false
1197         },
1198         {
1199           "name" : "rowIndex",
1200           "type" : "Number",
1201           "desc" : "",
1202           "isOptional" : false
1203         },
1204         {
1205           "name" : "e",
1206           "type" : "Roo.EventObject",
1207           "desc" : "",
1208           "isOptional" : false
1209         }
1210       ],
1211       "returns" : []
1212     },
1213     {
1214       "name" : "columnmove",
1215       "type" : "function",
1216       "desc" : "Fires when the user moves a column",
1217       "sig" : "function (oldIndex, newIndex)\n{\n\n}",
1218       "memberOf" : "Roo.grid.Grid",
1219       "example" : "",
1220       "deprecated" : "",
1221       "since" : "",
1222       "see" : "",
1223       "params" : [
1224         {
1225           "name" : "oldIndex",
1226           "type" : "Number",
1227           "desc" : "",
1228           "isOptional" : false
1229         },
1230         {
1231           "name" : "newIndex",
1232           "type" : "Number",
1233           "desc" : "",
1234           "isOptional" : false
1235         }
1236       ],
1237       "returns" : []
1238     },
1239     {
1240       "name" : "headercontextmenu",
1241       "type" : "function",
1242       "desc" : "Fires when a header is right clicked",
1243       "sig" : "function (_self, columnIndex, e)\n{\n\n}",
1244       "memberOf" : "Roo.grid.Grid",
1245       "example" : "",
1246       "deprecated" : "",
1247       "since" : "",
1248       "see" : "",
1249       "params" : [
1250         {
1251           "name" : "this",
1252           "type" : "Grid",
1253           "desc" : "",
1254           "isOptional" : false
1255         },
1256         {
1257           "name" : "columnIndex",
1258           "type" : "Number",
1259           "desc" : "",
1260           "isOptional" : false
1261         },
1262         {
1263           "name" : "e",
1264           "type" : "Roo.EventObject",
1265           "desc" : "",
1266           "isOptional" : false
1267         }
1268       ],
1269       "returns" : []
1270     },
1271     {
1272       "name" : "render",
1273       "type" : "function",
1274       "desc" : "Fires when the grid is rendered",
1275       "sig" : "function (grid)\n{\n\n}",
1276       "memberOf" : "Roo.grid.Grid",
1277       "example" : "",
1278       "deprecated" : "",
1279       "since" : "",
1280       "see" : "",
1281       "params" : [
1282         {
1283           "name" : "grid",
1284           "type" : "Grid",
1285           "desc" : "",
1286           "isOptional" : false
1287         }
1288       ],
1289       "returns" : []
1290     },
1291     {
1292       "name" : "bodyscroll",
1293       "type" : "function",
1294       "desc" : "Fires when the body element is scrolled",
1295       "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
1296       "memberOf" : "Roo.grid.Grid",
1297       "example" : "",
1298       "deprecated" : "",
1299       "since" : "",
1300       "see" : "",
1301       "params" : [
1302         {
1303           "name" : "scrollLeft",
1304           "type" : "Number",
1305           "desc" : "",
1306           "isOptional" : false
1307         },
1308         {
1309           "name" : "scrollTop",
1310           "type" : "Number",
1311           "desc" : "",
1312           "isOptional" : false
1313         }
1314       ],
1315       "returns" : []
1316     },
1317     {
1318       "name" : "columnresize",
1319       "type" : "function",
1320       "desc" : "Fires when the user resizes a column",
1321       "sig" : "function (columnIndex, newSize)\n{\n\n}",
1322       "memberOf" : "Roo.grid.Grid",
1323       "example" : "",
1324       "deprecated" : "",
1325       "since" : "",
1326       "see" : "",
1327       "params" : [
1328         {
1329           "name" : "columnIndex",
1330           "type" : "Number",
1331           "desc" : "",
1332           "isOptional" : false
1333         },
1334         {
1335           "name" : "newSize",
1336           "type" : "Number",
1337           "desc" : "",
1338           "isOptional" : false
1339         }
1340       ],
1341       "returns" : []
1342     },
1343     {
1344       "name" : "enddrag",
1345       "type" : "function",
1346       "desc" : "Fires when a drag operation is complete",
1347       "sig" : "function (_self, dd, e)\n{\n\n}",
1348       "memberOf" : "Roo.grid.Grid",
1349       "example" : "",
1350       "deprecated" : "",
1351       "since" : "",
1352       "see" : "",
1353       "params" : [
1354         {
1355           "name" : "this",
1356           "type" : "Grid",
1357           "desc" : "",
1358           "isOptional" : false
1359         },
1360         {
1361           "name" : "dd",
1362           "type" : "Roo.GridDD",
1363           "desc" : "The drag drop object",
1364           "isOptional" : false
1365         },
1366         {
1367           "name" : "e",
1368           "type" : "event",
1369           "desc" : "The raw browser event",
1370           "isOptional" : false
1371         }
1372       ],
1373       "returns" : []
1374     },
1375     {
1376       "name" : "mouseout",
1377       "type" : "function",
1378       "desc" : "The raw mouseout event for the entire grid.",
1379       "sig" : "function (e)\n{\n\n}",
1380       "memberOf" : "Roo.grid.Grid",
1381       "example" : "",
1382       "deprecated" : "",
1383       "since" : "",
1384       "see" : "",
1385       "params" : [
1386         {
1387           "name" : "e",
1388           "type" : "Roo.EventObject",
1389           "desc" : "",
1390           "isOptional" : false
1391         }
1392       ],
1393       "returns" : []
1394     },
1395     {
1396       "name" : "cellclick",
1397       "type" : "function",
1398       "desc" : "Fires when a cell is clicked",
1399       "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
1400       "memberOf" : "Roo.grid.Grid",
1401       "example" : "",
1402       "deprecated" : "",
1403       "since" : "",
1404       "see" : "",
1405       "params" : [
1406         {
1407           "name" : "this",
1408           "type" : "Grid",
1409           "desc" : "",
1410           "isOptional" : false
1411         },
1412         {
1413           "name" : "rowIndex",
1414           "type" : "Number",
1415           "desc" : "",
1416           "isOptional" : false
1417         },
1418         {
1419           "name" : "columnIndex",
1420           "type" : "Number",
1421           "desc" : "",
1422           "isOptional" : false
1423         },
1424         {
1425           "name" : "e",
1426           "type" : "Roo.EventObject",
1427           "desc" : "",
1428           "isOptional" : false
1429         }
1430       ],
1431       "returns" : []
1432     },
1433     {
1434       "name" : "dragover",
1435       "type" : "function",
1436       "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.",
1437       "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1438       "memberOf" : "Roo.grid.Grid",
1439       "example" : "",
1440       "deprecated" : "",
1441       "since" : "",
1442       "see" : "",
1443       "params" : [
1444         {
1445           "name" : "this",
1446           "type" : "Grid",
1447           "desc" : "",
1448           "isOptional" : false
1449         },
1450         {
1451           "name" : "dd",
1452           "type" : "Roo.GridDD",
1453           "desc" : "The drag drop object",
1454           "isOptional" : false
1455         },
1456         {
1457           "name" : "targetId",
1458           "type" : "String",
1459           "desc" : "The target drag drop object",
1460           "isOptional" : false
1461         },
1462         {
1463           "name" : "e",
1464           "type" : "event",
1465           "desc" : "The raw browser event",
1466           "isOptional" : false
1467         }
1468       ],
1469       "returns" : []
1470     },
1471     {
1472       "name" : "rowclass",
1473       "type" : "function",
1474       "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1475       "sig" : "function (gridview, rowcfg)\n{\n\n}",
1476       "memberOf" : "Roo.grid.Grid",
1477       "example" : "",
1478       "deprecated" : "",
1479       "since" : "",
1480       "see" : "",
1481       "params" : [
1482         {
1483           "name" : "gridview",
1484           "type" : "GridView",
1485           "desc" : "The grid view",
1486           "isOptional" : false
1487         },
1488         {
1489           "name" : "rowcfg",
1490           "type" : "Object",
1491           "desc" : "contains record  rowIndex and rowClass - set rowClass to add a style.",
1492           "isOptional" : false
1493         }
1494       ],
1495       "returns" : []
1496     },
1497     {
1498       "name" : "keydown",
1499       "type" : "function",
1500       "desc" : "The raw keydown event for the entire grid.",
1501       "sig" : "function (e)\n{\n\n}",
1502       "memberOf" : "Roo.grid.Grid",
1503       "example" : "",
1504       "deprecated" : "",
1505       "since" : "",
1506       "see" : "",
1507       "params" : [
1508         {
1509           "name" : "e",
1510           "type" : "Roo.EventObject",
1511           "desc" : "",
1512           "isOptional" : false
1513         }
1514       ],
1515       "returns" : []
1516     },
1517     {
1518       "name" : "mousedown",
1519       "type" : "function",
1520       "desc" : "The raw mousedown event for the entire grid.",
1521       "sig" : "function (e)\n{\n\n}",
1522       "memberOf" : "Roo.grid.Grid",
1523       "example" : "",
1524       "deprecated" : "",
1525       "since" : "",
1526       "see" : "",
1527       "params" : [
1528         {
1529           "name" : "e",
1530           "type" : "Roo.EventObject",
1531           "desc" : "",
1532           "isOptional" : false
1533         }
1534       ],
1535       "returns" : []
1536     },
1537     {
1538       "name" : "dragenter",
1539       "type" : "function",
1540       "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
1541       "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1542       "memberOf" : "Roo.grid.Grid",
1543       "example" : "",
1544       "deprecated" : "",
1545       "since" : "",
1546       "see" : "",
1547       "params" : [
1548         {
1549           "name" : "this",
1550           "type" : "Grid",
1551           "desc" : "",
1552           "isOptional" : false
1553         },
1554         {
1555           "name" : "dd",
1556           "type" : "Roo.GridDD",
1557           "desc" : "The drag drop object",
1558           "isOptional" : false
1559         },
1560         {
1561           "name" : "targetId",
1562           "type" : "String",
1563           "desc" : "The target drag drop object",
1564           "isOptional" : false
1565         },
1566         {
1567           "name" : "e",
1568           "type" : "event",
1569           "desc" : "The raw browser event",
1570           "isOptional" : false
1571         }
1572       ],
1573       "returns" : []
1574     },
1575     {
1576       "name" : "dragout",
1577       "type" : "function",
1578       "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
1579       "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1580       "memberOf" : "Roo.grid.Grid",
1581       "example" : "",
1582       "deprecated" : "",
1583       "since" : "",
1584       "see" : "",
1585       "params" : [
1586         {
1587           "name" : "this",
1588           "type" : "Grid",
1589           "desc" : "",
1590           "isOptional" : false
1591         },
1592         {
1593           "name" : "dd",
1594           "type" : "Roo.GridDD",
1595           "desc" : "The drag drop object",
1596           "isOptional" : false
1597         },
1598         {
1599           "name" : "targetId",
1600           "type" : "String",
1601           "desc" : "The target drag drop object",
1602           "isOptional" : false
1603         },
1604         {
1605           "name" : "e",
1606           "type" : "event",
1607           "desc" : "The raw browser event",
1608           "isOptional" : false
1609         }
1610       ],
1611       "returns" : []
1612     },
1613     {
1614       "name" : "mouseup",
1615       "type" : "function",
1616       "desc" : "The raw mouseup event for the entire grid.",
1617       "sig" : "function (e)\n{\n\n}",
1618       "memberOf" : "Roo.grid.Grid",
1619       "example" : "",
1620       "deprecated" : "",
1621       "since" : "",
1622       "see" : "",
1623       "params" : [
1624         {
1625           "name" : "e",
1626           "type" : "Roo.EventObject",
1627           "desc" : "",
1628           "isOptional" : false
1629         }
1630       ],
1631       "returns" : []
1632     },
1633     {
1634       "name" : "keypress",
1635       "type" : "function",
1636       "desc" : "The raw keypress event for the entire grid.",
1637       "sig" : "function (e)\n{\n\n}",
1638       "memberOf" : "Roo.grid.Grid",
1639       "example" : "",
1640       "deprecated" : "",
1641       "since" : "",
1642       "see" : "",
1643       "params" : [
1644         {
1645           "name" : "e",
1646           "type" : "Roo.EventObject",
1647           "desc" : "",
1648           "isOptional" : false
1649         }
1650       ],
1651       "returns" : []
1652     },
1653     {
1654       "name" : "headerclick",
1655       "type" : "function",
1656       "desc" : "Fires when a header is clicked",
1657       "sig" : "function (_self, columnIndex, e)\n{\n\n}",
1658       "memberOf" : "Roo.grid.Grid",
1659       "example" : "",
1660       "deprecated" : "",
1661       "since" : "",
1662       "see" : "",
1663       "params" : [
1664         {
1665           "name" : "this",
1666           "type" : "Grid",
1667           "desc" : "",
1668           "isOptional" : false
1669         },
1670         {
1671           "name" : "columnIndex",
1672           "type" : "Number",
1673           "desc" : "",
1674           "isOptional" : false
1675         },
1676         {
1677           "name" : "e",
1678           "type" : "Roo.EventObject",
1679           "desc" : "",
1680           "isOptional" : false
1681         }
1682       ],
1683       "returns" : []
1684     },
1685     {
1686       "name" : "mouseover",
1687       "type" : "function",
1688       "desc" : "The raw mouseover event for the entire grid.",
1689       "sig" : "function (e)\n{\n\n}",
1690       "memberOf" : "Roo.grid.Grid",
1691       "example" : "",
1692       "deprecated" : "",
1693       "since" : "",
1694       "see" : "",
1695       "params" : [
1696         {
1697           "name" : "e",
1698           "type" : "Roo.EventObject",
1699           "desc" : "",
1700           "isOptional" : false
1701         }
1702       ],
1703       "returns" : []
1704     },
1705     {
1706       "name" : "headerdblclick",
1707       "type" : "function",
1708       "desc" : "Fires when a header cell is double clicked",
1709       "sig" : "function (_self, columnIndex, e)\n{\n\n}",
1710       "memberOf" : "Roo.grid.Grid",
1711       "example" : "",
1712       "deprecated" : "",
1713       "since" : "",
1714       "see" : "",
1715       "params" : [
1716         {
1717           "name" : "this",
1718           "type" : "Grid",
1719           "desc" : "",
1720           "isOptional" : false
1721         },
1722         {
1723           "name" : "columnIndex",
1724           "type" : "Number",
1725           "desc" : "",
1726           "isOptional" : false
1727         },
1728         {
1729           "name" : "e",
1730           "type" : "Roo.EventObject",
1731           "desc" : "",
1732           "isOptional" : false
1733         }
1734       ],
1735       "returns" : []
1736     },
1737     {
1738       "name" : "dragdrop",
1739       "type" : "function",
1740       "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
1741       "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
1742       "memberOf" : "Roo.grid.Grid",
1743       "example" : "",
1744       "deprecated" : "",
1745       "since" : "",
1746       "see" : "",
1747       "params" : [
1748         {
1749           "name" : "this",
1750           "type" : "Grid",
1751           "desc" : "",
1752           "isOptional" : false
1753         },
1754         {
1755           "name" : "dd",
1756           "type" : "Roo.GridDD",
1757           "desc" : "The drag drop object",
1758           "isOptional" : false
1759         },
1760         {
1761           "name" : "targetId",
1762           "type" : "String",
1763           "desc" : "The target drag drop object",
1764           "isOptional" : false
1765         },
1766         {
1767           "name" : "e",
1768           "type" : "event",
1769           "desc" : "The raw browser event",
1770           "isOptional" : false
1771         }
1772       ],
1773       "returns" : []
1774     },
1775     {
1776       "name" : "rowclick",
1777       "type" : "function",
1778       "desc" : "Fires when a row is clicked",
1779       "sig" : "function (_self, rowIndex, e)\n{\n\n}",
1780       "memberOf" : "Roo.grid.Grid",
1781       "example" : "",
1782       "deprecated" : "",
1783       "since" : "",
1784       "see" : "",
1785       "params" : [
1786         {
1787           "name" : "this",
1788           "type" : "Grid",
1789           "desc" : "",
1790           "isOptional" : false
1791         },
1792         {
1793           "name" : "rowIndex",
1794           "type" : "Number",
1795           "desc" : "",
1796           "isOptional" : false
1797         },
1798         {
1799           "name" : "e",
1800           "type" : "Roo.EventObject",
1801           "desc" : "",
1802           "isOptional" : false
1803         }
1804       ],
1805       "returns" : []
1806     },
1807     {
1808       "name" : "click",
1809       "type" : "function",
1810       "desc" : "The raw click event for the entire grid.",
1811       "sig" : "function (e)\n{\n\n}",
1812       "memberOf" : "Roo.grid.Grid",
1813       "example" : "",
1814       "deprecated" : "",
1815       "since" : "",
1816       "see" : "",
1817       "params" : [
1818         {
1819           "name" : "e",
1820           "type" : "Roo.EventObject",
1821           "desc" : "",
1822           "isOptional" : false
1823         }
1824       ],
1825       "returns" : []
1826     },
1827     {
1828       "name" : "rowdblclick",
1829       "type" : "function",
1830       "desc" : "Fires when a row is double clicked",
1831       "sig" : "function (_self, rowIndex, e)\n{\n\n}",
1832       "memberOf" : "Roo.grid.Grid",
1833       "example" : "",
1834       "deprecated" : "",
1835       "since" : "",
1836       "see" : "",
1837       "params" : [
1838         {
1839           "name" : "this",
1840           "type" : "Grid",
1841           "desc" : "",
1842           "isOptional" : false
1843         },
1844         {
1845           "name" : "rowIndex",
1846           "type" : "Number",
1847           "desc" : "",
1848           "isOptional" : false
1849         },
1850         {
1851           "name" : "e",
1852           "type" : "Roo.EventObject",
1853           "desc" : "",
1854           "isOptional" : false
1855         }
1856       ],
1857       "returns" : []
1858     },
1859     {
1860       "name" : "startdrag",
1861       "type" : "function",
1862       "desc" : "Fires when row(s) start being dragged",
1863       "sig" : "function (_self, dd, e)\n{\n\n}",
1864       "memberOf" : "Roo.grid.Grid",
1865       "example" : "",
1866       "deprecated" : "",
1867       "since" : "",
1868       "see" : "",
1869       "params" : [
1870         {
1871           "name" : "this",
1872           "type" : "Grid",
1873           "desc" : "",
1874           "isOptional" : false
1875         },
1876         {
1877           "name" : "dd",
1878           "type" : "Roo.GridDD",
1879           "desc" : "The drag drop object",
1880           "isOptional" : false
1881         },
1882         {
1883           "name" : "e",
1884           "type" : "event",
1885           "desc" : "The raw browser event",
1886           "isOptional" : false
1887         }
1888       ],
1889       "returns" : []
1890     },
1891     {
1892       "name" : "dblclick",
1893       "type" : "function",
1894       "desc" : "The raw dblclick event for the entire grid.",
1895       "sig" : "function (e)\n{\n\n}",
1896       "memberOf" : "Roo.grid.Grid",
1897       "example" : "",
1898       "deprecated" : "",
1899       "since" : "",
1900       "see" : "",
1901       "params" : [
1902         {
1903           "name" : "e",
1904           "type" : "Roo.EventObject",
1905           "desc" : "",
1906           "isOptional" : false
1907         }
1908       ],
1909       "returns" : []
1910     },
1911     {
1912       "name" : "cellcontextmenu",
1913       "type" : "function",
1914       "desc" : "Fires when a cell is right clicked",
1915       "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
1916       "memberOf" : "Roo.grid.Grid",
1917       "example" : "",
1918       "deprecated" : "",
1919       "since" : "",
1920       "see" : "",
1921       "params" : [
1922         {
1923           "name" : "this",
1924           "type" : "Grid",
1925           "desc" : "",
1926           "isOptional" : false
1927         },
1928         {
1929           "name" : "rowIndex",
1930           "type" : "Number",
1931           "desc" : "",
1932           "isOptional" : false
1933         },
1934         {
1935           "name" : "cellIndex",
1936           "type" : "Number",
1937           "desc" : "",
1938           "isOptional" : false
1939         },
1940         {
1941           "name" : "e",
1942           "type" : "Roo.EventObject",
1943           "desc" : "",
1944           "isOptional" : false
1945         }
1946       ],
1947       "returns" : []
1948     },
1949     {
1950       "name" : "contextmenu",
1951       "type" : "function",
1952       "desc" : "The raw contextmenu event for the entire grid.",
1953       "sig" : "function (e)\n{\n\n}",
1954       "memberOf" : "Roo.grid.Grid",
1955       "example" : "",
1956       "deprecated" : "",
1957       "since" : "",
1958       "see" : "",
1959       "params" : [
1960         {
1961           "name" : "e",
1962           "type" : "Roo.EventObject",
1963           "desc" : "",
1964           "isOptional" : false
1965         }
1966       ],
1967       "returns" : []
1968     },
1969     {
1970       "name" : "celldblclick",
1971       "type" : "function",
1972       "desc" : "Fires when a cell is double clicked",
1973       "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
1974       "memberOf" : "Roo.grid.Grid",
1975       "example" : "",
1976       "deprecated" : "",
1977       "since" : "",
1978       "see" : "",
1979       "params" : [
1980         {
1981           "name" : "this",
1982           "type" : "Grid",
1983           "desc" : "",
1984           "isOptional" : false
1985         },
1986         {
1987           "name" : "rowIndex",
1988           "type" : "Number",
1989           "desc" : "",
1990           "isOptional" : false
1991         },
1992         {
1993           "name" : "columnIndex",
1994           "type" : "Number",
1995           "desc" : "",
1996           "isOptional" : false
1997         },
1998         {
1999           "name" : "e",
2000           "type" : "Roo.EventObject",
2001           "desc" : "",
2002           "isOptional" : false
2003         }
2004       ],
2005       "returns" : []
2006     }
2007   ]
2008 }