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