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