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