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