f4ec9d07c8c91f185e047f307dbac2a00d08fbe2
[roojs1] / docs / symbols / Roo.bootstrap.Table.json
1 {
2   "name" : "Roo.bootstrap.Table",
3   "augments" : [
4     "Roo.bootstrap.Component",
5     "Roo.Component",
6     "Roo.util.Observable"
7   ],
8   "desc" : "Bootstrap Table class",
9   "isSingleton" : false,
10   "isStatic" : false,
11   "isBuiltin" : false,
12   "memberOf" : "Table",
13   "example" : "",
14   "deprecated" : "",
15   "since" : "",
16   "see" : "",
17   "params" : [
18     {
19       "name" : "config",
20       "type" : "Object",
21       "desc" : "The config object",
22       "isOptional" : false
23     }
24   ],
25   "returns" : [
26   ],
27   "config" : [
28     {
29       "name" : "footerShow",
30       "type" : "Boolean",
31       "desc" : "generate tfoot, default true",
32       "memberOf" : "Roo.bootstrap.Table",
33       "values" : [
34         "(true",
35         "false)"
36       ]
37     },
38     {
39       "name" : "hideMode",
40       "type" : "String",
41       "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
42       "memberOf" : "Roo.Component",
43       "values" : [
44         "(display",
45         "visibility)"
46       ]
47     },
48     {
49       "name" : "auto_hide_footer",
50       "type" : "Boolean",
51       "desc" : "auto hide footer if only one page (default false)",
52       "memberOf" : "Roo.bootstrap.Table",
53       "values" : [
54       ]
55     },
56     {
57       "name" : "scrollBody",
58       "type" : "Boolean",
59       "desc" : "default false - body scrolled / fixed header",
60       "memberOf" : "Roo.bootstrap.Table",
61       "values" : [
62         "(true",
63         "false)"
64       ]
65     },
66     {
67       "name" : "xattr",
68       "type" : "Object",
69       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
70       "memberOf" : "Roo.bootstrap.Component",
71       "values" : [
72       ]
73     },
74     {
75       "name" : "border",
76       "type" : "Number",
77       "desc" : "Specifies whether the table cells should have borders or not",
78       "memberOf" : "Roo.bootstrap.Table",
79       "values" : [
80       ]
81     },
82     {
83       "name" : "name",
84       "type" : "string",
85       "desc" : "Specifies name attribute",
86       "memberOf" : "Roo.bootstrap.Component",
87       "values" : [
88       ]
89     },
90     {
91       "name" : "width",
92       "type" : "Number",
93       "desc" : "Specifies the width of a table",
94       "memberOf" : "Roo.bootstrap.Table",
95       "values" : [
96       ]
97     },
98     {
99       "name" : "bordered",
100       "type" : "boolean",
101       "desc" : "Add borders to the table",
102       "memberOf" : "Roo.bootstrap.Table",
103       "values" : [
104       ]
105     },
106     {
107       "name" : "rules",
108       "type" : "String",
109       "desc" : "Specifies which parts of the inside borders that should be visible",
110       "memberOf" : "Roo.bootstrap.Table",
111       "values" : [
112       ]
113     },
114     {
115       "name" : "tooltip",
116       "type" : "string",
117       "desc" : "Text for the tooltip",
118       "memberOf" : "Roo.bootstrap.Component",
119       "values" : [
120       ]
121     },
122     {
123       "name" : "allowDomMove",
124       "type" : "Boolean",
125       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
126       "memberOf" : "Roo.Component",
127       "values" : [
128       ]
129     },
130     {
131       "name" : "layout",
132       "type" : "String",
133       "desc" : "table layout (auto | fixed | initial | inherit)",
134       "memberOf" : "Roo.bootstrap.Table",
135       "values" : [
136       ]
137     },
138     {
139       "name" : "condensed",
140       "type" : "boolean",
141       "desc" : "Format condensed",
142       "memberOf" : "Roo.bootstrap.Table",
143       "values" : [
144       ]
145     },
146     {
147       "name" : "style",
148       "type" : "String",
149       "desc" : "any extra css",
150       "memberOf" : "Roo.bootstrap.Component",
151       "values" : [
152       ]
153     },
154     {
155       "name" : "frame",
156       "type" : "String",
157       "desc" : "Specifies which parts of the outside borders that should be visible",
158       "memberOf" : "Roo.bootstrap.Table",
159       "values" : [
160       ]
161     },
162     {
163       "name" : "cellSelection",
164       "type" : "Boolean",
165       "desc" : "default false",
166       "memberOf" : "Roo.bootstrap.Table",
167       "values" : [
168         "(true",
169         "false)"
170       ]
171     },
172     {
173       "name" : "sortable",
174       "type" : "String",
175       "desc" : "Specifies that the table should be sortable",
176       "memberOf" : "Roo.bootstrap.Table",
177       "values" : [
178       ]
179     },
180     {
181       "name" : "actionMode",
182       "type" : "String",
183       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el'",
184       "memberOf" : "Roo.Component",
185       "values" : [
186       ]
187     },
188     {
189       "name" : "listeners",
190       "type" : "Object",
191       "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>",
192       "memberOf" : "Roo.util.Observable",
193       "values" : [
194       ]
195     },
196     {
197       "name" : "striped",
198       "type" : "boolean",
199       "desc" : "Should the rows be alternative striped",
200       "memberOf" : "Roo.bootstrap.Table",
201       "values" : [
202       ]
203     },
204     {
205       "name" : "container_method",
206       "type" : "string",
207       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
208       "memberOf" : "Roo.bootstrap.Component",
209       "values" : [
210       ]
211     },
212     {
213       "name" : "cellspacing",
214       "type" : "Number",
215       "desc" : "Specifies the space between cells",
216       "memberOf" : "Roo.bootstrap.Table",
217       "values" : [
218       ]
219     },
220     {
221       "name" : "align",
222       "type" : "String",
223       "desc" : "Specifies the alignment of a table according to surrounding text",
224       "memberOf" : "Roo.bootstrap.Table",
225       "values" : [
226         "(left",
227         "center",
228         "right)"
229       ]
230     },
231     {
232       "name" : "lazyLoad",
233       "type" : "Boolean",
234       "desc" : "auto load data while scrolling to the end (default false)",
235       "memberOf" : "Roo.bootstrap.Table",
236       "values" : [
237       ]
238     },
239     {
240       "name" : "footer",
241       "type" : "Roo.bootstrap.PagingToolbar",
242       "desc" : "a paging toolbar",
243       "memberOf" : "Roo.bootstrap.Table",
244       "values" : [
245       ]
246     },
247     {
248       "name" : "cls",
249       "type" : "String",
250       "desc" : "table class",
251       "memberOf" : "Roo.bootstrap.Table",
252       "values" : [
253       ]
254     },
255     {
256       "name" : "bgcolor",
257       "type" : "String",
258       "desc" : "Specifies the background color for a table",
259       "memberOf" : "Roo.bootstrap.Table",
260       "values" : [
261       ]
262     },
263     {
264       "name" : "headerShow",
265       "type" : "Boolean",
266       "desc" : "generate thead, default true",
267       "memberOf" : "Roo.bootstrap.Table",
268       "values" : [
269         "(true",
270         "false)"
271       ]
272     },
273     {
274       "name" : "loadMask",
275       "type" : "Boolean",
276       "desc" : "default false",
277       "memberOf" : "Roo.bootstrap.Table",
278       "values" : [
279         "(true",
280         "false)"
281       ]
282     },
283     {
284       "name" : "hover",
285       "type" : "boolean",
286       "desc" : "Add hover highlighting",
287       "memberOf" : "Roo.bootstrap.Table",
288       "values" : [
289       ]
290     },
291     {
292       "name" : "can_build_overlaid",
293       "type" : "Boolean",
294       "desc" : "True if element can be rebuild from a HTML page",
295       "memberOf" : "Roo.bootstrap.Component",
296       "values" : [
297       ]
298     },
299     {
300       "name" : "cellpadding",
301       "type" : "Number",
302       "desc" : "Specifies the space between the cell wall and the cell content",
303       "memberOf" : "Roo.bootstrap.Table",
304       "values" : [
305       ]
306     },
307     {
308       "name" : "disableClass",
309       "type" : "String",
310       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
311       "memberOf" : "Roo.Component",
312       "values" : [
313       ]
314     },
315     {
316       "name" : "visibilityEl",
317       "type" : "string|object",
318       "desc" : "What element to use for visibility (@see getVisibilityEl())",
319       "memberOf" : "Roo.bootstrap.Component",
320       "values" : [
321         "(el",
322         "parent)"
323       ]
324     },
325     {
326       "name" : "dataId",
327       "type" : "string",
328       "desc" : "cutomer id",
329       "memberOf" : "Roo.bootstrap.Component",
330       "values" : [
331       ]
332     },
333     {
334       "name" : "summary",
335       "type" : "String",
336       "desc" : "Specifies a summary of the content of a table",
337       "memberOf" : "Roo.bootstrap.Table",
338       "values" : [
339       ]
340     },
341     {
342       "name" : "rowSelection",
343       "type" : "Boolean",
344       "desc" : "default false",
345       "memberOf" : "Roo.bootstrap.Table",
346       "values" : [
347         "(true",
348         "false)"
349       ]
350     },
351     {
352       "name" : "responsive",
353       "type" : "boolean",
354       "desc" : "Format condensed",
355       "memberOf" : "Roo.bootstrap.Table",
356       "values" : [
357       ]
358     }
359   ],
360   "methods" : [
361     {
362       "name" : "setRowVisibility",
363       "desc" : "Show or hide a row.",
364       "isStatic" : false,
365       "isConstructor" : false,
366       "isPrivate" : false,
367       "memberOf" : "Roo.bootstrap.Table",
368       "example" : "",
369       "deprecated" : "",
370       "since" : "",
371       "see" : "",
372       "params" : [
373         {
374           "name" : "rowIndex",
375           "type" : "Number",
376           "desc" : "to show or hide",
377           "isOptional" : false
378         },
379         {
380           "name" : "state",
381           "type" : "Boolean",
382           "desc" : "hide",
383           "isOptional" : false
384         }
385       ],
386       "returns" : [
387       ]
388     },
389     {
390       "name" : "getGridEl",
391       "desc" : "Returns the grid's underlying element = used by panel.Grid",
392       "isStatic" : false,
393       "isConstructor" : false,
394       "isPrivate" : false,
395       "memberOf" : "Roo.bootstrap.Table",
396       "example" : "",
397       "deprecated" : "",
398       "since" : "",
399       "see" : "",
400       "params" : [
401       ],
402       "returns" : [
403         {
404           "name" : "",
405           "type" : "Element",
406           "desc" : "The element"
407         }
408       ]
409     },
410     {
411       "name" : "autoSize",
412       "desc" : "Forces a resize - used by panel.Grid",
413       "isStatic" : false,
414       "isConstructor" : false,
415       "isPrivate" : false,
416       "memberOf" : "Roo.bootstrap.Table",
417       "example" : "",
418       "deprecated" : "",
419       "since" : "",
420       "see" : "",
421       "params" : [
422       ],
423       "returns" : [
424         {
425           "name" : "",
426           "type" : "Element",
427           "desc" : "The element"
428         }
429       ]
430     },
431     {
432       "name" : "clear",
433       "desc" : "Remove all rows",
434       "isStatic" : false,
435       "isConstructor" : false,
436       "isPrivate" : false,
437       "memberOf" : "Roo.bootstrap.Table",
438       "example" : "",
439       "deprecated" : "",
440       "since" : "",
441       "see" : "",
442       "params" : [
443       ],
444       "returns" : [
445       ]
446     },
447     {
448       "name" : "tooltipEl",
449       "desc" : "Fetch the element to display the tooltip on.",
450       "isStatic" : false,
451       "isConstructor" : false,
452       "isPrivate" : false,
453       "memberOf" : "Roo.bootstrap.Component",
454       "example" : "",
455       "deprecated" : "",
456       "since" : "",
457       "see" : "",
458       "params" : [
459       ],
460       "returns" : [
461         {
462           "name" : "",
463           "type" : "Roo.Element",
464           "desc" : "defaults to this.el"
465         }
466       ]
467     },
468     {
469       "name" : "hide",
470       "desc" : "Hide a component - adds 'hidden' class",
471       "isStatic" : false,
472       "isConstructor" : false,
473       "isPrivate" : false,
474       "memberOf" : "Roo.bootstrap.Component",
475       "example" : "",
476       "deprecated" : "",
477       "since" : "",
478       "see" : "",
479       "params" : [
480       ],
481       "returns" : [
482       ]
483     },
484     {
485       "name" : "show",
486       "desc" : "Show a component - removes 'hidden' class",
487       "isStatic" : false,
488       "isConstructor" : false,
489       "isPrivate" : false,
490       "memberOf" : "Roo.bootstrap.Component",
491       "example" : "",
492       "deprecated" : "",
493       "since" : "",
494       "see" : "",
495       "params" : [
496       ],
497       "returns" : [
498       ]
499     },
500     {
501       "name" : "setVisibilityEl",
502       "desc" : "Set the element that will be used to show or hide",
503       "isStatic" : false,
504       "isConstructor" : false,
505       "isPrivate" : false,
506       "memberOf" : "Roo.bootstrap.Component",
507       "example" : "",
508       "deprecated" : "",
509       "since" : "",
510       "see" : "",
511       "params" : [
512       ],
513       "returns" : [
514       ]
515     },
516     {
517       "name" : "getVisibilityEl",
518       "desc" : "Get the element that will be used to show or hide",
519       "isStatic" : false,
520       "isConstructor" : false,
521       "isPrivate" : false,
522       "memberOf" : "Roo.bootstrap.Component",
523       "example" : "",
524       "deprecated" : "",
525       "since" : "",
526       "see" : "",
527       "params" : [
528       ],
529       "returns" : [
530       ]
531     },
532     {
533       "name" : "addxtype",
534       "desc" : "This is really a wrapper for addxtypeChild\nit handles stuff relating to flexy:foreach / flexy:if\n= some of our projects use a flat rendering of the output, and try and overlay it with dynamic data.\n -- this is a bit of a nightmare... and is even more confusing to debug..",
535       "isStatic" : false,
536       "isConstructor" : false,
537       "isPrivate" : false,
538       "memberOf" : "Roo.bootstrap.Component",
539       "example" : "",
540       "deprecated" : "",
541       "since" : "",
542       "see" : "",
543       "params" : [
544       ],
545       "returns" : [
546       ]
547     },
548     {
549       "name" : "addxtypeChild",
550       "desc" : "add a child to this element\n  - turn the child.cfg into a child_instance\n  - call child_instance.render( this { getContainerMethod()} )\n  - loop through the children, and call addxtype.. (reall this) on newly created child.",
551       "isStatic" : false,
552       "isConstructor" : false,
553       "isPrivate" : false,
554       "memberOf" : "Roo.bootstrap.Component",
555       "example" : "",
556       "deprecated" : "",
557       "since" : "",
558       "see" : "",
559       "params" : [
560       ],
561       "returns" : [
562       ]
563     },
564     {
565       "name" : "initEvents",
566       "desc" : "Initialize Events for the element",
567       "isStatic" : false,
568       "isConstructor" : false,
569       "isPrivate" : false,
570       "memberOf" : "Roo.bootstrap.Component",
571       "example" : "",
572       "deprecated" : "",
573       "since" : "",
574       "see" : "",
575       "params" : [
576       ],
577       "returns" : [
578       ]
579     },
580     {
581       "name" : "getChildContainer",
582       "desc" : "Fetch the element to add children to",
583       "isStatic" : false,
584       "isConstructor" : false,
585       "isPrivate" : false,
586       "memberOf" : "Roo.bootstrap.Component",
587       "example" : "",
588       "deprecated" : "",
589       "since" : "",
590       "see" : "",
591       "params" : [
592       ],
593       "returns" : [
594         {
595           "name" : "",
596           "type" : "Roo.Element",
597           "desc" : "defaults to this.el"
598         }
599       ]
600     },
601     {
602       "name" : "addxtypeChildren",
603       "desc" : "add a number of children to this object,\n    which in turn calls render...",
604       "isStatic" : false,
605       "isConstructor" : false,
606       "isPrivate" : false,
607       "memberOf" : "Roo.bootstrap.Component",
608       "example" : "",
609       "deprecated" : "",
610       "since" : "",
611       "see" : "",
612       "params" : [
613       ],
614       "returns" : [
615       ]
616     },
617     {
618       "name" : "getId",
619       "desc" : "Returns the id of this component.",
620       "isStatic" : false,
621       "isConstructor" : false,
622       "isPrivate" : false,
623       "memberOf" : "Roo.Component",
624       "example" : "",
625       "deprecated" : "",
626       "since" : "",
627       "see" : "",
628       "params" : [
629       ],
630       "returns" : [
631         {
632           "name" : "",
633           "type" : "String",
634           "desc" : ""
635         }
636       ]
637     },
638     {
639       "name" : "render",
640       "desc" : "If this is a lazy rendering component, render it to its container element.",
641       "isStatic" : false,
642       "isConstructor" : false,
643       "isPrivate" : false,
644       "memberOf" : "Roo.Component",
645       "example" : "",
646       "deprecated" : "",
647       "since" : "",
648       "see" : "",
649       "params" : [
650         {
651           "name" : "container",
652           "type" : "String/HTMLElement/Element",
653           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
654           "isOptional" : false
655         }
656       ],
657       "returns" : [
658       ]
659     },
660     {
661       "name" : "destroy",
662       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
663       "isStatic" : false,
664       "isConstructor" : false,
665       "isPrivate" : false,
666       "memberOf" : "Roo.Component",
667       "example" : "",
668       "deprecated" : "",
669       "since" : "",
670       "see" : "",
671       "params" : [
672       ],
673       "returns" : [
674       ]
675     },
676     {
677       "name" : "isVisible",
678       "desc" : "Returns true if this component is visible.",
679       "isStatic" : false,
680       "isConstructor" : false,
681       "isPrivate" : false,
682       "memberOf" : "Roo.Component",
683       "example" : "",
684       "deprecated" : "",
685       "since" : "",
686       "see" : "",
687       "params" : [
688       ],
689       "returns" : [
690       ]
691     },
692     {
693       "name" : "setDisabled",
694       "desc" : "Convenience function for setting disabled/enabled by boolean.",
695       "isStatic" : false,
696       "isConstructor" : false,
697       "isPrivate" : false,
698       "memberOf" : "Roo.Component",
699       "example" : "",
700       "deprecated" : "",
701       "since" : "",
702       "see" : "",
703       "params" : [
704         {
705           "name" : "disabled",
706           "type" : "Boolean",
707           "desc" : "",
708           "isOptional" : false
709         }
710       ],
711       "returns" : [
712       ]
713     },
714     {
715       "name" : "focus",
716       "desc" : "Try to focus this component.",
717       "isStatic" : false,
718       "isConstructor" : false,
719       "isPrivate" : false,
720       "memberOf" : "Roo.Component",
721       "example" : "",
722       "deprecated" : "",
723       "since" : "",
724       "see" : "",
725       "params" : [
726         {
727           "name" : "selectText",
728           "type" : "Boolean",
729           "desc" : "True to also select the text in this component (if applicable)",
730           "isOptional" : false
731         }
732       ],
733       "returns" : [
734         {
735           "name" : "",
736           "type" : "Roo.Component",
737           "desc" : "this"
738         }
739       ]
740     },
741     {
742       "name" : "enable",
743       "desc" : "Enable this component.",
744       "isStatic" : false,
745       "isConstructor" : false,
746       "isPrivate" : false,
747       "memberOf" : "Roo.Component",
748       "example" : "",
749       "deprecated" : "",
750       "since" : "",
751       "see" : "",
752       "params" : [
753       ],
754       "returns" : [
755         {
756           "name" : "",
757           "type" : "Roo.Component",
758           "desc" : "this"
759         }
760       ]
761     },
762     {
763       "name" : "setVisible",
764       "desc" : "Convenience function to hide or show this component by boolean.",
765       "isStatic" : false,
766       "isConstructor" : false,
767       "isPrivate" : false,
768       "memberOf" : "Roo.Component",
769       "example" : "",
770       "deprecated" : "",
771       "since" : "",
772       "see" : "",
773       "params" : [
774         {
775           "name" : "visible",
776           "type" : "Boolean",
777           "desc" : "True to show, false to hide",
778           "isOptional" : false
779         }
780       ],
781       "returns" : [
782         {
783           "name" : "",
784           "type" : "Roo.Component",
785           "desc" : "this"
786         }
787       ]
788     },
789     {
790       "name" : "disable",
791       "desc" : "Disable this component.",
792       "isStatic" : false,
793       "isConstructor" : false,
794       "isPrivate" : false,
795       "memberOf" : "Roo.Component",
796       "example" : "",
797       "deprecated" : "",
798       "since" : "",
799       "see" : "",
800       "params" : [
801       ],
802       "returns" : [
803         {
804           "name" : "",
805           "type" : "Roo.Component",
806           "desc" : "this"
807         }
808       ]
809     },
810     {
811       "name" : "getEl",
812       "desc" : "Returns the underlying {@link Roo.Element}.",
813       "isStatic" : false,
814       "isConstructor" : false,
815       "isPrivate" : false,
816       "memberOf" : "Roo.Component",
817       "example" : "",
818       "deprecated" : "",
819       "since" : "",
820       "see" : "",
821       "params" : [
822       ],
823       "returns" : [
824         {
825           "name" : "",
826           "type" : "Roo.Element",
827           "desc" : "The element"
828         }
829       ]
830     },
831     {
832       "name" : "purgeListeners",
833       "desc" : "Removes all listeners for this object",
834       "isStatic" : false,
835       "isConstructor" : false,
836       "isPrivate" : false,
837       "memberOf" : "Roo.util.Observable",
838       "example" : "",
839       "deprecated" : "",
840       "since" : "",
841       "see" : "",
842       "params" : [
843       ],
844       "returns" : [
845       ]
846     },
847     {
848       "name" : "on",
849       "desc" : "Appends an event handler to this element (shorthand for addListener)",
850       "isStatic" : false,
851       "isConstructor" : false,
852       "isPrivate" : false,
853       "memberOf" : "Roo.util.Observable",
854       "example" : "",
855       "deprecated" : "",
856       "since" : "",
857       "see" : "",
858       "params" : [
859         {
860           "name" : "eventName",
861           "type" : "String",
862           "desc" : "The type of event to listen for",
863           "isOptional" : false
864         },
865         {
866           "name" : "handler",
867           "type" : "Function",
868           "desc" : "The method the event invokes",
869           "isOptional" : false
870         },
871         {
872           "name" : "scope",
873           "type" : "Object",
874           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
875           "isOptional" : false
876         },
877         {
878           "name" : "options",
879           "type" : "Object",
880           "desc" : "(optional)",
881           "isOptional" : false
882         }
883       ],
884       "returns" : [
885       ]
886     },
887     {
888       "name" : "un",
889       "desc" : "Removes a listener (shorthand for removeListener)",
890       "isStatic" : false,
891       "isConstructor" : false,
892       "isPrivate" : false,
893       "memberOf" : "Roo.util.Observable",
894       "example" : "",
895       "deprecated" : "",
896       "since" : "",
897       "see" : "",
898       "params" : [
899         {
900           "name" : "eventName",
901           "type" : "String",
902           "desc" : "The type of event to listen for",
903           "isOptional" : false
904         },
905         {
906           "name" : "handler",
907           "type" : "Function",
908           "desc" : "The handler to remove",
909           "isOptional" : false
910         },
911         {
912           "name" : "scope",
913           "type" : "Object",
914           "desc" : "(optional) The scope (this object) for the handler",
915           "isOptional" : false
916         }
917       ],
918       "returns" : [
919       ]
920     },
921     {
922       "name" : "addEvents",
923       "desc" : "Used to define events on this Observable",
924       "isStatic" : false,
925       "isConstructor" : false,
926       "isPrivate" : false,
927       "memberOf" : "Roo.util.Observable",
928       "example" : "",
929       "deprecated" : "",
930       "since" : "",
931       "see" : "",
932       "params" : [
933         {
934           "name" : "object",
935           "type" : "Object",
936           "desc" : "The object with the events defined",
937           "isOptional" : false
938         }
939       ],
940       "returns" : [
941       ]
942     },
943     {
944       "name" : "releaseCapture",
945       "desc" : "Removes <b>all</b> added captures from the Observable.",
946       "isStatic" : true,
947       "isConstructor" : false,
948       "isPrivate" : false,
949       "memberOf" : "Roo.util.Observable",
950       "example" : "",
951       "deprecated" : "",
952       "since" : "",
953       "see" : "",
954       "params" : [
955         {
956           "name" : "o",
957           "type" : "Observable",
958           "desc" : "The Observable to release",
959           "isOptional" : false
960         }
961       ],
962       "returns" : [
963       ]
964     },
965     {
966       "name" : "removeListener",
967       "desc" : "Removes a listener",
968       "isStatic" : false,
969       "isConstructor" : false,
970       "isPrivate" : false,
971       "memberOf" : "Roo.util.Observable",
972       "example" : "",
973       "deprecated" : "",
974       "since" : "",
975       "see" : "",
976       "params" : [
977         {
978           "name" : "eventName",
979           "type" : "String",
980           "desc" : "The type of event to listen for",
981           "isOptional" : false
982         },
983         {
984           "name" : "handler",
985           "type" : "Function",
986           "desc" : "The handler to remove",
987           "isOptional" : false
988         },
989         {
990           "name" : "scope",
991           "type" : "Object",
992           "desc" : "(optional) The scope (this object) for the handler",
993           "isOptional" : false
994         }
995       ],
996       "returns" : [
997       ]
998     },
999     {
1000       "name" : "fireEvent",
1001       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1002       "isStatic" : false,
1003       "isConstructor" : false,
1004       "isPrivate" : false,
1005       "memberOf" : "Roo.util.Observable",
1006       "example" : "",
1007       "deprecated" : "",
1008       "since" : "",
1009       "see" : "",
1010       "params" : [
1011         {
1012           "name" : "eventName",
1013           "type" : "String",
1014           "desc" : "",
1015           "isOptional" : false
1016         },
1017         {
1018           "name" : "args",
1019           "type" : "Object...",
1020           "desc" : "Variable number of parameters are passed to handlers",
1021           "isOptional" : false
1022         }
1023       ],
1024       "returns" : [
1025         {
1026           "name" : "",
1027           "type" : "Boolean",
1028           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1029         }
1030       ]
1031     },
1032     {
1033       "name" : "hasListener",
1034       "desc" : "Checks to see if this object has any listeners for a specified event",
1035       "isStatic" : false,
1036       "isConstructor" : false,
1037       "isPrivate" : false,
1038       "memberOf" : "Roo.util.Observable",
1039       "example" : "",
1040       "deprecated" : "",
1041       "since" : "",
1042       "see" : "",
1043       "params" : [
1044         {
1045           "name" : "eventName",
1046           "type" : "String",
1047           "desc" : "The name of the event to check for",
1048           "isOptional" : false
1049         }
1050       ],
1051       "returns" : [
1052         {
1053           "name" : "",
1054           "type" : "Boolean",
1055           "desc" : "True if the event is being listened for, else false"
1056         }
1057       ]
1058     },
1059     {
1060       "name" : "capture",
1061       "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.",
1062       "isStatic" : true,
1063       "isConstructor" : false,
1064       "isPrivate" : false,
1065       "memberOf" : "Roo.util.Observable",
1066       "example" : "",
1067       "deprecated" : "",
1068       "since" : "",
1069       "see" : "",
1070       "params" : [
1071         {
1072           "name" : "o",
1073           "type" : "Observable",
1074           "desc" : "The Observable to capture",
1075           "isOptional" : false
1076         },
1077         {
1078           "name" : "fn",
1079           "type" : "Function",
1080           "desc" : "The function to call",
1081           "isOptional" : false
1082         },
1083         {
1084           "name" : "scope",
1085           "type" : "Object",
1086           "desc" : "(optional) The scope (this object) for the fn",
1087           "isOptional" : false
1088         }
1089       ],
1090       "returns" : [
1091       ]
1092     },
1093     {
1094       "name" : "addListener",
1095       "desc" : "Appends an event handler to this component",
1096       "isStatic" : false,
1097       "isConstructor" : false,
1098       "isPrivate" : false,
1099       "memberOf" : "Roo.util.Observable",
1100       "example" : "",
1101       "deprecated" : "",
1102       "since" : "",
1103       "see" : "",
1104       "params" : [
1105         {
1106           "name" : "eventName",
1107           "type" : "String",
1108           "desc" : "The type of event to listen for",
1109           "isOptional" : false
1110         },
1111         {
1112           "name" : "handler",
1113           "type" : "Function",
1114           "desc" : "The method the event invokes",
1115           "isOptional" : false
1116         },
1117         {
1118           "name" : "scope",
1119           "type" : "Object",
1120           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1121           "isOptional" : false
1122         },
1123         {
1124           "name" : "options",
1125           "type" : "Object",
1126           "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>",
1127           "isOptional" : false
1128         }
1129       ],
1130       "returns" : [
1131       ]
1132     }
1133   ],
1134   "events" : [
1135     {
1136       "name" : "rowsrendered",
1137       "desc" : "Fires when all the  rows have been rendered",
1138       "memberOf" : "Roo.bootstrap.Table",
1139       "example" : "",
1140       "deprecated" : "",
1141       "since" : "",
1142       "see" : "",
1143       "params" : [
1144         {
1145           "name" : "this",
1146           "type" : "Roo.bootstrap.Table",
1147           "desc" : "",
1148           "isOptional" : false
1149         }
1150       ],
1151       "returns" : [
1152       ]
1153     },
1154     {
1155       "name" : "headercontextmenu",
1156       "desc" : "Fires when a header is right clicked",
1157       "memberOf" : "Roo.bootstrap.Table",
1158       "example" : "",
1159       "deprecated" : "",
1160       "since" : "",
1161       "see" : "",
1162       "params" : [
1163         {
1164           "name" : "this",
1165           "type" : "Roo.bootstrap.Table",
1166           "desc" : "",
1167           "isOptional" : false
1168         },
1169         {
1170           "name" : "columnIndex",
1171           "type" : "Number",
1172           "desc" : "",
1173           "isOptional" : false
1174         },
1175         {
1176           "name" : "e",
1177           "type" : "Roo.EventObject",
1178           "desc" : "",
1179           "isOptional" : false
1180         }
1181       ],
1182       "returns" : [
1183       ]
1184     },
1185     {
1186       "name" : "rowdblclick",
1187       "desc" : "Fires when a row is double clicked",
1188       "memberOf" : "Roo.bootstrap.Table",
1189       "example" : "",
1190       "deprecated" : "",
1191       "since" : "",
1192       "see" : "",
1193       "params" : [
1194         {
1195           "name" : "this",
1196           "type" : "Roo.bootstrap.Table",
1197           "desc" : "",
1198           "isOptional" : false
1199         },
1200         {
1201           "name" : "el",
1202           "type" : "Roo.Element",
1203           "desc" : "",
1204           "isOptional" : false
1205         },
1206         {
1207           "name" : "rowIndex",
1208           "type" : "Number",
1209           "desc" : "",
1210           "isOptional" : false
1211         },
1212         {
1213           "name" : "e",
1214           "type" : "Roo.EventObject",
1215           "desc" : "",
1216           "isOptional" : false
1217         }
1218       ],
1219       "returns" : [
1220       ]
1221     },
1222     {
1223       "name" : "contextmenu",
1224       "desc" : "The raw contextmenu event for the entire grid.",
1225       "memberOf" : "Roo.bootstrap.Table",
1226       "example" : "",
1227       "deprecated" : "",
1228       "since" : "",
1229       "see" : "",
1230       "params" : [
1231         {
1232           "name" : "e",
1233           "type" : "Roo.EventObject",
1234           "desc" : "",
1235           "isOptional" : false
1236         }
1237       ],
1238       "returns" : [
1239       ]
1240     },
1241     {
1242       "name" : "rowcontextmenu",
1243       "desc" : "Fires when a row is right clicked",
1244       "memberOf" : "Roo.bootstrap.Table",
1245       "example" : "",
1246       "deprecated" : "",
1247       "since" : "",
1248       "see" : "",
1249       "params" : [
1250         {
1251           "name" : "this",
1252           "type" : "Roo.bootstrap.Table",
1253           "desc" : "",
1254           "isOptional" : false
1255         },
1256         {
1257           "name" : "rowIndex",
1258           "type" : "Number",
1259           "desc" : "",
1260           "isOptional" : false
1261         },
1262         {
1263           "name" : "e",
1264           "type" : "Roo.EventObject",
1265           "desc" : "",
1266           "isOptional" : false
1267         }
1268       ],
1269       "returns" : [
1270       ]
1271     },
1272     {
1273       "name" : "cellcontextmenu",
1274       "desc" : "Fires when a cell is right clicked",
1275       "memberOf" : "Roo.bootstrap.Table",
1276       "example" : "",
1277       "deprecated" : "",
1278       "since" : "",
1279       "see" : "",
1280       "params" : [
1281         {
1282           "name" : "this",
1283           "type" : "Roo.bootstrap.Table",
1284           "desc" : "",
1285           "isOptional" : false
1286         },
1287         {
1288           "name" : "rowIndex",
1289           "type" : "Number",
1290           "desc" : "",
1291           "isOptional" : false
1292         },
1293         {
1294           "name" : "cellIndex",
1295           "type" : "Number",
1296           "desc" : "",
1297           "isOptional" : false
1298         },
1299         {
1300           "name" : "e",
1301           "type" : "Roo.EventObject",
1302           "desc" : "",
1303           "isOptional" : false
1304         }
1305       ],
1306       "returns" : [
1307       ]
1308     },
1309     {
1310       "name" : "celldblclick",
1311       "desc" : "Fires when a cell is double clicked",
1312       "memberOf" : "Roo.bootstrap.Table",
1313       "example" : "",
1314       "deprecated" : "",
1315       "since" : "",
1316       "see" : "",
1317       "params" : [
1318         {
1319           "name" : "this",
1320           "type" : "Roo.bootstrap.Table",
1321           "desc" : "",
1322           "isOptional" : false
1323         },
1324         {
1325           "name" : "el",
1326           "type" : "Roo.Element",
1327           "desc" : "",
1328           "isOptional" : false
1329         },
1330         {
1331           "name" : "rowIndex",
1332           "type" : "Number",
1333           "desc" : "",
1334           "isOptional" : false
1335         },
1336         {
1337           "name" : "columnIndex",
1338           "type" : "Number",
1339           "desc" : "",
1340           "isOptional" : false
1341         },
1342         {
1343           "name" : "e",
1344           "type" : "Roo.EventObject",
1345           "desc" : "",
1346           "isOptional" : false
1347         }
1348       ],
1349       "returns" : [
1350       ]
1351     },
1352     {
1353       "name" : "rowclass",
1354       "desc" : "Fires when a row is rendered, so you can change add a style to it.",
1355       "memberOf" : "Roo.bootstrap.Table",
1356       "example" : "",
1357       "deprecated" : "",
1358       "since" : "",
1359       "see" : "",
1360       "params" : [
1361         {
1362           "name" : "this",
1363           "type" : "Roo.bootstrap.Table",
1364           "desc" : "",
1365           "isOptional" : false
1366         },
1367         {
1368           "name" : "rowcfg",
1369           "type" : "Object",
1370           "desc" : "contains record  rowIndex colIndex and rowClass - set rowClass to add a style.",
1371           "isOptional" : false
1372         }
1373       ],
1374       "returns" : [
1375       ]
1376     },
1377     {
1378       "name" : "mouseover",
1379       "desc" : "Fires when a mouseover occur",
1380       "memberOf" : "Roo.bootstrap.Table",
1381       "example" : "",
1382       "deprecated" : "",
1383       "since" : "",
1384       "see" : "",
1385       "params" : [
1386         {
1387           "name" : "this",
1388           "type" : "Roo.bootstrap.Table",
1389           "desc" : "",
1390           "isOptional" : false
1391         },
1392         {
1393           "name" : "el",
1394           "type" : "Roo.Element",
1395           "desc" : "",
1396           "isOptional" : false
1397         },
1398         {
1399           "name" : "rowIndex",
1400           "type" : "Number",
1401           "desc" : "",
1402           "isOptional" : false
1403         },
1404         {
1405           "name" : "columnIndex",
1406           "type" : "Number",
1407           "desc" : "",
1408           "isOptional" : false
1409         },
1410         {
1411           "name" : "e",
1412           "type" : "Roo.EventObject",
1413           "desc" : "",
1414           "isOptional" : false
1415         }
1416       ],
1417       "returns" : [
1418       ]
1419     },
1420     {
1421       "name" : "mouseout",
1422       "desc" : "Fires when a mouseout occur",
1423       "memberOf" : "Roo.bootstrap.Table",
1424       "example" : "",
1425       "deprecated" : "",
1426       "since" : "",
1427       "see" : "",
1428       "params" : [
1429         {
1430           "name" : "this",
1431           "type" : "Roo.bootstrap.Table",
1432           "desc" : "",
1433           "isOptional" : false
1434         },
1435         {
1436           "name" : "el",
1437           "type" : "Roo.Element",
1438           "desc" : "",
1439           "isOptional" : false
1440         },
1441         {
1442           "name" : "rowIndex",
1443           "type" : "Number",
1444           "desc" : "",
1445           "isOptional" : false
1446         },
1447         {
1448           "name" : "columnIndex",
1449           "type" : "Number",
1450           "desc" : "",
1451           "isOptional" : false
1452         },
1453         {
1454           "name" : "e",
1455           "type" : "Roo.EventObject",
1456           "desc" : "",
1457           "isOptional" : false
1458         }
1459       ],
1460       "returns" : [
1461       ]
1462     },
1463     {
1464       "name" : "cellclick",
1465       "desc" : "Fires when a cell is clicked",
1466       "memberOf" : "Roo.bootstrap.Table",
1467       "example" : "",
1468       "deprecated" : "",
1469       "since" : "",
1470       "see" : "",
1471       "params" : [
1472         {
1473           "name" : "this",
1474           "type" : "Roo.bootstrap.Table",
1475           "desc" : "",
1476           "isOptional" : false
1477         },
1478         {
1479           "name" : "el",
1480           "type" : "Roo.Element",
1481           "desc" : "",
1482           "isOptional" : false
1483         },
1484         {
1485           "name" : "rowIndex",
1486           "type" : "Number",
1487           "desc" : "",
1488           "isOptional" : false
1489         },
1490         {
1491           "name" : "columnIndex",
1492           "type" : "Number",
1493           "desc" : "",
1494           "isOptional" : false
1495         },
1496         {
1497           "name" : "e",
1498           "type" : "Roo.EventObject",
1499           "desc" : "",
1500           "isOptional" : false
1501         }
1502       ],
1503       "returns" : [
1504       ]
1505     },
1506     {
1507       "name" : "rowclick",
1508       "desc" : "Fires when a row is clicked",
1509       "memberOf" : "Roo.bootstrap.Table",
1510       "example" : "",
1511       "deprecated" : "",
1512       "since" : "",
1513       "see" : "",
1514       "params" : [
1515         {
1516           "name" : "this",
1517           "type" : "Roo.bootstrap.Table",
1518           "desc" : "",
1519           "isOptional" : false
1520         },
1521         {
1522           "name" : "el",
1523           "type" : "Roo.Element",
1524           "desc" : "",
1525           "isOptional" : false
1526         },
1527         {
1528           "name" : "rowIndex",
1529           "type" : "Number",
1530           "desc" : "",
1531           "isOptional" : false
1532         },
1533         {
1534           "name" : "e",
1535           "type" : "Roo.EventObject",
1536           "desc" : "",
1537           "isOptional" : false
1538         }
1539       ],
1540       "returns" : [
1541       ]
1542     },
1543     {
1544       "name" : "childrenrendered",
1545       "desc" : "Fires when the children have been rendered..",
1546       "memberOf" : "Roo.bootstrap.Component",
1547       "example" : "",
1548       "deprecated" : "",
1549       "since" : "",
1550       "see" : "",
1551       "params" : [
1552         {
1553           "name" : "this",
1554           "type" : "Roo.bootstrap.Component",
1555           "desc" : "",
1556           "isOptional" : false
1557         }
1558       ],
1559       "returns" : [
1560       ]
1561     },
1562     {
1563       "name" : "beforerender",
1564       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1565       "memberOf" : "Roo.Component",
1566       "example" : "",
1567       "deprecated" : "",
1568       "since" : "",
1569       "see" : "",
1570       "params" : [
1571         {
1572           "name" : "this",
1573           "type" : "Roo.Component",
1574           "desc" : "",
1575           "isOptional" : false
1576         }
1577       ],
1578       "returns" : [
1579       ]
1580     },
1581     {
1582       "name" : "disable",
1583       "desc" : "Fires after the component is disabled.",
1584       "memberOf" : "Roo.Component",
1585       "example" : "",
1586       "deprecated" : "",
1587       "since" : "",
1588       "see" : "",
1589       "params" : [
1590         {
1591           "name" : "this",
1592           "type" : "Roo.Component",
1593           "desc" : "",
1594           "isOptional" : false
1595         }
1596       ],
1597       "returns" : [
1598       ]
1599     },
1600     {
1601       "name" : "render",
1602       "desc" : "Fires after the component is rendered.",
1603       "memberOf" : "Roo.Component",
1604       "example" : "",
1605       "deprecated" : "",
1606       "since" : "",
1607       "see" : "",
1608       "params" : [
1609         {
1610           "name" : "this",
1611           "type" : "Roo.Component",
1612           "desc" : "",
1613           "isOptional" : false
1614         }
1615       ],
1616       "returns" : [
1617       ]
1618     },
1619     {
1620       "name" : "destroy",
1621       "desc" : "Fires after the component is destroyed.",
1622       "memberOf" : "Roo.Component",
1623       "example" : "",
1624       "deprecated" : "",
1625       "since" : "",
1626       "see" : "",
1627       "params" : [
1628         {
1629           "name" : "this",
1630           "type" : "Roo.Component",
1631           "desc" : "",
1632           "isOptional" : false
1633         }
1634       ],
1635       "returns" : [
1636       ]
1637     },
1638     {
1639       "name" : "hide",
1640       "desc" : "Fires after the component is hidden.",
1641       "memberOf" : "Roo.Component",
1642       "example" : "",
1643       "deprecated" : "",
1644       "since" : "",
1645       "see" : "",
1646       "params" : [
1647         {
1648           "name" : "this",
1649           "type" : "Roo.Component",
1650           "desc" : "",
1651           "isOptional" : false
1652         }
1653       ],
1654       "returns" : [
1655       ]
1656     },
1657     {
1658       "name" : "beforehide",
1659       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1660       "memberOf" : "Roo.Component",
1661       "example" : "",
1662       "deprecated" : "",
1663       "since" : "",
1664       "see" : "",
1665       "params" : [
1666         {
1667           "name" : "this",
1668           "type" : "Roo.Component",
1669           "desc" : "",
1670           "isOptional" : false
1671         }
1672       ],
1673       "returns" : [
1674       ]
1675     },
1676     {
1677       "name" : "show",
1678       "desc" : "Fires after the component is shown.",
1679       "memberOf" : "Roo.Component",
1680       "example" : "",
1681       "deprecated" : "",
1682       "since" : "",
1683       "see" : "",
1684       "params" : [
1685         {
1686           "name" : "this",
1687           "type" : "Roo.Component",
1688           "desc" : "",
1689           "isOptional" : false
1690         }
1691       ],
1692       "returns" : [
1693       ]
1694     },
1695     {
1696       "name" : "beforeshow",
1697       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1698       "memberOf" : "Roo.Component",
1699       "example" : "",
1700       "deprecated" : "",
1701       "since" : "",
1702       "see" : "",
1703       "params" : [
1704         {
1705           "name" : "this",
1706           "type" : "Roo.Component",
1707           "desc" : "",
1708           "isOptional" : false
1709         }
1710       ],
1711       "returns" : [
1712       ]
1713     },
1714     {
1715       "name" : "enable",
1716       "desc" : "Fires after the component is enabled.",
1717       "memberOf" : "Roo.Component",
1718       "example" : "",
1719       "deprecated" : "",
1720       "since" : "",
1721       "see" : "",
1722       "params" : [
1723         {
1724           "name" : "this",
1725           "type" : "Roo.Component",
1726           "desc" : "",
1727           "isOptional" : false
1728         }
1729       ],
1730       "returns" : [
1731       ]
1732     },
1733     {
1734       "name" : "beforedestroy",
1735       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1736       "memberOf" : "Roo.Component",
1737       "example" : "",
1738       "deprecated" : "",
1739       "since" : "",
1740       "see" : "",
1741       "params" : [
1742         {
1743           "name" : "this",
1744           "type" : "Roo.Component",
1745           "desc" : "",
1746           "isOptional" : false
1747         }
1748       ],
1749       "returns" : [
1750       ]
1751     }
1752   ]
1753 }