fix docs add optvalues
[roojs1] / docs / symbols / Roo.bootstrap.form.CardUploader.json
1 {
2   "name" : "Roo.bootstrap.form.CardUploader",
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 Card Uploader class - it's a button which when you add files to it, adds cards below with preview and the name...",
13   "isSingleton" : false,
14   "isStatic" : false,
15   "isBuiltin" : false,
16   "isAbstract" : false,
17   "isBuilderTop" : false,
18   "memberOf" : "CardUploader",
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" : "visibilityEl",
307       "type" : "string|object",
308       "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
309       "memberOf" : "Roo.bootstrap.Component",
310       "isOptional" : false,
311       "optvalues" : [
312         "el",
313         "parent"
314       ]
315     },
316     {
317       "name" : "href",
318       "type" : "String",
319       "desc" : "empty or href",
320       "memberOf" : "Roo.bootstrap.Button",
321       "isOptional" : false,
322       "optvalues" : []
323     },
324     {
325       "name" : "tag",
326       "type" : "String",
327       "desc" : "",
328       "memberOf" : "Roo.bootstrap.Button",
329       "isOptional" : false,
330       "optvalues" : [
331         "a",
332         "input",
333         "submit"
334       ]
335     },
336     {
337       "name" : "dataId",
338       "type" : "string",
339       "desc" : "cutomer id",
340       "memberOf" : "Roo.bootstrap.Component",
341       "isOptional" : false,
342       "optvalues" : []
343     },
344     {
345       "name" : "outline",
346       "type" : "Boolean",
347       "desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
348       "memberOf" : "Roo.bootstrap.Button",
349       "isOptional" : false,
350       "optvalues" : []
351     },
352     {
353       "name" : "offtext",
354       "type" : "String",
355       "desc" : "text for off slidy toggle state",
356       "memberOf" : "Roo.bootstrap.Button",
357       "isOptional" : false,
358       "optvalues" : []
359     },
360     {
361       "name" : "removeClass",
362       "type" : "Boolean",
363       "desc" : "remove the standard class..",
364       "memberOf" : "Roo.bootstrap.Button",
365       "isOptional" : false,
366       "optvalues" : []
367     },
368     {
369       "name" : "html",
370       "type" : "Array",
371       "desc" : "The button text.",
372       "memberOf" : "",
373       "isOptional" : false,
374       "optvalues" : []
375     },
376     {
377       "name" : "pressed",
378       "type" : "Boolean",
379       "desc" : "default null - if the button ahs active state",
380       "memberOf" : "Roo.bootstrap.Button",
381       "isOptional" : false,
382       "optvalues" : []
383     },
384     {
385       "name" : "menu",
386       "type" : "Roo.bootstrap.menu.Menu",
387       "desc" : "a Menu",
388       "memberOf" : "Roo.bootstrap.Button",
389       "isOptional" : false,
390       "optvalues" : []
391     }
392   ],
393   "methods" : [
394     {
395       "name" : "addCard",
396       "type" : "function",
397       "desc" : "addCard - add an Attachment to the uploader",
398       "sig" : "(data)",
399       "static" : false,
400       "memberOf" : "",
401       "isStatic" : false,
402       "isConstructor" : false,
403       "isPrivate" : false,
404       "example" : "",
405       "deprecated" : "",
406       "since" : "",
407       "see" : "",
408       "exceptions" : "",
409       "requires" : "",
410       "params" : [
411         {
412           "name" : "data",
413           "type" : "",
414           "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        }",
415           "isOptional" : false
416         }
417       ],
418       "returns" : []
419     },
420     {
421       "name" : "setText",
422       "type" : "function",
423       "desc" : "set the text of the first selected button",
424       "sig" : "()\n{\n\n}",
425       "static" : false,
426       "memberOf" : "Roo.bootstrap.Button",
427       "isStatic" : false,
428       "isConstructor" : false,
429       "isPrivate" : false,
430       "example" : "",
431       "deprecated" : "",
432       "since" : "",
433       "see" : "",
434       "exceptions" : "",
435       "requires" : "",
436       "params" : [],
437       "returns" : []
438     },
439     {
440       "name" : "isActive",
441       "type" : "function",
442       "desc" : "get the current active state",
443       "sig" : "()\n{\n\n}",
444       "static" : false,
445       "memberOf" : "Roo.bootstrap.Button",
446       "isStatic" : false,
447       "isConstructor" : false,
448       "isPrivate" : false,
449       "example" : "",
450       "deprecated" : "",
451       "since" : "",
452       "see" : "",
453       "exceptions" : "",
454       "requires" : "",
455       "params" : [],
456       "returns" : [
457         {
458           "name" : "",
459           "type" : "boolean",
460           "desc" : "true if it's active"
461         }
462       ]
463     },
464     {
465       "name" : "setActive",
466       "type" : "function",
467       "desc" : "sets the active state on/off,",
468       "sig" : "(state)",
469       "static" : false,
470       "memberOf" : "Roo.bootstrap.Button",
471       "isStatic" : false,
472       "isConstructor" : false,
473       "isPrivate" : false,
474       "example" : "",
475       "deprecated" : "",
476       "since" : "",
477       "see" : "",
478       "exceptions" : "",
479       "requires" : "",
480       "params" : [
481         {
482           "name" : "state",
483           "type" : "Boolean",
484           "desc" : "(optional) Force a particular state",
485           "isOptional" : false
486         }
487       ],
488       "returns" : []
489     },
490     {
491       "name" : "toggleActive",
492       "type" : "function",
493       "desc" : "toggles the current active state",
494       "sig" : "()\n{\n\n}",
495       "static" : false,
496       "memberOf" : "Roo.bootstrap.Button",
497       "isStatic" : false,
498       "isConstructor" : false,
499       "isPrivate" : false,
500       "example" : "",
501       "deprecated" : "",
502       "since" : "",
503       "see" : "",
504       "exceptions" : "",
505       "requires" : "",
506       "params" : [],
507       "returns" : []
508     },
509     {
510       "name" : "getText",
511       "type" : "function",
512       "desc" : "get the text of the first selected button",
513       "sig" : "()\n{\n\n}",
514       "static" : false,
515       "memberOf" : "Roo.bootstrap.Button",
516       "isStatic" : false,
517       "isConstructor" : false,
518       "isPrivate" : false,
519       "example" : "",
520       "deprecated" : "",
521       "since" : "",
522       "see" : "",
523       "exceptions" : "",
524       "requires" : "",
525       "params" : [],
526       "returns" : []
527     },
528     {
529       "name" : "enable",
530       "type" : "function",
531       "desc" : "Enables this button",
532       "sig" : "()\n{\n\n}",
533       "static" : false,
534       "memberOf" : "Roo.bootstrap.Button",
535       "isStatic" : false,
536       "isConstructor" : false,
537       "isPrivate" : false,
538       "example" : "",
539       "deprecated" : "",
540       "since" : "",
541       "see" : "",
542       "exceptions" : "",
543       "requires" : "",
544       "params" : [],
545       "returns" : []
546     },
547     {
548       "name" : "disable",
549       "type" : "function",
550       "desc" : "Disable this button",
551       "sig" : "()\n{\n\n}",
552       "static" : false,
553       "memberOf" : "Roo.bootstrap.Button",
554       "isStatic" : false,
555       "isConstructor" : false,
556       "isPrivate" : false,
557       "example" : "",
558       "deprecated" : "",
559       "since" : "",
560       "see" : "",
561       "exceptions" : "",
562       "requires" : "",
563       "params" : [],
564       "returns" : []
565     },
566     {
567       "name" : "tooltipEl",
568       "type" : "function",
569       "desc" : "Fetch the element to display the tooltip on.",
570       "sig" : "()\n{\n\n}",
571       "static" : false,
572       "memberOf" : "Roo.bootstrap.Component",
573       "isStatic" : false,
574       "isConstructor" : false,
575       "isPrivate" : false,
576       "example" : "",
577       "deprecated" : "",
578       "since" : "",
579       "see" : "",
580       "exceptions" : "",
581       "requires" : "",
582       "params" : [],
583       "returns" : [
584         {
585           "name" : "",
586           "type" : "Roo.Element",
587           "desc" : "defaults to this.el"
588         }
589       ]
590     },
591     {
592       "name" : "hide",
593       "type" : "function",
594       "desc" : "Hide a component - adds 'hidden' class",
595       "sig" : "()\n{\n\n}",
596       "static" : false,
597       "memberOf" : "Roo.bootstrap.Component",
598       "isStatic" : false,
599       "isConstructor" : false,
600       "isPrivate" : false,
601       "example" : "",
602       "deprecated" : "",
603       "since" : "",
604       "see" : "",
605       "exceptions" : "",
606       "requires" : "",
607       "params" : [],
608       "returns" : []
609     },
610     {
611       "name" : "show",
612       "type" : "function",
613       "desc" : "Show a component - removes 'hidden' class",
614       "sig" : "()\n{\n\n}",
615       "static" : false,
616       "memberOf" : "Roo.bootstrap.Component",
617       "isStatic" : false,
618       "isConstructor" : false,
619       "isPrivate" : false,
620       "example" : "",
621       "deprecated" : "",
622       "since" : "",
623       "see" : "",
624       "exceptions" : "",
625       "requires" : "",
626       "params" : [],
627       "returns" : []
628     },
629     {
630       "name" : "setVisibilityEl",
631       "type" : "function",
632       "desc" : "Set the element that will be used to show or hide",
633       "sig" : "()\n{\n\n}",
634       "static" : false,
635       "memberOf" : "Roo.bootstrap.Component",
636       "isStatic" : false,
637       "isConstructor" : false,
638       "isPrivate" : false,
639       "example" : "",
640       "deprecated" : "",
641       "since" : "",
642       "see" : "",
643       "exceptions" : "",
644       "requires" : "",
645       "params" : [],
646       "returns" : []
647     },
648     {
649       "name" : "getVisibilityEl",
650       "type" : "function",
651       "desc" : "Get the element that will be used to show or hide",
652       "sig" : "()\n{\n\n}",
653       "static" : false,
654       "memberOf" : "Roo.bootstrap.Component",
655       "isStatic" : false,
656       "isConstructor" : false,
657       "isPrivate" : false,
658       "example" : "",
659       "deprecated" : "",
660       "since" : "",
661       "see" : "",
662       "exceptions" : "",
663       "requires" : "",
664       "params" : [],
665       "returns" : []
666     },
667     {
668       "name" : "initEvents",
669       "type" : "function",
670       "desc" : "Initialize Events for the element",
671       "sig" : "()\n{\n\n}",
672       "static" : false,
673       "memberOf" : "Roo.bootstrap.Component",
674       "isStatic" : false,
675       "isConstructor" : false,
676       "isPrivate" : false,
677       "example" : "",
678       "deprecated" : "",
679       "since" : "",
680       "see" : "",
681       "exceptions" : "",
682       "requires" : "",
683       "params" : [],
684       "returns" : []
685     },
686     {
687       "name" : "getChildContainer",
688       "type" : "function",
689       "desc" : "Fetch the element to add children to",
690       "sig" : "()\n{\n\n}",
691       "static" : false,
692       "memberOf" : "Roo.bootstrap.Component",
693       "isStatic" : false,
694       "isConstructor" : false,
695       "isPrivate" : false,
696       "example" : "",
697       "deprecated" : "",
698       "since" : "",
699       "see" : "",
700       "exceptions" : "",
701       "requires" : "",
702       "params" : [],
703       "returns" : [
704         {
705           "name" : "",
706           "type" : "Roo.Element",
707           "desc" : "defaults to this.el"
708         }
709       ]
710     },
711     {
712       "name" : "getId",
713       "type" : "function",
714       "desc" : "Returns the id of this component.",
715       "sig" : "()\n{\n\n}",
716       "static" : false,
717       "memberOf" : "Roo.Component",
718       "isStatic" : false,
719       "isConstructor" : false,
720       "isPrivate" : false,
721       "example" : "",
722       "deprecated" : "",
723       "since" : "",
724       "see" : "",
725       "exceptions" : "",
726       "requires" : "",
727       "params" : [],
728       "returns" : [
729         {
730           "name" : "",
731           "type" : "String",
732           "desc" : ""
733         }
734       ]
735     },
736     {
737       "name" : "render",
738       "type" : "function",
739       "desc" : "If this is a lazy rendering component, render it to its container element.",
740       "sig" : "(container)",
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" : "container",
755           "type" : "String/HTMLElement/Element",
756           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
757           "isOptional" : false
758         }
759       ],
760       "returns" : []
761     },
762     {
763       "name" : "destroy",
764       "type" : "function",
765       "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}.",
766       "sig" : "()\n{\n\n}",
767       "static" : false,
768       "memberOf" : "Roo.Component",
769       "isStatic" : false,
770       "isConstructor" : false,
771       "isPrivate" : false,
772       "example" : "",
773       "deprecated" : "",
774       "since" : "",
775       "see" : "",
776       "exceptions" : "",
777       "requires" : "",
778       "params" : [],
779       "returns" : []
780     },
781     {
782       "name" : "isVisible",
783       "type" : "function",
784       "desc" : "Returns true if this component is visible.",
785       "sig" : "()\n{\n\n}",
786       "static" : false,
787       "memberOf" : "Roo.Component",
788       "isStatic" : false,
789       "isConstructor" : false,
790       "isPrivate" : false,
791       "example" : "",
792       "deprecated" : "",
793       "since" : "",
794       "see" : "",
795       "exceptions" : "",
796       "requires" : "",
797       "params" : [],
798       "returns" : []
799     },
800     {
801       "name" : "setDisabled",
802       "type" : "function",
803       "desc" : "Convenience function for setting disabled/enabled by boolean.",
804       "sig" : "(disabled)",
805       "static" : false,
806       "memberOf" : "Roo.Component",
807       "isStatic" : false,
808       "isConstructor" : false,
809       "isPrivate" : false,
810       "example" : "",
811       "deprecated" : "",
812       "since" : "",
813       "see" : "",
814       "exceptions" : "",
815       "requires" : "",
816       "params" : [
817         {
818           "name" : "disabled",
819           "type" : "Boolean",
820           "desc" : "",
821           "isOptional" : false
822         }
823       ],
824       "returns" : []
825     },
826     {
827       "name" : "focus",
828       "type" : "function",
829       "desc" : "Try to focus this component.",
830       "sig" : "(selectText)",
831       "static" : false,
832       "memberOf" : "Roo.Component",
833       "isStatic" : false,
834       "isConstructor" : false,
835       "isPrivate" : false,
836       "example" : "",
837       "deprecated" : "",
838       "since" : "",
839       "see" : "",
840       "exceptions" : "",
841       "requires" : "",
842       "params" : [
843         {
844           "name" : "selectText",
845           "type" : "Boolean",
846           "desc" : "True to also select the text in this component (if applicable)",
847           "isOptional" : false
848         }
849       ],
850       "returns" : [
851         {
852           "name" : "",
853           "type" : "Roo.Component",
854           "desc" : "this"
855         }
856       ]
857     },
858     {
859       "name" : "setVisible",
860       "type" : "function",
861       "desc" : "Convenience function to hide or show this component by boolean.",
862       "sig" : "(visible)",
863       "static" : false,
864       "memberOf" : "Roo.Component",
865       "isStatic" : false,
866       "isConstructor" : false,
867       "isPrivate" : false,
868       "example" : "",
869       "deprecated" : "",
870       "since" : "",
871       "see" : "",
872       "exceptions" : "",
873       "requires" : "",
874       "params" : [
875         {
876           "name" : "visible",
877           "type" : "Boolean",
878           "desc" : "True to show, false to hide",
879           "isOptional" : false
880         }
881       ],
882       "returns" : [
883         {
884           "name" : "",
885           "type" : "Roo.Component",
886           "desc" : "this"
887         }
888       ]
889     },
890     {
891       "name" : "getEl",
892       "type" : "function",
893       "desc" : "Returns the underlying {@link Roo.Element}.",
894       "sig" : "()\n{\n\n}",
895       "static" : false,
896       "memberOf" : "Roo.Component",
897       "isStatic" : false,
898       "isConstructor" : false,
899       "isPrivate" : false,
900       "example" : "",
901       "deprecated" : "",
902       "since" : "",
903       "see" : "",
904       "exceptions" : "",
905       "requires" : "",
906       "params" : [],
907       "returns" : [
908         {
909           "name" : "",
910           "type" : "Roo.Element",
911           "desc" : "The element"
912         }
913       ]
914     },
915     {
916       "name" : "purgeListeners",
917       "type" : "function",
918       "desc" : "Removes all listeners for this object",
919       "sig" : "()\n{\n\n}",
920       "static" : false,
921       "memberOf" : "Roo.util.Observable",
922       "isStatic" : false,
923       "isConstructor" : false,
924       "isPrivate" : false,
925       "example" : "",
926       "deprecated" : "",
927       "since" : "",
928       "see" : "",
929       "exceptions" : "",
930       "requires" : "",
931       "params" : [],
932       "returns" : []
933     },
934     {
935       "name" : "on",
936       "type" : "function",
937       "desc" : "Appends an event handler to this element (shorthand for addListener)",
938       "sig" : "(eventName, handler, scope, options)",
939       "static" : false,
940       "memberOf" : "Roo.util.Observable",
941       "isStatic" : false,
942       "isConstructor" : false,
943       "isPrivate" : false,
944       "example" : "",
945       "deprecated" : "",
946       "since" : "",
947       "see" : "",
948       "exceptions" : "",
949       "requires" : "",
950       "params" : [
951         {
952           "name" : "eventName",
953           "type" : "String",
954           "desc" : "The type of event to listen for",
955           "isOptional" : false
956         },
957         {
958           "name" : "handler",
959           "type" : "Function",
960           "desc" : "The method the event invokes",
961           "isOptional" : false
962         },
963         {
964           "name" : "scope",
965           "type" : "Object",
966           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
967           "isOptional" : false
968         },
969         {
970           "name" : "options",
971           "type" : "Object",
972           "desc" : "(optional)",
973           "isOptional" : false
974         }
975       ],
976       "returns" : []
977     },
978     {
979       "name" : "un",
980       "type" : "function",
981       "desc" : "Removes a listener (shorthand for removeListener)",
982       "sig" : "(eventName, handler, scope)",
983       "static" : false,
984       "memberOf" : "Roo.util.Observable",
985       "isStatic" : false,
986       "isConstructor" : false,
987       "isPrivate" : false,
988       "example" : "",
989       "deprecated" : "",
990       "since" : "",
991       "see" : "",
992       "exceptions" : "",
993       "requires" : "",
994       "params" : [
995         {
996           "name" : "eventName",
997           "type" : "String",
998           "desc" : "The type of event to listen for",
999           "isOptional" : false
1000         },
1001         {
1002           "name" : "handler",
1003           "type" : "Function",
1004           "desc" : "The handler to remove",
1005           "isOptional" : false
1006         },
1007         {
1008           "name" : "scope",
1009           "type" : "Object",
1010           "desc" : "(optional) The scope (this object) for the handler",
1011           "isOptional" : false
1012         }
1013       ],
1014       "returns" : []
1015     },
1016     {
1017       "name" : "addEvents",
1018       "type" : "function",
1019       "desc" : "Used to define events on this Observable",
1020       "sig" : "(object)",
1021       "static" : false,
1022       "memberOf" : "Roo.util.Observable",
1023       "isStatic" : false,
1024       "isConstructor" : false,
1025       "isPrivate" : false,
1026       "example" : "",
1027       "deprecated" : "",
1028       "since" : "",
1029       "see" : "",
1030       "exceptions" : "",
1031       "requires" : "",
1032       "params" : [
1033         {
1034           "name" : "object",
1035           "type" : "Object",
1036           "desc" : "The object with the events defined",
1037           "isOptional" : false
1038         }
1039       ],
1040       "returns" : []
1041     },
1042     {
1043       "name" : "releaseCapture",
1044       "type" : "function",
1045       "desc" : "Removes <b>all</b> added captures from the Observable.",
1046       "sig" : "(o)",
1047       "static" : true,
1048       "memberOf" : "Roo.util.Observable",
1049       "isStatic" : true,
1050       "isConstructor" : false,
1051       "isPrivate" : false,
1052       "example" : "",
1053       "deprecated" : "",
1054       "since" : "",
1055       "see" : "",
1056       "exceptions" : "",
1057       "requires" : "",
1058       "params" : [
1059         {
1060           "name" : "o",
1061           "type" : "Observable",
1062           "desc" : "The Observable to release",
1063           "isOptional" : false
1064         }
1065       ],
1066       "returns" : []
1067     },
1068     {
1069       "name" : "removeListener",
1070       "type" : "function",
1071       "desc" : "Removes a listener",
1072       "sig" : "(eventName, handler, scope)",
1073       "static" : false,
1074       "memberOf" : "Roo.util.Observable",
1075       "isStatic" : false,
1076       "isConstructor" : false,
1077       "isPrivate" : false,
1078       "example" : "",
1079       "deprecated" : "",
1080       "since" : "",
1081       "see" : "",
1082       "exceptions" : "",
1083       "requires" : "",
1084       "params" : [
1085         {
1086           "name" : "eventName",
1087           "type" : "String",
1088           "desc" : "The type of event to listen for",
1089           "isOptional" : false
1090         },
1091         {
1092           "name" : "handler",
1093           "type" : "Function",
1094           "desc" : "The handler to remove",
1095           "isOptional" : false
1096         },
1097         {
1098           "name" : "scope",
1099           "type" : "Object",
1100           "desc" : "(optional) The scope (this object) for the handler",
1101           "isOptional" : false
1102         }
1103       ],
1104       "returns" : []
1105     },
1106     {
1107       "name" : "fireEvent",
1108       "type" : "function",
1109       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1110       "sig" : "(eventName, args)",
1111       "static" : false,
1112       "memberOf" : "Roo.util.Observable",
1113       "isStatic" : false,
1114       "isConstructor" : false,
1115       "isPrivate" : false,
1116       "example" : "",
1117       "deprecated" : "",
1118       "since" : "",
1119       "see" : "",
1120       "exceptions" : "",
1121       "requires" : "",
1122       "params" : [
1123         {
1124           "name" : "eventName",
1125           "type" : "String",
1126           "desc" : "",
1127           "isOptional" : false
1128         },
1129         {
1130           "name" : "args",
1131           "type" : "Object...",
1132           "desc" : "Variable number of parameters are passed to handlers",
1133           "isOptional" : false
1134         }
1135       ],
1136       "returns" : [
1137         {
1138           "name" : "",
1139           "type" : "Boolean",
1140           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1141         }
1142       ]
1143     },
1144     {
1145       "name" : "hasListener",
1146       "type" : "function",
1147       "desc" : "Checks to see if this object has any listeners for a specified event",
1148       "sig" : "(eventName)",
1149       "static" : false,
1150       "memberOf" : "Roo.util.Observable",
1151       "isStatic" : false,
1152       "isConstructor" : false,
1153       "isPrivate" : false,
1154       "example" : "",
1155       "deprecated" : "",
1156       "since" : "",
1157       "see" : "",
1158       "exceptions" : "",
1159       "requires" : "",
1160       "params" : [
1161         {
1162           "name" : "eventName",
1163           "type" : "String",
1164           "desc" : "The name of the event to check for",
1165           "isOptional" : false
1166         }
1167       ],
1168       "returns" : [
1169         {
1170           "name" : "",
1171           "type" : "Boolean",
1172           "desc" : "True if the event is being listened for, else false"
1173         }
1174       ]
1175     },
1176     {
1177       "name" : "capture",
1178       "type" : "function",
1179       "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.",
1180       "sig" : "(o, fn, scope)",
1181       "static" : true,
1182       "memberOf" : "Roo.util.Observable",
1183       "isStatic" : true,
1184       "isConstructor" : false,
1185       "isPrivate" : false,
1186       "example" : "",
1187       "deprecated" : "",
1188       "since" : "",
1189       "see" : "",
1190       "exceptions" : "",
1191       "requires" : "",
1192       "params" : [
1193         {
1194           "name" : "o",
1195           "type" : "Observable",
1196           "desc" : "The Observable to capture",
1197           "isOptional" : false
1198         },
1199         {
1200           "name" : "fn",
1201           "type" : "Function",
1202           "desc" : "The function to call",
1203           "isOptional" : false
1204         },
1205         {
1206           "name" : "scope",
1207           "type" : "Object",
1208           "desc" : "(optional) The scope (this object) for the fn",
1209           "isOptional" : false
1210         }
1211       ],
1212       "returns" : []
1213     },
1214     {
1215       "name" : "addListener",
1216       "type" : "function",
1217       "desc" : "Appends an event handler to this component",
1218       "sig" : "(eventName, handler, scope, options)",
1219       "static" : false,
1220       "memberOf" : "Roo.util.Observable",
1221       "isStatic" : false,
1222       "isConstructor" : false,
1223       "isPrivate" : false,
1224       "example" : "",
1225       "deprecated" : "",
1226       "since" : "",
1227       "see" : "",
1228       "exceptions" : "",
1229       "requires" : "",
1230       "params" : [
1231         {
1232           "name" : "eventName",
1233           "type" : "String",
1234           "desc" : "The type of event to listen for",
1235           "isOptional" : false
1236         },
1237         {
1238           "name" : "handler",
1239           "type" : "Function",
1240           "desc" : "The method the event invokes",
1241           "isOptional" : false
1242         },
1243         {
1244           "name" : "scope",
1245           "type" : "Object",
1246           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1247           "isOptional" : false
1248         },
1249         {
1250           "name" : "options",
1251           "type" : "Object",
1252           "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>",
1253           "isOptional" : false
1254         }
1255       ],
1256       "returns" : []
1257     }
1258   ],
1259   "events" : [
1260     {
1261       "name" : "preview",
1262       "type" : "function",
1263       "desc" : "When a image is clicked on - and needs to display a slideshow or similar..",
1264       "sig" : "function (_self, The)\n{\n\n}",
1265       "memberOf" : "",
1266       "example" : "",
1267       "deprecated" : "",
1268       "since" : "",
1269       "see" : "",
1270       "params" : [
1271         {
1272           "name" : "this",
1273           "type" : "Roo.bootstrap.Card",
1274           "desc" : "",
1275           "isOptional" : false
1276         },
1277         {
1278           "name" : "The",
1279           "type" : "Object",
1280           "desc" : "image information data",
1281           "isOptional" : false
1282         }
1283       ],
1284       "returns" : []
1285     },
1286     {
1287       "name" : "download",
1288       "type" : "function",
1289       "desc" : "When a the download link is clicked",
1290       "sig" : "function (_self, The)\n{\n\n}",
1291       "memberOf" : "",
1292       "example" : "",
1293       "deprecated" : "",
1294       "since" : "",
1295       "see" : "",
1296       "params" : [
1297         {
1298           "name" : "this",
1299           "type" : "Roo.bootstrap.Card",
1300           "desc" : "",
1301           "isOptional" : false
1302         },
1303         {
1304           "name" : "The",
1305           "type" : "Object",
1306           "desc" : "image information data  contains",
1307           "isOptional" : false
1308         }
1309       ],
1310       "returns" : []
1311     },
1312     {
1313       "name" : "toggle",
1314       "type" : "function",
1315       "desc" : "After the button has been toggles",
1316       "sig" : "function (btn, e, pressed)\n{\n\n}",
1317       "memberOf" : "Roo.bootstrap.Button",
1318       "example" : "",
1319       "deprecated" : "",
1320       "since" : "",
1321       "see" : "",
1322       "params" : [
1323         {
1324           "name" : "btn",
1325           "type" : "Roo.bootstrap.Button",
1326           "desc" : "",
1327           "isOptional" : false
1328         },
1329         {
1330           "name" : "e",
1331           "type" : "Roo.EventObject",
1332           "desc" : "",
1333           "isOptional" : false
1334         },
1335         {
1336           "name" : "pressed",
1337           "type" : "boolean",
1338           "desc" : "(also available as button.pressed)",
1339           "isOptional" : false
1340         }
1341       ],
1342       "returns" : []
1343     },
1344     {
1345       "name" : "dblclick",
1346       "type" : "function",
1347       "desc" : "When a button is double clicked",
1348       "sig" : "function (btn, e)\n{\n\n}",
1349       "memberOf" : "Roo.bootstrap.Button",
1350       "example" : "",
1351       "deprecated" : "",
1352       "since" : "",
1353       "see" : "",
1354       "params" : [
1355         {
1356           "name" : "btn",
1357           "type" : "Roo.bootstrap.Button",
1358           "desc" : "",
1359           "isOptional" : false
1360         },
1361         {
1362           "name" : "e",
1363           "type" : "Roo.EventObject",
1364           "desc" : "",
1365           "isOptional" : false
1366         }
1367       ],
1368       "returns" : []
1369     },
1370     {
1371       "name" : "click",
1372       "type" : "function",
1373       "desc" : "When a button is pressed",
1374       "sig" : "function (btn, e)\n{\n\n}",
1375       "memberOf" : "Roo.bootstrap.Button",
1376       "example" : "",
1377       "deprecated" : "",
1378       "since" : "",
1379       "see" : "",
1380       "params" : [
1381         {
1382           "name" : "btn",
1383           "type" : "Roo.bootstrap.Button",
1384           "desc" : "",
1385           "isOptional" : false
1386         },
1387         {
1388           "name" : "e",
1389           "type" : "Roo.EventObject",
1390           "desc" : "",
1391           "isOptional" : false
1392         }
1393       ],
1394       "returns" : []
1395     },
1396     {
1397       "name" : "childrenrendered",
1398       "type" : "function",
1399       "desc" : "Fires when the children have been rendered..",
1400       "sig" : "function (_self)\n{\n\n}",
1401       "memberOf" : "Roo.bootstrap.Component",
1402       "example" : "",
1403       "deprecated" : "",
1404       "since" : "",
1405       "see" : "",
1406       "params" : [
1407         {
1408           "name" : "this",
1409           "type" : "Roo.bootstrap.Component",
1410           "desc" : "",
1411           "isOptional" : false
1412         }
1413       ],
1414       "returns" : []
1415     },
1416     {
1417       "name" : "beforerender",
1418       "type" : "function",
1419       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1420       "sig" : "function (_self)\n{\n\n}",
1421       "memberOf" : "Roo.Component",
1422       "example" : "",
1423       "deprecated" : "",
1424       "since" : "",
1425       "see" : "",
1426       "params" : [
1427         {
1428           "name" : "this",
1429           "type" : "Roo.Component",
1430           "desc" : "",
1431           "isOptional" : false
1432         }
1433       ],
1434       "returns" : []
1435     },
1436     {
1437       "name" : "disable",
1438       "type" : "function",
1439       "desc" : "Fires after the component is disabled.",
1440       "sig" : "function (_self)\n{\n\n}",
1441       "memberOf" : "Roo.Component",
1442       "example" : "",
1443       "deprecated" : "",
1444       "since" : "",
1445       "see" : "",
1446       "params" : [
1447         {
1448           "name" : "this",
1449           "type" : "Roo.Component",
1450           "desc" : "",
1451           "isOptional" : false
1452         }
1453       ],
1454       "returns" : []
1455     },
1456     {
1457       "name" : "render",
1458       "type" : "function",
1459       "desc" : "Fires after the component is rendered.",
1460       "sig" : "function (_self)\n{\n\n}",
1461       "memberOf" : "Roo.Component",
1462       "example" : "",
1463       "deprecated" : "",
1464       "since" : "",
1465       "see" : "",
1466       "params" : [
1467         {
1468           "name" : "this",
1469           "type" : "Roo.Component",
1470           "desc" : "",
1471           "isOptional" : false
1472         }
1473       ],
1474       "returns" : []
1475     },
1476     {
1477       "name" : "destroy",
1478       "type" : "function",
1479       "desc" : "Fires after the component is destroyed.",
1480       "sig" : "function (_self)\n{\n\n}",
1481       "memberOf" : "Roo.Component",
1482       "example" : "",
1483       "deprecated" : "",
1484       "since" : "",
1485       "see" : "",
1486       "params" : [
1487         {
1488           "name" : "this",
1489           "type" : "Roo.Component",
1490           "desc" : "",
1491           "isOptional" : false
1492         }
1493       ],
1494       "returns" : []
1495     },
1496     {
1497       "name" : "hide",
1498       "type" : "function",
1499       "desc" : "Fires after the component is hidden.",
1500       "sig" : "function (_self)\n{\n\n}",
1501       "memberOf" : "Roo.Component",
1502       "example" : "",
1503       "deprecated" : "",
1504       "since" : "",
1505       "see" : "",
1506       "params" : [
1507         {
1508           "name" : "this",
1509           "type" : "Roo.Component",
1510           "desc" : "",
1511           "isOptional" : false
1512         }
1513       ],
1514       "returns" : []
1515     },
1516     {
1517       "name" : "beforehide",
1518       "type" : "function",
1519       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1520       "sig" : "function (_self)\n{\n\n}",
1521       "memberOf" : "Roo.Component",
1522       "example" : "",
1523       "deprecated" : "",
1524       "since" : "",
1525       "see" : "",
1526       "params" : [
1527         {
1528           "name" : "this",
1529           "type" : "Roo.Component",
1530           "desc" : "",
1531           "isOptional" : false
1532         }
1533       ],
1534       "returns" : []
1535     },
1536     {
1537       "name" : "show",
1538       "type" : "function",
1539       "desc" : "Fires after the component is shown.",
1540       "sig" : "function (_self)\n{\n\n}",
1541       "memberOf" : "Roo.Component",
1542       "example" : "",
1543       "deprecated" : "",
1544       "since" : "",
1545       "see" : "",
1546       "params" : [
1547         {
1548           "name" : "this",
1549           "type" : "Roo.Component",
1550           "desc" : "",
1551           "isOptional" : false
1552         }
1553       ],
1554       "returns" : []
1555     },
1556     {
1557       "name" : "beforeshow",
1558       "type" : "function",
1559       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1560       "sig" : "function (_self)\n{\n\n}",
1561       "memberOf" : "Roo.Component",
1562       "example" : "",
1563       "deprecated" : "",
1564       "since" : "",
1565       "see" : "",
1566       "params" : [
1567         {
1568           "name" : "this",
1569           "type" : "Roo.Component",
1570           "desc" : "",
1571           "isOptional" : false
1572         }
1573       ],
1574       "returns" : []
1575     },
1576     {
1577       "name" : "enable",
1578       "type" : "function",
1579       "desc" : "Fires after the component is enabled.",
1580       "sig" : "function (_self)\n{\n\n}",
1581       "memberOf" : "Roo.Component",
1582       "example" : "",
1583       "deprecated" : "",
1584       "since" : "",
1585       "see" : "",
1586       "params" : [
1587         {
1588           "name" : "this",
1589           "type" : "Roo.Component",
1590           "desc" : "",
1591           "isOptional" : false
1592         }
1593       ],
1594       "returns" : []
1595     },
1596     {
1597       "name" : "beforedestroy",
1598       "type" : "function",
1599       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1600       "sig" : "function (_self)\n{\n\n}",
1601       "memberOf" : "Roo.Component",
1602       "example" : "",
1603       "deprecated" : "",
1604       "since" : "",
1605       "see" : "",
1606       "params" : [
1607         {
1608           "name" : "this",
1609           "type" : "Roo.Component",
1610           "desc" : "",
1611           "isOptional" : false
1612         }
1613       ],
1614       "returns" : []
1615     }
1616   ]
1617 }