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