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