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