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