8695b20d172ba4640bb40ec76b79a3ba0bee1342
[roojs1] / docs / symbols / Roo.bootstrap.Card.json
1 {
2   "name" : "Roo.bootstrap.Card",
3   "augments" : [
4     "Roo.bootstrap.Component",
5     "Roo.Component",
6     "Roo.util.Observable"
7   ],
8   "desc" : "Bootstrap Card class\n\n\npossible... may not be implemented..",
9   "isSingleton" : false,
10   "isStatic" : false,
11   "isBuiltin" : false,
12   "memberOf" : "Card",
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   "config" : [
27     {
28       "name" : "header_size",
29       "type" : "Number",
30       "desc" : "5) H1 or H2 etc.. 0 indicates default",
31       "memberOf" : "Roo.bootstrap.Card",
32       "optvals" : [
33         "0",
34         "1",
35         "2",
36         "3",
37         "4",
38         "5"
39       ]
40     },
41     {
42       "name" : "hideMode",
43       "type" : "String",
44       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
45       "memberOf" : "Roo.Component",
46       "optvals" : [
47         "display",
48         "visibility"
49       ]
50     },
51     {
52       "name" : "header_image",
53       "type" : "String",
54       "desc" : "src url of image.",
55       "memberOf" : "Roo.bootstrap.Card",
56       "optvals" : []
57     },
58     {
59       "name" : "margin_right",
60       "type" : "String",
61       "desc" : "o)",
62       "memberOf" : "Roo.bootstrap.Card",
63       "optvals" : [
64         "0",
65         "1",
66         "2",
67         "3",
68         "4",
69         "5",
70         "auto"
71       ]
72     },
73     {
74       "name" : "header",
75       "type" : "String|Object",
76       "desc" : "",
77       "memberOf" : "Roo.bootstrap.Card",
78       "optvals" : []
79     },
80     {
81       "name" : "title",
82       "type" : "String",
83       "desc" : "",
84       "memberOf" : "Roo.bootstrap.Card",
85       "optvals" : []
86     },
87     {
88       "name" : "xattr",
89       "type" : "Object",
90       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
91       "memberOf" : "Roo.bootstrap.Component",
92       "optvals" : []
93     },
94     {
95       "name" : "name",
96       "type" : "string",
97       "desc" : "Specifies name attribute",
98       "memberOf" : "Roo.bootstrap.Component",
99       "optvals" : []
100     },
101     {
102       "name" : "weight",
103       "type" : "String",
104       "desc" : "k)",
105       "memberOf" : "Roo.bootstrap.Card",
106       "optvals" : [
107         "primary",
108         "warning",
109         "info",
110         "danger",
111         "secondary",
112         "success",
113         "light",
114         "dark"
115       ]
116     },
117     {
118       "name" : "display",
119       "type" : "String",
120       "desc" : "x)",
121       "memberOf" : "Roo.bootstrap.Card",
122       "optvals" : [
123         "none",
124         "inline",
125         "inline-block",
126         "block",
127         "table",
128         "table-cell",
129         "table-row",
130         "flex",
131         "inline-flex"
132       ]
133     },
134     {
135       "name" : "margin_left",
136       "type" : "String",
137       "desc" : "o)",
138       "memberOf" : "Roo.bootstrap.Card",
139       "optvals" : [
140         "0",
141         "1",
142         "2",
143         "3",
144         "4",
145         "5",
146         "auto"
147       ]
148     },
149     {
150       "name" : "padding_top",
151       "type" : "String",
152       "desc" : "5)",
153       "memberOf" : "Roo.bootstrap.Card",
154       "optvals" : [
155         "0",
156         "1",
157         "2",
158         "3",
159         "4",
160         "5"
161       ]
162     },
163     {
164       "name" : "subtitle",
165       "type" : "String",
166       "desc" : "",
167       "memberOf" : "Roo.bootstrap.Card",
168       "optvals" : []
169     },
170     {
171       "name" : "tooltip",
172       "type" : "string",
173       "desc" : "Text for the tooltip",
174       "memberOf" : "Roo.bootstrap.Component",
175       "optvals" : []
176     },
177     {
178       "name" : "padding_right",
179       "type" : "String",
180       "desc" : "5)",
181       "memberOf" : "Roo.bootstrap.Card",
182       "optvals" : [
183         "0",
184         "1",
185         "2",
186         "3",
187         "4",
188         "5"
189       ]
190     },
191     {
192       "name" : "padding",
193       "type" : "String",
194       "desc" : "5)",
195       "memberOf" : "Roo.bootstrap.Card",
196       "optvals" : [
197         "0",
198         "1",
199         "2",
200         "3",
201         "4",
202         "5"
203       ]
204     },
205     {
206       "name" : "allowDomMove",
207       "type" : "Boolean",
208       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
209       "memberOf" : "Roo.Component",
210       "optvals" : []
211     },
212     {
213       "name" : "style",
214       "type" : "String",
215       "desc" : "any extra css",
216       "memberOf" : "Roo.bootstrap.Component",
217       "optvals" : []
218     },
219     {
220       "name" : "display_xl",
221       "type" : "String",
222       "desc" : "x)",
223       "memberOf" : "Roo.bootstrap.Card",
224       "optvals" : [
225         "none",
226         "inline",
227         "inline-block",
228         "block",
229         "table",
230         "table-cell",
231         "table-row",
232         "flex",
233         "inline-flex"
234       ]
235     },
236     {
237       "name" : "margin",
238       "type" : "String",
239       "desc" : "o)",
240       "memberOf" : "Roo.bootstrap.Card",
241       "optvals" : [
242         "0",
243         "1",
244         "2",
245         "3",
246         "4",
247         "5",
248         "auto"
249       ]
250     },
251     {
252       "name" : "actionMode",
253       "type" : "String",
254       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
255       "memberOf" : "Roo.Component",
256       "optvals" : []
257     },
258     {
259       "name" : "padding_bottom",
260       "type" : "String",
261       "desc" : "5)",
262       "memberOf" : "Roo.bootstrap.Card",
263       "optvals" : [
264         "0",
265         "1",
266         "2",
267         "3",
268         "4",
269         "5"
270       ]
271     },
272     {
273       "name" : "listeners",
274       "type" : "Object",
275       "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>",
276       "memberOf" : "Roo.util.Observable",
277       "optvals" : []
278     },
279     {
280       "name" : "container_method",
281       "type" : "string",
282       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
283       "memberOf" : "Roo.bootstrap.Component",
284       "optvals" : []
285     },
286     {
287       "name" : "display_lg",
288       "type" : "String",
289       "desc" : "x)",
290       "memberOf" : "Roo.bootstrap.Card",
291       "optvals" : [
292         "none",
293         "inline",
294         "inline-block",
295         "block",
296         "table",
297         "table-cell",
298         "table-row",
299         "flex",
300         "inline-flex"
301       ]
302     },
303     {
304       "name" : "footer",
305       "type" : "String",
306       "desc" : "",
307       "memberOf" : "Roo.bootstrap.Card",
308       "optvals" : []
309     },
310     {
311       "name" : "display_xs",
312       "type" : "String",
313       "desc" : "x)",
314       "memberOf" : "Roo.bootstrap.Card",
315       "optvals" : [
316         "none",
317         "inline",
318         "inline-block",
319         "block",
320         "table",
321         "table-cell",
322         "table-row",
323         "flex",
324         "inline-flex"
325       ]
326     },
327     {
328       "name" : "cls",
329       "type" : "String",
330       "desc" : "css class",
331       "memberOf" : "Roo.bootstrap.Component",
332       "optvals" : []
333     },
334     {
335       "name" : "can_build_overlaid",
336       "type" : "Boolean",
337       "desc" : "True if element can be rebuild from a HTML page",
338       "memberOf" : "Roo.bootstrap.Component",
339       "optvals" : []
340     },
341     {
342       "name" : "margin_bottom",
343       "type" : "String",
344       "desc" : "o)",
345       "memberOf" : "Roo.bootstrap.Card",
346       "optvals" : [
347         "0",
348         "1",
349         "2",
350         "3",
351         "4",
352         "5",
353         "auto"
354       ]
355     },
356     {
357       "name" : "disableClass",
358       "type" : "String",
359       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
360       "memberOf" : "Roo.Component",
361       "optvals" : []
362     },
363     {
364       "name" : "visibilityEl",
365       "type" : "string|object",
366       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
367       "memberOf" : "Roo.bootstrap.Component",
368       "optvals" : [
369         "el",
370         "parent"
371       ]
372     },
373     {
374       "name" : "margin_top",
375       "type" : "String",
376       "desc" : "o)",
377       "memberOf" : "Roo.bootstrap.Card",
378       "optvals" : [
379         "0",
380         "1",
381         "2",
382         "3",
383         "4",
384         "5",
385         "auto"
386       ]
387     },
388     {
389       "name" : "dataId",
390       "type" : "string",
391       "desc" : "cutomer id",
392       "memberOf" : "Roo.bootstrap.Component",
393       "optvals" : []
394     },
395     {
396       "name" : "padding_left",
397       "type" : "String",
398       "desc" : "5)",
399       "memberOf" : "Roo.bootstrap.Card",
400       "optvals" : [
401         "0",
402         "1",
403         "2",
404         "3",
405         "4",
406         "5"
407       ]
408     },
409     {
410       "name" : "margin_x",
411       "type" : "String",
412       "desc" : "o)",
413       "memberOf" : "Roo.bootstrap.Card",
414       "optvals" : [
415         "0",
416         "1",
417         "2",
418         "3",
419         "4",
420         "5",
421         "auto"
422       ]
423     },
424     {
425       "name" : "margin_y",
426       "type" : "String",
427       "desc" : "o)",
428       "memberOf" : "Roo.bootstrap.Card",
429       "optvals" : [
430         "0",
431         "1",
432         "2",
433         "3",
434         "4",
435         "5",
436         "auto"
437       ]
438     },
439     {
440       "name" : "html",
441       "type" : "String",
442       "desc" : "-- html contents - or just use children..",
443       "memberOf" : "Roo.bootstrap.Card",
444       "optvals" : []
445     },
446     {
447       "name" : "padding_x",
448       "type" : "String",
449       "desc" : "5)",
450       "memberOf" : "Roo.bootstrap.Card",
451       "optvals" : [
452         "0",
453         "1",
454         "2",
455         "3",
456         "4",
457         "5"
458       ]
459     },
460     {
461       "name" : "display_sm",
462       "type" : "String",
463       "desc" : "x)",
464       "memberOf" : "Roo.bootstrap.Card",
465       "optvals" : [
466         "none",
467         "inline",
468         "inline-block",
469         "block",
470         "table",
471         "table-cell",
472         "table-row",
473         "flex",
474         "inline-flex"
475       ]
476     },
477     {
478       "name" : "padding_y",
479       "type" : "String",
480       "desc" : "5)",
481       "memberOf" : "Roo.bootstrap.Card",
482       "optvals" : [
483         "0",
484         "1",
485         "2",
486         "3",
487         "4",
488         "5"
489       ]
490     }
491   ],
492   "methods" : [
493     {
494       "name" : "tooltipEl",
495       "desc" : "Fetch the element to display the tooltip on.",
496       "isStatic" : false,
497       "isConstructor" : false,
498       "isPrivate" : false,
499       "memberOf" : "Roo.bootstrap.Component",
500       "example" : "",
501       "deprecated" : "",
502       "since" : "",
503       "see" : "",
504       "params" : [],
505       "returns" : [
506         {
507           "name" : "",
508           "type" : "Roo.Element",
509           "desc" : "defaults to this.el"
510         }
511       ]
512     },
513     {
514       "name" : "hide",
515       "desc" : "Hide a component - adds 'hidden' class",
516       "isStatic" : false,
517       "isConstructor" : false,
518       "isPrivate" : false,
519       "memberOf" : "Roo.bootstrap.Component",
520       "example" : "",
521       "deprecated" : "",
522       "since" : "",
523       "see" : "",
524       "params" : [],
525       "returns" : []
526     },
527     {
528       "name" : "show",
529       "desc" : "Show a component - removes 'hidden' class",
530       "isStatic" : false,
531       "isConstructor" : false,
532       "isPrivate" : false,
533       "memberOf" : "Roo.bootstrap.Component",
534       "example" : "",
535       "deprecated" : "",
536       "since" : "",
537       "see" : "",
538       "params" : [],
539       "returns" : []
540     },
541     {
542       "name" : "setVisibilityEl",
543       "desc" : "Set the element that will be used to show or hide",
544       "isStatic" : false,
545       "isConstructor" : false,
546       "isPrivate" : false,
547       "memberOf" : "Roo.bootstrap.Component",
548       "example" : "",
549       "deprecated" : "",
550       "since" : "",
551       "see" : "",
552       "params" : [],
553       "returns" : []
554     },
555     {
556       "name" : "getVisibilityEl",
557       "desc" : "Get the element that will be used to show or hide",
558       "isStatic" : false,
559       "isConstructor" : false,
560       "isPrivate" : false,
561       "memberOf" : "Roo.bootstrap.Component",
562       "example" : "",
563       "deprecated" : "",
564       "since" : "",
565       "see" : "",
566       "params" : [],
567       "returns" : []
568     },
569     {
570       "name" : "initEvents",
571       "desc" : "Initialize Events for the element",
572       "isStatic" : false,
573       "isConstructor" : false,
574       "isPrivate" : false,
575       "memberOf" : "Roo.bootstrap.Component",
576       "example" : "",
577       "deprecated" : "",
578       "since" : "",
579       "see" : "",
580       "params" : [],
581       "returns" : []
582     },
583     {
584       "name" : "getChildContainer",
585       "desc" : "Fetch the element to add children to",
586       "isStatic" : false,
587       "isConstructor" : false,
588       "isPrivate" : false,
589       "memberOf" : "Roo.bootstrap.Component",
590       "example" : "",
591       "deprecated" : "",
592       "since" : "",
593       "see" : "",
594       "params" : [],
595       "returns" : [
596         {
597           "name" : "",
598           "type" : "Roo.Element",
599           "desc" : "defaults to this.el"
600         }
601       ]
602     },
603     {
604       "name" : "getId",
605       "desc" : "Returns the id of this component.",
606       "isStatic" : false,
607       "isConstructor" : false,
608       "isPrivate" : false,
609       "memberOf" : "Roo.Component",
610       "example" : "",
611       "deprecated" : "",
612       "since" : "",
613       "see" : "",
614       "params" : [],
615       "returns" : [
616         {
617           "name" : "",
618           "type" : "String",
619           "desc" : ""
620         }
621       ]
622     },
623     {
624       "name" : "render",
625       "desc" : "If this is a lazy rendering component, render it to its container element.",
626       "isStatic" : false,
627       "isConstructor" : false,
628       "isPrivate" : false,
629       "memberOf" : "Roo.Component",
630       "example" : "",
631       "deprecated" : "",
632       "since" : "",
633       "see" : "",
634       "params" : [
635         {
636           "name" : "container",
637           "type" : "String/HTMLElement/Element",
638           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
639           "isOptional" : false
640         }
641       ],
642       "returns" : []
643     },
644     {
645       "name" : "destroy",
646       "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}.",
647       "isStatic" : false,
648       "isConstructor" : false,
649       "isPrivate" : false,
650       "memberOf" : "Roo.Component",
651       "example" : "",
652       "deprecated" : "",
653       "since" : "",
654       "see" : "",
655       "params" : [],
656       "returns" : []
657     },
658     {
659       "name" : "isVisible",
660       "desc" : "Returns true if this component is visible.",
661       "isStatic" : false,
662       "isConstructor" : false,
663       "isPrivate" : false,
664       "memberOf" : "Roo.Component",
665       "example" : "",
666       "deprecated" : "",
667       "since" : "",
668       "see" : "",
669       "params" : [],
670       "returns" : []
671     },
672     {
673       "name" : "setDisabled",
674       "desc" : "Convenience function for setting disabled/enabled by boolean.",
675       "isStatic" : false,
676       "isConstructor" : false,
677       "isPrivate" : false,
678       "memberOf" : "Roo.Component",
679       "example" : "",
680       "deprecated" : "",
681       "since" : "",
682       "see" : "",
683       "params" : [
684         {
685           "name" : "disabled",
686           "type" : "Boolean",
687           "desc" : "",
688           "isOptional" : false
689         }
690       ],
691       "returns" : []
692     },
693     {
694       "name" : "focus",
695       "desc" : "Try to focus this component.",
696       "isStatic" : false,
697       "isConstructor" : false,
698       "isPrivate" : false,
699       "memberOf" : "Roo.Component",
700       "example" : "",
701       "deprecated" : "",
702       "since" : "",
703       "see" : "",
704       "params" : [
705         {
706           "name" : "selectText",
707           "type" : "Boolean",
708           "desc" : "True to also select the text in this component (if applicable)",
709           "isOptional" : false
710         }
711       ],
712       "returns" : [
713         {
714           "name" : "",
715           "type" : "Roo.Component",
716           "desc" : "this"
717         }
718       ]
719     },
720     {
721       "name" : "enable",
722       "desc" : "Enable this component.",
723       "isStatic" : false,
724       "isConstructor" : false,
725       "isPrivate" : false,
726       "memberOf" : "Roo.Component",
727       "example" : "",
728       "deprecated" : "",
729       "since" : "",
730       "see" : "",
731       "params" : [],
732       "returns" : [
733         {
734           "name" : "",
735           "type" : "Roo.Component",
736           "desc" : "this"
737         }
738       ]
739     },
740     {
741       "name" : "setVisible",
742       "desc" : "Convenience function to hide or show this component by boolean.",
743       "isStatic" : false,
744       "isConstructor" : false,
745       "isPrivate" : false,
746       "memberOf" : "Roo.Component",
747       "example" : "",
748       "deprecated" : "",
749       "since" : "",
750       "see" : "",
751       "params" : [
752         {
753           "name" : "visible",
754           "type" : "Boolean",
755           "desc" : "True to show, false to hide",
756           "isOptional" : false
757         }
758       ],
759       "returns" : [
760         {
761           "name" : "",
762           "type" : "Roo.Component",
763           "desc" : "this"
764         }
765       ]
766     },
767     {
768       "name" : "disable",
769       "desc" : "Disable this component.",
770       "isStatic" : false,
771       "isConstructor" : false,
772       "isPrivate" : false,
773       "memberOf" : "Roo.Component",
774       "example" : "",
775       "deprecated" : "",
776       "since" : "",
777       "see" : "",
778       "params" : [],
779       "returns" : [
780         {
781           "name" : "",
782           "type" : "Roo.Component",
783           "desc" : "this"
784         }
785       ]
786     },
787     {
788       "name" : "getEl",
789       "desc" : "Returns the underlying {@link Roo.Element}.",
790       "isStatic" : false,
791       "isConstructor" : false,
792       "isPrivate" : false,
793       "memberOf" : "Roo.Component",
794       "example" : "",
795       "deprecated" : "",
796       "since" : "",
797       "see" : "",
798       "params" : [],
799       "returns" : [
800         {
801           "name" : "",
802           "type" : "Roo.Element",
803           "desc" : "The element"
804         }
805       ]
806     },
807     {
808       "name" : "purgeListeners",
809       "desc" : "Removes all listeners for this object",
810       "isStatic" : false,
811       "isConstructor" : false,
812       "isPrivate" : false,
813       "memberOf" : "Roo.util.Observable",
814       "example" : "",
815       "deprecated" : "",
816       "since" : "",
817       "see" : "",
818       "params" : [],
819       "returns" : []
820     },
821     {
822       "name" : "on",
823       "desc" : "Appends an event handler to this element (shorthand for addListener)",
824       "isStatic" : false,
825       "isConstructor" : false,
826       "isPrivate" : false,
827       "memberOf" : "Roo.util.Observable",
828       "example" : "",
829       "deprecated" : "",
830       "since" : "",
831       "see" : "",
832       "params" : [
833         {
834           "name" : "eventName",
835           "type" : "String",
836           "desc" : "The type of event to listen for",
837           "isOptional" : false
838         },
839         {
840           "name" : "handler",
841           "type" : "Function",
842           "desc" : "The method the event invokes",
843           "isOptional" : false
844         },
845         {
846           "name" : "scope",
847           "type" : "Object",
848           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
849           "isOptional" : false
850         },
851         {
852           "name" : "options",
853           "type" : "Object",
854           "desc" : "(optional)",
855           "isOptional" : false
856         }
857       ],
858       "returns" : []
859     },
860     {
861       "name" : "un",
862       "desc" : "Removes a listener (shorthand for removeListener)",
863       "isStatic" : false,
864       "isConstructor" : false,
865       "isPrivate" : false,
866       "memberOf" : "Roo.util.Observable",
867       "example" : "",
868       "deprecated" : "",
869       "since" : "",
870       "see" : "",
871       "params" : [
872         {
873           "name" : "eventName",
874           "type" : "String",
875           "desc" : "The type of event to listen for",
876           "isOptional" : false
877         },
878         {
879           "name" : "handler",
880           "type" : "Function",
881           "desc" : "The handler to remove",
882           "isOptional" : false
883         },
884         {
885           "name" : "scope",
886           "type" : "Object",
887           "desc" : "(optional) The scope (this object) for the handler",
888           "isOptional" : false
889         }
890       ],
891       "returns" : []
892     },
893     {
894       "name" : "addEvents",
895       "desc" : "Used to define events on this Observable",
896       "isStatic" : false,
897       "isConstructor" : false,
898       "isPrivate" : false,
899       "memberOf" : "Roo.util.Observable",
900       "example" : "",
901       "deprecated" : "",
902       "since" : "",
903       "see" : "",
904       "params" : [
905         {
906           "name" : "object",
907           "type" : "Object",
908           "desc" : "The object with the events defined",
909           "isOptional" : false
910         }
911       ],
912       "returns" : []
913     },
914     {
915       "name" : "releaseCapture",
916       "desc" : "Removes <b>all</b> added captures from the Observable.",
917       "isStatic" : true,
918       "isConstructor" : false,
919       "isPrivate" : false,
920       "memberOf" : "Roo.util.Observable",
921       "example" : "",
922       "deprecated" : "",
923       "since" : "",
924       "see" : "",
925       "params" : [
926         {
927           "name" : "o",
928           "type" : "Observable",
929           "desc" : "The Observable to release",
930           "isOptional" : false
931         }
932       ],
933       "returns" : []
934     },
935     {
936       "name" : "removeListener",
937       "desc" : "Removes a listener",
938       "isStatic" : false,
939       "isConstructor" : false,
940       "isPrivate" : false,
941       "memberOf" : "Roo.util.Observable",
942       "example" : "",
943       "deprecated" : "",
944       "since" : "",
945       "see" : "",
946       "params" : [
947         {
948           "name" : "eventName",
949           "type" : "String",
950           "desc" : "The type of event to listen for",
951           "isOptional" : false
952         },
953         {
954           "name" : "handler",
955           "type" : "Function",
956           "desc" : "The handler to remove",
957           "isOptional" : false
958         },
959         {
960           "name" : "scope",
961           "type" : "Object",
962           "desc" : "(optional) The scope (this object) for the handler",
963           "isOptional" : false
964         }
965       ],
966       "returns" : []
967     },
968     {
969       "name" : "fireEvent",
970       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
971       "isStatic" : false,
972       "isConstructor" : false,
973       "isPrivate" : false,
974       "memberOf" : "Roo.util.Observable",
975       "example" : "",
976       "deprecated" : "",
977       "since" : "",
978       "see" : "",
979       "params" : [
980         {
981           "name" : "eventName",
982           "type" : "String",
983           "desc" : "",
984           "isOptional" : false
985         },
986         {
987           "name" : "args",
988           "type" : "Object...",
989           "desc" : "Variable number of parameters are passed to handlers",
990           "isOptional" : false
991         }
992       ],
993       "returns" : [
994         {
995           "name" : "",
996           "type" : "Boolean",
997           "desc" : "returns false if any of the handlers return false otherwise it returns true"
998         }
999       ]
1000     },
1001     {
1002       "name" : "hasListener",
1003       "desc" : "Checks to see if this object has any listeners for a specified event",
1004       "isStatic" : false,
1005       "isConstructor" : false,
1006       "isPrivate" : false,
1007       "memberOf" : "Roo.util.Observable",
1008       "example" : "",
1009       "deprecated" : "",
1010       "since" : "",
1011       "see" : "",
1012       "params" : [
1013         {
1014           "name" : "eventName",
1015           "type" : "String",
1016           "desc" : "The name of the event to check for",
1017           "isOptional" : false
1018         }
1019       ],
1020       "returns" : [
1021         {
1022           "name" : "",
1023           "type" : "Boolean",
1024           "desc" : "True if the event is being listened for, else false"
1025         }
1026       ]
1027     },
1028     {
1029       "name" : "capture",
1030       "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.",
1031       "isStatic" : true,
1032       "isConstructor" : false,
1033       "isPrivate" : false,
1034       "memberOf" : "Roo.util.Observable",
1035       "example" : "",
1036       "deprecated" : "",
1037       "since" : "",
1038       "see" : "",
1039       "params" : [
1040         {
1041           "name" : "o",
1042           "type" : "Observable",
1043           "desc" : "The Observable to capture",
1044           "isOptional" : false
1045         },
1046         {
1047           "name" : "fn",
1048           "type" : "Function",
1049           "desc" : "The function to call",
1050           "isOptional" : false
1051         },
1052         {
1053           "name" : "scope",
1054           "type" : "Object",
1055           "desc" : "(optional) The scope (this object) for the fn",
1056           "isOptional" : false
1057         }
1058       ],
1059       "returns" : []
1060     },
1061     {
1062       "name" : "addListener",
1063       "desc" : "Appends an event handler to this component",
1064       "isStatic" : false,
1065       "isConstructor" : false,
1066       "isPrivate" : false,
1067       "memberOf" : "Roo.util.Observable",
1068       "example" : "",
1069       "deprecated" : "",
1070       "since" : "",
1071       "see" : "",
1072       "params" : [
1073         {
1074           "name" : "eventName",
1075           "type" : "String",
1076           "desc" : "The type of event to listen for",
1077           "isOptional" : false
1078         },
1079         {
1080           "name" : "handler",
1081           "type" : "Function",
1082           "desc" : "The method the event invokes",
1083           "isOptional" : false
1084         },
1085         {
1086           "name" : "scope",
1087           "type" : "Object",
1088           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1089           "isOptional" : false
1090         },
1091         {
1092           "name" : "options",
1093           "type" : "Object",
1094           "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>",
1095           "isOptional" : false
1096         }
1097       ],
1098       "returns" : []
1099     }
1100   ],
1101   "events" : [
1102     {
1103       "name" : "childrenrendered",
1104       "desc" : "Fires when the children have been rendered..",
1105       "memberOf" : "Roo.bootstrap.Component",
1106       "example" : "",
1107       "deprecated" : "",
1108       "since" : "",
1109       "see" : "",
1110       "params" : [
1111         {
1112           "name" : "this",
1113           "type" : "Roo.bootstrap.Component",
1114           "desc" : "",
1115           "isOptional" : false
1116         }
1117       ],
1118       "returns" : []
1119     },
1120     {
1121       "name" : "beforerender",
1122       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1123       "memberOf" : "Roo.Component",
1124       "example" : "",
1125       "deprecated" : "",
1126       "since" : "",
1127       "see" : "",
1128       "params" : [
1129         {
1130           "name" : "this",
1131           "type" : "Roo.Component",
1132           "desc" : "",
1133           "isOptional" : false
1134         }
1135       ],
1136       "returns" : []
1137     },
1138     {
1139       "name" : "disable",
1140       "desc" : "Fires after the component is disabled.",
1141       "memberOf" : "Roo.Component",
1142       "example" : "",
1143       "deprecated" : "",
1144       "since" : "",
1145       "see" : "",
1146       "params" : [
1147         {
1148           "name" : "this",
1149           "type" : "Roo.Component",
1150           "desc" : "",
1151           "isOptional" : false
1152         }
1153       ],
1154       "returns" : []
1155     },
1156     {
1157       "name" : "render",
1158       "desc" : "Fires after the component is rendered.",
1159       "memberOf" : "Roo.Component",
1160       "example" : "",
1161       "deprecated" : "",
1162       "since" : "",
1163       "see" : "",
1164       "params" : [
1165         {
1166           "name" : "this",
1167           "type" : "Roo.Component",
1168           "desc" : "",
1169           "isOptional" : false
1170         }
1171       ],
1172       "returns" : []
1173     },
1174     {
1175       "name" : "destroy",
1176       "desc" : "Fires after the component is destroyed.",
1177       "memberOf" : "Roo.Component",
1178       "example" : "",
1179       "deprecated" : "",
1180       "since" : "",
1181       "see" : "",
1182       "params" : [
1183         {
1184           "name" : "this",
1185           "type" : "Roo.Component",
1186           "desc" : "",
1187           "isOptional" : false
1188         }
1189       ],
1190       "returns" : []
1191     },
1192     {
1193       "name" : "hide",
1194       "desc" : "Fires after the component is hidden.",
1195       "memberOf" : "Roo.Component",
1196       "example" : "",
1197       "deprecated" : "",
1198       "since" : "",
1199       "see" : "",
1200       "params" : [
1201         {
1202           "name" : "this",
1203           "type" : "Roo.Component",
1204           "desc" : "",
1205           "isOptional" : false
1206         }
1207       ],
1208       "returns" : []
1209     },
1210     {
1211       "name" : "beforehide",
1212       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1213       "memberOf" : "Roo.Component",
1214       "example" : "",
1215       "deprecated" : "",
1216       "since" : "",
1217       "see" : "",
1218       "params" : [
1219         {
1220           "name" : "this",
1221           "type" : "Roo.Component",
1222           "desc" : "",
1223           "isOptional" : false
1224         }
1225       ],
1226       "returns" : []
1227     },
1228     {
1229       "name" : "show",
1230       "desc" : "Fires after the component is shown.",
1231       "memberOf" : "Roo.Component",
1232       "example" : "",
1233       "deprecated" : "",
1234       "since" : "",
1235       "see" : "",
1236       "params" : [
1237         {
1238           "name" : "this",
1239           "type" : "Roo.Component",
1240           "desc" : "",
1241           "isOptional" : false
1242         }
1243       ],
1244       "returns" : []
1245     },
1246     {
1247       "name" : "beforeshow",
1248       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1249       "memberOf" : "Roo.Component",
1250       "example" : "",
1251       "deprecated" : "",
1252       "since" : "",
1253       "see" : "",
1254       "params" : [
1255         {
1256           "name" : "this",
1257           "type" : "Roo.Component",
1258           "desc" : "",
1259           "isOptional" : false
1260         }
1261       ],
1262       "returns" : []
1263     },
1264     {
1265       "name" : "enable",
1266       "desc" : "Fires after the component is enabled.",
1267       "memberOf" : "Roo.Component",
1268       "example" : "",
1269       "deprecated" : "",
1270       "since" : "",
1271       "see" : "",
1272       "params" : [
1273         {
1274           "name" : "this",
1275           "type" : "Roo.Component",
1276           "desc" : "",
1277           "isOptional" : false
1278         }
1279       ],
1280       "returns" : []
1281     },
1282     {
1283       "name" : "beforedestroy",
1284       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1285       "memberOf" : "Roo.Component",
1286       "example" : "",
1287       "deprecated" : "",
1288       "since" : "",
1289       "see" : "",
1290       "params" : [
1291         {
1292           "name" : "this",
1293           "type" : "Roo.Component",
1294           "desc" : "",
1295           "isOptional" : false
1296         }
1297       ],
1298       "returns" : []
1299     }
1300   ]
1301 }