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