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