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