git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.grid.EditorGrid.json

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