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