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" : "addColumns",
471       "desc" : "addColumns\nAdd's a column, default at the end..",
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           "name" : "position",
483           "type" : "int",
484           "desc" : "to add (default end)",
485           "isOptional" : false
486         },
487         {
488           "name" : "of",
489           "type" : "Array",
490           "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
491           "isOptional" : false
492         }
493       ],
494       "returns" : [
495       ]
496     },
497     {
498       "name" : "render",
499       "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
500       "isStatic" : false,
501       "isConstructor" : false,
502       "isPrivate" : false,
503       "memberOf" : "Roo.grid.Grid",
504       "example" : "",
505       "deprecated" : "",
506       "since" : "",
507       "see" : "",
508       "params" : [
509       ],
510       "returns" : [
511         {
512           "name" : "",
513           "type" : "Roo.grid.Grid",
514           "desc" : "this"
515         }
516       ]
517     },
518     {
519       "name" : "purgeListeners",
520       "desc" : "Removes all listeners for this object",
521       "isStatic" : false,
522       "isConstructor" : false,
523       "isPrivate" : false,
524       "memberOf" : "Roo.util.Observable",
525       "example" : "",
526       "deprecated" : "",
527       "since" : "",
528       "see" : "",
529       "params" : [
530       ],
531       "returns" : [
532       ]
533     },
534     {
535       "name" : "on",
536       "desc" : "Appends an event handler to this element (shorthand for addListener)",
537       "isStatic" : false,
538       "isConstructor" : false,
539       "isPrivate" : false,
540       "memberOf" : "Roo.util.Observable",
541       "example" : "",
542       "deprecated" : "",
543       "since" : "",
544       "see" : "",
545       "params" : [
546         {
547           "name" : "eventName",
548           "type" : "String",
549           "desc" : "The type of event to listen for",
550           "isOptional" : false
551         },
552         {
553           "name" : "handler",
554           "type" : "Function",
555           "desc" : "The method the event invokes",
556           "isOptional" : false
557         },
558         {
559           "name" : "scope",
560           "type" : "Object",
561           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
562           "isOptional" : false
563         },
564         {
565           "name" : "options",
566           "type" : "Object",
567           "desc" : "(optional)",
568           "isOptional" : false
569         }
570       ],
571       "returns" : [
572       ]
573     },
574     {
575       "name" : "un",
576       "desc" : "Removes a listener (shorthand for removeListener)",
577       "isStatic" : false,
578       "isConstructor" : false,
579       "isPrivate" : false,
580       "memberOf" : "Roo.util.Observable",
581       "example" : "",
582       "deprecated" : "",
583       "since" : "",
584       "see" : "",
585       "params" : [
586         {
587           "name" : "eventName",
588           "type" : "String",
589           "desc" : "The type of event to listen for",
590           "isOptional" : false
591         },
592         {
593           "name" : "handler",
594           "type" : "Function",
595           "desc" : "The handler to remove",
596           "isOptional" : false
597         },
598         {
599           "name" : "scope",
600           "type" : "Object",
601           "desc" : "(optional) The scope (this object) for the handler",
602           "isOptional" : false
603         }
604       ],
605       "returns" : [
606       ]
607     },
608     {
609       "name" : "addEvents",
610       "desc" : "Used to define events on this Observable",
611       "isStatic" : false,
612       "isConstructor" : false,
613       "isPrivate" : false,
614       "memberOf" : "Roo.util.Observable",
615       "example" : "",
616       "deprecated" : "",
617       "since" : "",
618       "see" : "",
619       "params" : [
620         {
621           "name" : "object",
622           "type" : "Object",
623           "desc" : "The object with the events defined",
624           "isOptional" : false
625         }
626       ],
627       "returns" : [
628       ]
629     },
630     {
631       "name" : "releaseCapture",
632       "desc" : "Removes <b>all</b> added captures from the Observable.",
633       "isStatic" : true,
634       "isConstructor" : false,
635       "isPrivate" : false,
636       "memberOf" : "Roo.util.Observable",
637       "example" : "",
638       "deprecated" : "",
639       "since" : "",
640       "see" : "",
641       "params" : [
642         {
643           "name" : "o",
644           "type" : "Observable",
645           "desc" : "The Observable to release",
646           "isOptional" : false
647         }
648       ],
649       "returns" : [
650       ]
651     },
652     {
653       "name" : "removeListener",
654       "desc" : "Removes a listener",
655       "isStatic" : false,
656       "isConstructor" : false,
657       "isPrivate" : false,
658       "memberOf" : "Roo.util.Observable",
659       "example" : "",
660       "deprecated" : "",
661       "since" : "",
662       "see" : "",
663       "params" : [
664         {
665           "name" : "eventName",
666           "type" : "String",
667           "desc" : "The type of event to listen for",
668           "isOptional" : false
669         },
670         {
671           "name" : "handler",
672           "type" : "Function",
673           "desc" : "The handler to remove",
674           "isOptional" : false
675         },
676         {
677           "name" : "scope",
678           "type" : "Object",
679           "desc" : "(optional) The scope (this object) for the handler",
680           "isOptional" : false
681         }
682       ],
683       "returns" : [
684       ]
685     },
686     {
687       "name" : "fireEvent",
688       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
689       "isStatic" : false,
690       "isConstructor" : false,
691       "isPrivate" : false,
692       "memberOf" : "Roo.util.Observable",
693       "example" : "",
694       "deprecated" : "",
695       "since" : "",
696       "see" : "",
697       "params" : [
698         {
699           "name" : "eventName",
700           "type" : "String",
701           "desc" : "",
702           "isOptional" : false
703         },
704         {
705           "name" : "args",
706           "type" : "Object...",
707           "desc" : "Variable number of parameters are passed to handlers",
708           "isOptional" : false
709         }
710       ],
711       "returns" : [
712         {
713           "name" : "",
714           "type" : "Boolean",
715           "desc" : "returns false if any of the handlers return false otherwise it returns true"
716         }
717       ]
718     },
719     {
720       "name" : "hasListener",
721       "desc" : "Checks to see if this object has any listeners for a specified event",
722       "isStatic" : false,
723       "isConstructor" : false,
724       "isPrivate" : false,
725       "memberOf" : "Roo.util.Observable",
726       "example" : "",
727       "deprecated" : "",
728       "since" : "",
729       "see" : "",
730       "params" : [
731         {
732           "name" : "eventName",
733           "type" : "String",
734           "desc" : "The name of the event to check for",
735           "isOptional" : false
736         }
737       ],
738       "returns" : [
739         {
740           "name" : "",
741           "type" : "Boolean",
742           "desc" : "True if the event is being listened for, else false"
743         }
744       ]
745     },
746     {
747       "name" : "capture",
748       "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.",
749       "isStatic" : true,
750       "isConstructor" : false,
751       "isPrivate" : false,
752       "memberOf" : "Roo.util.Observable",
753       "example" : "",
754       "deprecated" : "",
755       "since" : "",
756       "see" : "",
757       "params" : [
758         {
759           "name" : "o",
760           "type" : "Observable",
761           "desc" : "The Observable to capture",
762           "isOptional" : false
763         },
764         {
765           "name" : "fn",
766           "type" : "Function",
767           "desc" : "The function to call",
768           "isOptional" : false
769         },
770         {
771           "name" : "scope",
772           "type" : "Object",
773           "desc" : "(optional) The scope (this object) for the fn",
774           "isOptional" : false
775         }
776       ],
777       "returns" : [
778       ]
779     },
780     {
781       "name" : "addListener",
782       "desc" : "Appends an event handler to this component",
783       "isStatic" : false,
784       "isConstructor" : false,
785       "isPrivate" : false,
786       "memberOf" : "Roo.util.Observable",
787       "example" : "",
788       "deprecated" : "",
789       "since" : "",
790       "see" : "",
791       "params" : [
792         {
793           "name" : "eventName",
794           "type" : "String",
795           "desc" : "The type of event to listen for",
796           "isOptional" : false
797         },
798         {
799           "name" : "handler",
800           "type" : "Function",
801           "desc" : "The method the event invokes",
802           "isOptional" : false
803         },
804         {
805           "name" : "scope",
806           "type" : "Object",
807           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
808           "isOptional" : false
809         },
810         {
811           "name" : "options",
812           "type" : "Object",
813           "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>",
814           "isOptional" : false
815         }
816       ],
817       "returns" : [
818       ]
819     }
820   ],
821   "events" : [
822     {
823       "name" : "validateedit",
824       "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>",
825       "memberOf" : "Roo.grid.EditorGrid",
826       "example" : "",
827       "deprecated" : "",
828       "since" : "",
829       "see" : "",
830       "params" : [
831         {
832           "name" : "e",
833           "type" : "Object",
834           "desc" : "An edit event (see above for description)",
835           "isOptional" : false
836         }
837       ],
838       "returns" : [
839       ]
840     },
841     {
842       "name" : "beforeedit",
843       "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>",
844       "memberOf" : "Roo.grid.EditorGrid",
845       "example" : "",
846       "deprecated" : "",
847       "since" : "",
848       "see" : "",
849       "params" : [
850         {
851           "name" : "e",
852           "type" : "Object",
853           "desc" : "An edit event (see above for description)",
854           "isOptional" : false
855         }
856       ],
857       "returns" : [
858       ]
859     },
860     {
861       "name" : "afteredit",
862       "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>",
863       "memberOf" : "Roo.grid.EditorGrid",
864       "example" : "",
865       "deprecated" : "",
866       "since" : "",
867       "see" : "",
868       "params" : [
869         {
870           "name" : "e",
871           "type" : "Object",
872           "desc" : "An edit event (see above for description)",
873           "isOptional" : false
874         }
875       ],
876       "returns" : [
877       ]
878     },
879     {
880       "name" : "rowcontextmenu",
881       "desc" : "Fires when a row is right clicked",
882       "memberOf" : "Roo.grid.Grid",
883       "example" : "",
884       "deprecated" : "",
885       "since" : "",
886       "see" : "",
887       "params" : [
888         {
889           "name" : "this",
890           "type" : "Grid",
891           "desc" : "",
892           "isOptional" : false
893         },
894         {
895           "name" : "rowIndex",
896           "type" : "Number",
897           "desc" : "",
898           "isOptional" : false
899         },
900         {
901           "name" : "e",
902           "type" : "Roo.EventObject",
903           "desc" : "",
904           "isOptional" : false
905         }
906       ],
907       "returns" : [
908       ]
909     },
910     {
911       "name" : "columnmove",
912       "desc" : "Fires when the user moves a column",
913       "memberOf" : "Roo.grid.Grid",
914       "example" : "",
915       "deprecated" : "",
916       "since" : "",
917       "see" : "",
918       "params" : [
919         {
920           "name" : "oldIndex",
921           "type" : "Number",
922           "desc" : "",
923           "isOptional" : false
924         },
925         {
926           "name" : "newIndex",
927           "type" : "Number",
928           "desc" : "",
929           "isOptional" : false
930         }
931       ],
932       "returns" : [
933       ]
934     },
935     {
936       "name" : "headercontextmenu",
937       "desc" : "Fires when a header is right clicked",
938       "memberOf" : "Roo.grid.Grid",
939       "example" : "",
940       "deprecated" : "",
941       "since" : "",
942       "see" : "",
943       "params" : [
944         {
945           "name" : "this",
946           "type" : "Grid",
947           "desc" : "",
948           "isOptional" : false
949         },
950         {
951           "name" : "columnIndex",
952           "type" : "Number",
953           "desc" : "",
954           "isOptional" : false
955         },
956         {
957           "name" : "e",
958           "type" : "Roo.EventObject",
959           "desc" : "",
960           "isOptional" : false
961         }
962       ],
963       "returns" : [
964       ]
965     },
966     {
967       "name" : "render",
968       "desc" : "Fires when the grid is rendered",
969       "memberOf" : "Roo.grid.Grid",
970       "example" : "",
971       "deprecated" : "",
972       "since" : "",
973       "see" : "",
974       "params" : [
975         {
976           "name" : "grid",
977           "type" : "Grid",
978           "desc" : "",
979           "isOptional" : false
980         }
981       ],
982       "returns" : [
983       ]
984     },
985     {
986       "name" : "bodyscroll",
987       "desc" : "Fires when the body element is scrolled",
988       "memberOf" : "Roo.grid.Grid",
989       "example" : "",
990       "deprecated" : "",
991       "since" : "",
992       "see" : "",
993       "params" : [
994         {
995           "name" : "scrollLeft",
996           "type" : "Number",
997           "desc" : "",
998           "isOptional" : false
999         },
1000         {
1001           "name" : "scrollTop",
1002           "type" : "Number",
1003           "desc" : "",
1004           "isOptional" : false
1005         }
1006       ],
1007       "returns" : [
1008       ]
1009     },
1010     {
1011       "name" : "columnresize",
1012       "desc" : "Fires when the user resizes a column",
1013       "memberOf" : "Roo.grid.Grid",
1014       "example" : "",
1015       "deprecated" : "",
1016       "since" : "",
1017       "see" : "",
1018       "params" : [
1019         {
1020           "name" : "columnIndex",
1021           "type" : "Number",
1022           "desc" : "",
1023           "isOptional" : false
1024         },
1025         {
1026           "name" : "newSize",
1027           "type" : "Number",
1028           "desc" : "",
1029           "isOptional" : false
1030         }
1031       ],
1032       "returns" : [
1033       ]
1034     },
1035     {
1036       "name" : "enddrag",
1037       "desc" : "Fires when a drag operation is complete",
1038       "memberOf" : "Roo.grid.Grid",
1039       "example" : "",
1040       "deprecated" : "",
1041       "since" : "",
1042       "see" : "",
1043       "params" : [
1044         {
1045           "name" : "this",
1046           "type" : "Grid",
1047           "desc" : "",
1048           "isOptional" : false
1049         },
1050         {
1051           "name" : "dd",
1052           "type" : "Roo.GridDD",
1053           "desc" : "The drag drop object",
1054           "isOptional" : false
1055         },
1056         {
1057           "name" : "e",
1058           "type" : "event",
1059           "desc" : "The raw browser event",
1060           "isOptional" : false
1061         }
1062       ],
1063       "returns" : [
1064       ]
1065     },
1066     {
1067       "name" : "mouseout",
1068       "desc" : "The raw mouseout event for the entire grid.",
1069       "memberOf" : "Roo.grid.Grid",
1070       "example" : "",
1071       "deprecated" : "",
1072       "since" : "",
1073       "see" : "",
1074       "params" : [
1075         {
1076           "name" : "e",
1077           "type" : "Roo.EventObject",
1078           "desc" : "",
1079           "isOptional" : false
1080         }
1081       ],
1082       "returns" : [
1083       ]
1084     },
1085     {
1086       "name" : "cellclick",
1087       "desc" : "Fires when a cell is clicked",
1088       "memberOf" : "Roo.grid.Grid",
1089       "example" : "",
1090       "deprecated" : "",
1091       "since" : "",
1092       "see" : "",
1093       "params" : [
1094         {
1095           "name" : "this",
1096           "type" : "Grid",
1097           "desc" : "",
1098           "isOptional" : false
1099         },
1100         {
1101           "name" : "rowIndex",
1102           "type" : "Number",
1103           "desc" : "",
1104           "isOptional" : false
1105         },
1106         {
1107           "name" : "columnIndex",
1108           "type" : "Number",
1109           "desc" : "",
1110           "isOptional" : false
1111         },
1112         {
1113           "name" : "e",
1114           "type" : "Roo.EventObject",
1115           "desc" : "",
1116           "isOptional" : false
1117         }
1118       ],
1119       "returns" : [
1120       ]
1121     },
1122     {
1123       "name" : "dragover",
1124       "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.",
1125       "memberOf" : "Roo.grid.Grid",
1126       "example" : "",
1127       "deprecated" : "",
1128       "since" : "",
1129       "see" : "",
1130       "params" : [
1131         {
1132           "name" : "this",
1133           "type" : "Grid",
1134           "desc" : "",
1135           "isOptional" : false
1136         },
1137         {
1138           "name" : "dd",
1139           "type" : "Roo.GridDD",
1140           "desc" : "The drag drop object",
1141           "isOptional" : false
1142         },
1143         {
1144           "name" : "targetId",
1145           "type" : "String",
1146           "desc" : "The target drag drop object",
1147           "isOptional" : false
1148         },
1149         {
1150           "name" : "e",
1151           "type" : "event",
1152           "desc" : "The raw browser event",
1153           "isOptional" : false
1154         }
1155       ],
1156       "returns" : [
1157       ]
1158     },
1159     {
1160       "name" : "rowclass",
1161       "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1162       "memberOf" : "Roo.grid.Grid",
1163       "example" : "",
1164       "deprecated" : "",
1165       "since" : "",
1166       "see" : "",
1167       "params" : [
1168         {
1169           "name" : "gridview",
1170           "type" : "GridView",
1171           "desc" : "The grid view",
1172           "isOptional" : false
1173         },
1174         {
1175           "name" : "rowcfg",
1176           "type" : "Object",
1177           "desc" : "contains record  rowIndex and rowClass - set rowClass to add a style.",
1178           "isOptional" : false
1179         }
1180       ],
1181       "returns" : [
1182       ]
1183     },
1184     {
1185       "name" : "keydown",
1186       "desc" : "The raw keydown event for the entire grid.",
1187       "memberOf" : "Roo.grid.Grid",
1188       "example" : "",
1189       "deprecated" : "",
1190       "since" : "",
1191       "see" : "",
1192       "params" : [
1193         {
1194           "name" : "e",
1195           "type" : "Roo.EventObject",
1196           "desc" : "",
1197           "isOptional" : false
1198         }
1199       ],
1200       "returns" : [
1201       ]
1202     },
1203     {
1204       "name" : "mousedown",
1205       "desc" : "The raw mousedown event for the entire grid.",
1206       "memberOf" : "Roo.grid.Grid",
1207       "example" : "",
1208       "deprecated" : "",
1209       "since" : "",
1210       "see" : "",
1211       "params" : [
1212         {
1213           "name" : "e",
1214           "type" : "Roo.EventObject",
1215           "desc" : "",
1216           "isOptional" : false
1217         }
1218       ],
1219       "returns" : [
1220       ]
1221     },
1222     {
1223       "name" : "dragenter",
1224       "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
1225       "memberOf" : "Roo.grid.Grid",
1226       "example" : "",
1227       "deprecated" : "",
1228       "since" : "",
1229       "see" : "",
1230       "params" : [
1231         {
1232           "name" : "this",
1233           "type" : "Grid",
1234           "desc" : "",
1235           "isOptional" : false
1236         },
1237         {
1238           "name" : "dd",
1239           "type" : "Roo.GridDD",
1240           "desc" : "The drag drop object",
1241           "isOptional" : false
1242         },
1243         {
1244           "name" : "targetId",
1245           "type" : "String",
1246           "desc" : "The target drag drop object",
1247           "isOptional" : false
1248         },
1249         {
1250           "name" : "e",
1251           "type" : "event",
1252           "desc" : "The raw browser event",
1253           "isOptional" : false
1254         }
1255       ],
1256       "returns" : [
1257       ]
1258     },
1259     {
1260       "name" : "dragout",
1261       "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
1262       "memberOf" : "Roo.grid.Grid",
1263       "example" : "",
1264       "deprecated" : "",
1265       "since" : "",
1266       "see" : "",
1267       "params" : [
1268         {
1269           "name" : "this",
1270           "type" : "Grid",
1271           "desc" : "",
1272           "isOptional" : false
1273         },
1274         {
1275           "name" : "dd",
1276           "type" : "Roo.GridDD",
1277           "desc" : "The drag drop object",
1278           "isOptional" : false
1279         },
1280         {
1281           "name" : "targetId",
1282           "type" : "String",
1283           "desc" : "The target drag drop object",
1284           "isOptional" : false
1285         },
1286         {
1287           "name" : "e",
1288           "type" : "event",
1289           "desc" : "The raw browser event",
1290           "isOptional" : false
1291         }
1292       ],
1293       "returns" : [
1294       ]
1295     },
1296     {
1297       "name" : "mouseup",
1298       "desc" : "The raw mouseup event for the entire grid.",
1299       "memberOf" : "Roo.grid.Grid",
1300       "example" : "",
1301       "deprecated" : "",
1302       "since" : "",
1303       "see" : "",
1304       "params" : [
1305         {
1306           "name" : "e",
1307           "type" : "Roo.EventObject",
1308           "desc" : "",
1309           "isOptional" : false
1310         }
1311       ],
1312       "returns" : [
1313       ]
1314     },
1315     {
1316       "name" : "keypress",
1317       "desc" : "The raw keypress event for the entire grid.",
1318       "memberOf" : "Roo.grid.Grid",
1319       "example" : "",
1320       "deprecated" : "",
1321       "since" : "",
1322       "see" : "",
1323       "params" : [
1324         {
1325           "name" : "e",
1326           "type" : "Roo.EventObject",
1327           "desc" : "",
1328           "isOptional" : false
1329         }
1330       ],
1331       "returns" : [
1332       ]
1333     },
1334     {
1335       "name" : "headerclick",
1336       "desc" : "Fires when a header is 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     {
1366       "name" : "mouseover",
1367       "desc" : "The raw mouseover event for the entire grid.",
1368       "memberOf" : "Roo.grid.Grid",
1369       "example" : "",
1370       "deprecated" : "",
1371       "since" : "",
1372       "see" : "",
1373       "params" : [
1374         {
1375           "name" : "e",
1376           "type" : "Roo.EventObject",
1377           "desc" : "",
1378           "isOptional" : false
1379         }
1380       ],
1381       "returns" : [
1382       ]
1383     },
1384     {
1385       "name" : "headerdblclick",
1386       "desc" : "Fires when a header cell is double clicked",
1387       "memberOf" : "Roo.grid.Grid",
1388       "example" : "",
1389       "deprecated" : "",
1390       "since" : "",
1391       "see" : "",
1392       "params" : [
1393         {
1394           "name" : "this",
1395           "type" : "Grid",
1396           "desc" : "",
1397           "isOptional" : false
1398         },
1399         {
1400           "name" : "columnIndex",
1401           "type" : "Number",
1402           "desc" : "",
1403           "isOptional" : false
1404         },
1405         {
1406           "name" : "e",
1407           "type" : "Roo.EventObject",
1408           "desc" : "",
1409           "isOptional" : false
1410         }
1411       ],
1412       "returns" : [
1413       ]
1414     },
1415     {
1416       "name" : "dragdrop",
1417       "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
1418       "memberOf" : "Roo.grid.Grid",
1419       "example" : "",
1420       "deprecated" : "",
1421       "since" : "",
1422       "see" : "",
1423       "params" : [
1424         {
1425           "name" : "this",
1426           "type" : "Grid",
1427           "desc" : "",
1428           "isOptional" : false
1429         },
1430         {
1431           "name" : "dd",
1432           "type" : "Roo.GridDD",
1433           "desc" : "The drag drop object",
1434           "isOptional" : false
1435         },
1436         {
1437           "name" : "targetId",
1438           "type" : "String",
1439           "desc" : "The target drag drop object",
1440           "isOptional" : false
1441         },
1442         {
1443           "name" : "e",
1444           "type" : "event",
1445           "desc" : "The raw browser event",
1446           "isOptional" : false
1447         }
1448       ],
1449       "returns" : [
1450       ]
1451     },
1452     {
1453       "name" : "rowclick",
1454       "desc" : "Fires when a row is clicked",
1455       "memberOf" : "Roo.grid.Grid",
1456       "example" : "",
1457       "deprecated" : "",
1458       "since" : "",
1459       "see" : "",
1460       "params" : [
1461         {
1462           "name" : "this",
1463           "type" : "Grid",
1464           "desc" : "",
1465           "isOptional" : false
1466         },
1467         {
1468           "name" : "rowIndex",
1469           "type" : "Number",
1470           "desc" : "",
1471           "isOptional" : false
1472         },
1473         {
1474           "name" : "e",
1475           "type" : "Roo.EventObject",
1476           "desc" : "",
1477           "isOptional" : false
1478         }
1479       ],
1480       "returns" : [
1481       ]
1482     },
1483     {
1484       "name" : "click",
1485       "desc" : "The raw click event for the entire grid.",
1486       "memberOf" : "Roo.grid.Grid",
1487       "example" : "",
1488       "deprecated" : "",
1489       "since" : "",
1490       "see" : "",
1491       "params" : [
1492         {
1493           "name" : "e",
1494           "type" : "Roo.EventObject",
1495           "desc" : "",
1496           "isOptional" : false
1497         }
1498       ],
1499       "returns" : [
1500       ]
1501     },
1502     {
1503       "name" : "rowdblclick",
1504       "desc" : "Fires when a row is double clicked",
1505       "memberOf" : "Roo.grid.Grid",
1506       "example" : "",
1507       "deprecated" : "",
1508       "since" : "",
1509       "see" : "",
1510       "params" : [
1511         {
1512           "name" : "this",
1513           "type" : "Grid",
1514           "desc" : "",
1515           "isOptional" : false
1516         },
1517         {
1518           "name" : "rowIndex",
1519           "type" : "Number",
1520           "desc" : "",
1521           "isOptional" : false
1522         },
1523         {
1524           "name" : "e",
1525           "type" : "Roo.EventObject",
1526           "desc" : "",
1527           "isOptional" : false
1528         }
1529       ],
1530       "returns" : [
1531       ]
1532     },
1533     {
1534       "name" : "startdrag",
1535       "desc" : "Fires when row(s) start being dragged",
1536       "memberOf" : "Roo.grid.Grid",
1537       "example" : "",
1538       "deprecated" : "",
1539       "since" : "",
1540       "see" : "",
1541       "params" : [
1542         {
1543           "name" : "this",
1544           "type" : "Grid",
1545           "desc" : "",
1546           "isOptional" : false
1547         },
1548         {
1549           "name" : "dd",
1550           "type" : "Roo.GridDD",
1551           "desc" : "The drag drop object",
1552           "isOptional" : false
1553         },
1554         {
1555           "name" : "e",
1556           "type" : "event",
1557           "desc" : "The raw browser event",
1558           "isOptional" : false
1559         }
1560       ],
1561       "returns" : [
1562       ]
1563     },
1564     {
1565       "name" : "dblclick",
1566       "desc" : "The raw dblclick event for the entire grid.",
1567       "memberOf" : "Roo.grid.Grid",
1568       "example" : "",
1569       "deprecated" : "",
1570       "since" : "",
1571       "see" : "",
1572       "params" : [
1573         {
1574           "name" : "e",
1575           "type" : "Roo.EventObject",
1576           "desc" : "",
1577           "isOptional" : false
1578         }
1579       ],
1580       "returns" : [
1581       ]
1582     },
1583     {
1584       "name" : "cellcontextmenu",
1585       "desc" : "Fires when a cell is right clicked",
1586       "memberOf" : "Roo.grid.Grid",
1587       "example" : "",
1588       "deprecated" : "",
1589       "since" : "",
1590       "see" : "",
1591       "params" : [
1592         {
1593           "name" : "this",
1594           "type" : "Grid",
1595           "desc" : "",
1596           "isOptional" : false
1597         },
1598         {
1599           "name" : "rowIndex",
1600           "type" : "Number",
1601           "desc" : "",
1602           "isOptional" : false
1603         },
1604         {
1605           "name" : "cellIndex",
1606           "type" : "Number",
1607           "desc" : "",
1608           "isOptional" : false
1609         },
1610         {
1611           "name" : "e",
1612           "type" : "Roo.EventObject",
1613           "desc" : "",
1614           "isOptional" : false
1615         }
1616       ],
1617       "returns" : [
1618       ]
1619     },
1620     {
1621       "name" : "contextmenu",
1622       "desc" : "The raw contextmenu event for the entire grid.",
1623       "memberOf" : "Roo.grid.Grid",
1624       "example" : "",
1625       "deprecated" : "",
1626       "since" : "",
1627       "see" : "",
1628       "params" : [
1629         {
1630           "name" : "e",
1631           "type" : "Roo.EventObject",
1632           "desc" : "",
1633           "isOptional" : false
1634         }
1635       ],
1636       "returns" : [
1637       ]
1638     },
1639     {
1640       "name" : "celldblclick",
1641       "desc" : "Fires when a cell is double clicked",
1642       "memberOf" : "Roo.grid.Grid",
1643       "example" : "",
1644       "deprecated" : "",
1645       "since" : "",
1646       "see" : "",
1647       "params" : [
1648         {
1649           "name" : "this",
1650           "type" : "Grid",
1651           "desc" : "",
1652           "isOptional" : false
1653         },
1654         {
1655           "name" : "rowIndex",
1656           "type" : "Number",
1657           "desc" : "",
1658           "isOptional" : false
1659         },
1660         {
1661           "name" : "columnIndex",
1662           "type" : "Number",
1663           "desc" : "",
1664           "isOptional" : false
1665         },
1666         {
1667           "name" : "e",
1668           "type" : "Roo.EventObject",
1669           "desc" : "",
1670           "isOptional" : false
1671         }
1672       ],
1673       "returns" : [
1674       ]
1675     }
1676   ]
1677 }