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