sync
[roojs1] / docs / symbols / Roo.bootstrap.Img.json
1 {
2   "name" : "Roo.bootstrap.Img",
3   "augments" : [
4     "Roo.bootstrap.Component",
5     "Roo.Component",
6     "Roo.util.Observable"
7   ],
8   "desc" : "Bootstrap Img class",
9   "isSingleton" : false,
10   "isStatic" : false,
11   "isBuiltin" : false,
12   "memberOf" : "Img",
13   "example" : "",
14   "deprecated" : "",
15   "since" : "",
16   "see" : "",
17   "params" : [
18     {
19       "name" : "config",
20       "type" : "Object",
21       "desc" : "The config object",
22       "isOptional" : false
23     }
24   ],
25   "returns" : [],
26   "throws" : "",
27   "requires" : "",
28   "config" : [
29     {
30       "name" : "src",
31       "type" : "String",
32       "desc" : "image source",
33       "memberOf" : ""
34     },
35     {
36       "name" : "border",
37       "type" : "String",
38       "desc" : "rounded | circle | thumbnail",
39       "memberOf" : ""
40     },
41     {
42       "name" : "xsUrl",
43       "type" : "String",
44       "desc" : "xs image source",
45       "memberOf" : ""
46     },
47     {
48       "name" : "smUrl",
49       "type" : "String",
50       "desc" : "sm image source",
51       "memberOf" : ""
52     },
53     {
54       "name" : "mdUrl",
55       "type" : "String",
56       "desc" : "md image source",
57       "memberOf" : ""
58     },
59     {
60       "name" : "lgUrl",
61       "type" : "String",
62       "desc" : "lg image source",
63       "memberOf" : ""
64     },
65     {
66       "name" : "backgroundContain",
67       "type" : "Boolean",
68       "desc" : "(use style background and contain image in content)",
69       "memberOf" : ""
70     },
71     {
72       "name" : "listeners",
73       "type" : "Object",
74       "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>",
75       "memberOf" : "Roo.util.Observable"
76     },
77     {
78       "name" : "tooltip",
79       "type" : "string",
80       "desc" : "Text for the tooltip",
81       "memberOf" : "Roo.bootstrap.Component"
82     },
83     {
84       "name" : "container_method",
85       "type" : "string",
86       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
87       "memberOf" : "Roo.bootstrap.Component"
88     },
89     {
90       "name" : "visibilityEl",
91       "type" : "string|object",
92       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
93       "memberOf" : "Roo.bootstrap.Component"
94     },
95     {
96       "name" : "can_build_overlaid",
97       "type" : "Boolean",
98       "desc" : "True if element can be rebuild from a HTML page",
99       "memberOf" : "Roo.bootstrap.Component"
100     },
101     {
102       "name" : "hideMode",
103       "type" : "String",
104       "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\".",
105       "memberOf" : "Roo.Component"
106     },
107     {
108       "name" : "style",
109       "type" : "String",
110       "desc" : "any extra css",
111       "memberOf" : "Roo.bootstrap.Component"
112     },
113     {
114       "name" : "allowDomMove",
115       "type" : "Boolean",
116       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
117       "memberOf" : "Roo.Component"
118     },
119     {
120       "name" : "cls",
121       "type" : "String",
122       "desc" : "css class",
123       "memberOf" : "Roo.bootstrap.Component"
124     },
125     {
126       "name" : "imgResponsive",
127       "type" : "Boolean",
128       "desc" : "false | true",
129       "memberOf" : ""
130     },
131     {
132       "name" : "alt",
133       "type" : "String",
134       "desc" : "image alternative text",
135       "memberOf" : ""
136     },
137     {
138       "name" : "xattr",
139       "type" : "Object",
140       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
141       "memberOf" : "Roo.bootstrap.Component"
142     },
143     {
144       "name" : "actionMode",
145       "type" : "String",
146       "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",
147       "memberOf" : "Roo.Component"
148     },
149     {
150       "name" : "dataId",
151       "type" : "string",
152       "desc" : "cutomer id",
153       "memberOf" : "Roo.bootstrap.Component"
154     },
155     {
156       "name" : "target",
157       "type" : "String",
158       "desc" : "p)target for a href.",
159       "memberOf" : ""
160     },
161     {
162       "name" : "name",
163       "type" : "string",
164       "desc" : "Specifies name attribute",
165       "memberOf" : "Roo.bootstrap.Component"
166     },
167     {
168       "name" : "disableClass",
169       "type" : "String",
170       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
171       "memberOf" : "Roo.Component"
172     },
173     {
174       "name" : "href",
175       "type" : "String",
176       "desc" : "a tag href",
177       "memberOf" : ""
178     }
179   ],
180   "methods" : [
181     {
182       "name" : "setSrc",
183       "type" : "function",
184       "desc" : "Sets the url of the image - used to update it",
185       "sig" : "(url)",
186       "static" : false,
187       "memberOf" : "",
188       "isStatic" : false,
189       "isConstructor" : false,
190       "isPrivate" : false,
191       "example" : "",
192       "deprecated" : "",
193       "since" : "",
194       "see" : "",
195       "exceptions" : "",
196       "requires" : "",
197       "params" : [
198         {
199           "name" : "url",
200           "type" : "String",
201           "desc" : "the url of the image",
202           "isOptional" : false
203         }
204       ],
205       "returns" : []
206     },
207     {
208       "name" : "tooltipEl",
209       "type" : "function",
210       "desc" : "Fetch the element to display the tooltip on.",
211       "sig" : "()\n{\n\n}",
212       "static" : false,
213       "memberOf" : "Roo.bootstrap.Component",
214       "isStatic" : false,
215       "isConstructor" : false,
216       "isPrivate" : false,
217       "example" : "",
218       "deprecated" : "",
219       "since" : "",
220       "see" : "",
221       "exceptions" : "",
222       "requires" : "",
223       "params" : [],
224       "returns" : [
225         {
226           "name" : "",
227           "type" : "Roo.Element",
228           "desc" : "defaults to this.el"
229         }
230       ]
231     },
232     {
233       "name" : "hide",
234       "type" : "function",
235       "desc" : "Hide a component - adds 'hidden' class",
236       "sig" : "()\n{\n\n}",
237       "static" : false,
238       "memberOf" : "Roo.bootstrap.Component",
239       "isStatic" : false,
240       "isConstructor" : false,
241       "isPrivate" : false,
242       "example" : "",
243       "deprecated" : "",
244       "since" : "",
245       "see" : "",
246       "exceptions" : "",
247       "requires" : "",
248       "params" : [],
249       "returns" : []
250     },
251     {
252       "name" : "show",
253       "type" : "function",
254       "desc" : "Show a component - removes 'hidden' class",
255       "sig" : "()\n{\n\n}",
256       "static" : false,
257       "memberOf" : "Roo.bootstrap.Component",
258       "isStatic" : false,
259       "isConstructor" : false,
260       "isPrivate" : false,
261       "example" : "",
262       "deprecated" : "",
263       "since" : "",
264       "see" : "",
265       "exceptions" : "",
266       "requires" : "",
267       "params" : [],
268       "returns" : []
269     },
270     {
271       "name" : "setVisibilityEl",
272       "type" : "function",
273       "desc" : "Set the element that will be used to show or hide",
274       "sig" : "()\n{\n\n}",
275       "static" : false,
276       "memberOf" : "Roo.bootstrap.Component",
277       "isStatic" : false,
278       "isConstructor" : false,
279       "isPrivate" : false,
280       "example" : "",
281       "deprecated" : "",
282       "since" : "",
283       "see" : "",
284       "exceptions" : "",
285       "requires" : "",
286       "params" : [],
287       "returns" : []
288     },
289     {
290       "name" : "getVisibilityEl",
291       "type" : "function",
292       "desc" : "Get the element that will be used to show or hide",
293       "sig" : "()\n{\n\n}",
294       "static" : false,
295       "memberOf" : "Roo.bootstrap.Component",
296       "isStatic" : false,
297       "isConstructor" : false,
298       "isPrivate" : false,
299       "example" : "",
300       "deprecated" : "",
301       "since" : "",
302       "see" : "",
303       "exceptions" : "",
304       "requires" : "",
305       "params" : [],
306       "returns" : []
307     },
308     {
309       "name" : "initEvents",
310       "type" : "function",
311       "desc" : "Initialize Events for the element",
312       "sig" : "()\n{\n\n}",
313       "static" : false,
314       "memberOf" : "Roo.bootstrap.Component",
315       "isStatic" : false,
316       "isConstructor" : false,
317       "isPrivate" : false,
318       "example" : "",
319       "deprecated" : "",
320       "since" : "",
321       "see" : "",
322       "exceptions" : "",
323       "requires" : "",
324       "params" : [],
325       "returns" : []
326     },
327     {
328       "name" : "getChildContainer",
329       "type" : "function",
330       "desc" : "Fetch the element to add children to",
331       "sig" : "()\n{\n\n}",
332       "static" : false,
333       "memberOf" : "Roo.bootstrap.Component",
334       "isStatic" : false,
335       "isConstructor" : false,
336       "isPrivate" : false,
337       "example" : "",
338       "deprecated" : "",
339       "since" : "",
340       "see" : "",
341       "exceptions" : "",
342       "requires" : "",
343       "params" : [],
344       "returns" : [
345         {
346           "name" : "",
347           "type" : "Roo.Element",
348           "desc" : "defaults to this.el"
349         }
350       ]
351     },
352     {
353       "name" : "getId",
354       "type" : "function",
355       "desc" : "Returns the id of this component.",
356       "sig" : "()\n{\n\n}",
357       "static" : false,
358       "memberOf" : "Roo.Component",
359       "isStatic" : false,
360       "isConstructor" : false,
361       "isPrivate" : false,
362       "example" : "",
363       "deprecated" : "",
364       "since" : "",
365       "see" : "",
366       "exceptions" : "",
367       "requires" : "",
368       "params" : [],
369       "returns" : [
370         {
371           "name" : "",
372           "type" : "String",
373           "desc" : ""
374         }
375       ]
376     },
377     {
378       "name" : "render",
379       "type" : "function",
380       "desc" : "If this is a lazy rendering component, render it to its container element.",
381       "sig" : "(container)",
382       "static" : false,
383       "memberOf" : "Roo.Component",
384       "isStatic" : false,
385       "isConstructor" : false,
386       "isPrivate" : false,
387       "example" : "",
388       "deprecated" : "",
389       "since" : "",
390       "see" : "",
391       "exceptions" : "",
392       "requires" : "",
393       "params" : [
394         {
395           "name" : "container",
396           "type" : "String/HTMLElement/Element",
397           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
398           "isOptional" : false
399         }
400       ],
401       "returns" : []
402     },
403     {
404       "name" : "destroy",
405       "type" : "function",
406       "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}.",
407       "sig" : "()\n{\n\n}",
408       "static" : false,
409       "memberOf" : "Roo.Component",
410       "isStatic" : false,
411       "isConstructor" : false,
412       "isPrivate" : false,
413       "example" : "",
414       "deprecated" : "",
415       "since" : "",
416       "see" : "",
417       "exceptions" : "",
418       "requires" : "",
419       "params" : [],
420       "returns" : []
421     },
422     {
423       "name" : "isVisible",
424       "type" : "function",
425       "desc" : "Returns true if this component is visible.",
426       "sig" : "()\n{\n\n}",
427       "static" : false,
428       "memberOf" : "Roo.Component",
429       "isStatic" : false,
430       "isConstructor" : false,
431       "isPrivate" : false,
432       "example" : "",
433       "deprecated" : "",
434       "since" : "",
435       "see" : "",
436       "exceptions" : "",
437       "requires" : "",
438       "params" : [],
439       "returns" : []
440     },
441     {
442       "name" : "setDisabled",
443       "type" : "function",
444       "desc" : "Convenience function for setting disabled/enabled by boolean.",
445       "sig" : "(disabled)",
446       "static" : false,
447       "memberOf" : "Roo.Component",
448       "isStatic" : false,
449       "isConstructor" : false,
450       "isPrivate" : false,
451       "example" : "",
452       "deprecated" : "",
453       "since" : "",
454       "see" : "",
455       "exceptions" : "",
456       "requires" : "",
457       "params" : [
458         {
459           "name" : "disabled",
460           "type" : "Boolean",
461           "desc" : "",
462           "isOptional" : false
463         }
464       ],
465       "returns" : []
466     },
467     {
468       "name" : "focus",
469       "type" : "function",
470       "desc" : "Try to focus this component.",
471       "sig" : "(selectText)",
472       "static" : false,
473       "memberOf" : "Roo.Component",
474       "isStatic" : false,
475       "isConstructor" : false,
476       "isPrivate" : false,
477       "example" : "",
478       "deprecated" : "",
479       "since" : "",
480       "see" : "",
481       "exceptions" : "",
482       "requires" : "",
483       "params" : [
484         {
485           "name" : "selectText",
486           "type" : "Boolean",
487           "desc" : "True to also select the text in this component (if applicable)",
488           "isOptional" : false
489         }
490       ],
491       "returns" : [
492         {
493           "name" : "",
494           "type" : "Roo.Component",
495           "desc" : "this"
496         }
497       ]
498     },
499     {
500       "name" : "enable",
501       "type" : "function",
502       "desc" : "Enable this component.",
503       "sig" : "()\n{\n\n}",
504       "static" : false,
505       "memberOf" : "Roo.Component",
506       "isStatic" : false,
507       "isConstructor" : false,
508       "isPrivate" : false,
509       "example" : "",
510       "deprecated" : "",
511       "since" : "",
512       "see" : "",
513       "exceptions" : "",
514       "requires" : "",
515       "params" : [],
516       "returns" : [
517         {
518           "name" : "",
519           "type" : "Roo.Component",
520           "desc" : "this"
521         }
522       ]
523     },
524     {
525       "name" : "setVisible",
526       "type" : "function",
527       "desc" : "Convenience function to hide or show this component by boolean.",
528       "sig" : "(visible)",
529       "static" : false,
530       "memberOf" : "Roo.Component",
531       "isStatic" : false,
532       "isConstructor" : false,
533       "isPrivate" : false,
534       "example" : "",
535       "deprecated" : "",
536       "since" : "",
537       "see" : "",
538       "exceptions" : "",
539       "requires" : "",
540       "params" : [
541         {
542           "name" : "visible",
543           "type" : "Boolean",
544           "desc" : "True to show, false to hide",
545           "isOptional" : false
546         }
547       ],
548       "returns" : [
549         {
550           "name" : "",
551           "type" : "Roo.Component",
552           "desc" : "this"
553         }
554       ]
555     },
556     {
557       "name" : "disable",
558       "type" : "function",
559       "desc" : "Disable this component.",
560       "sig" : "()\n{\n\n}",
561       "static" : false,
562       "memberOf" : "Roo.Component",
563       "isStatic" : false,
564       "isConstructor" : false,
565       "isPrivate" : false,
566       "example" : "",
567       "deprecated" : "",
568       "since" : "",
569       "see" : "",
570       "exceptions" : "",
571       "requires" : "",
572       "params" : [],
573       "returns" : [
574         {
575           "name" : "",
576           "type" : "Roo.Component",
577           "desc" : "this"
578         }
579       ]
580     },
581     {
582       "name" : "getEl",
583       "type" : "function",
584       "desc" : "Returns the underlying {@link Roo.Element}.",
585       "sig" : "()\n{\n\n}",
586       "static" : false,
587       "memberOf" : "Roo.Component",
588       "isStatic" : false,
589       "isConstructor" : false,
590       "isPrivate" : false,
591       "example" : "",
592       "deprecated" : "",
593       "since" : "",
594       "see" : "",
595       "exceptions" : "",
596       "requires" : "",
597       "params" : [],
598       "returns" : [
599         {
600           "name" : "",
601           "type" : "Roo.Element",
602           "desc" : "The element"
603         }
604       ]
605     },
606     {
607       "name" : "purgeListeners",
608       "type" : "function",
609       "desc" : "Removes all listeners for this object",
610       "sig" : "()\n{\n\n}",
611       "static" : false,
612       "memberOf" : "Roo.util.Observable",
613       "isStatic" : false,
614       "isConstructor" : false,
615       "isPrivate" : false,
616       "example" : "",
617       "deprecated" : "",
618       "since" : "",
619       "see" : "",
620       "exceptions" : "",
621       "requires" : "",
622       "params" : [],
623       "returns" : []
624     },
625     {
626       "name" : "on",
627       "type" : "function",
628       "desc" : "Appends an event handler to this element (shorthand for addListener)",
629       "sig" : "(eventName, handler, scope, options)",
630       "static" : false,
631       "memberOf" : "Roo.util.Observable",
632       "isStatic" : false,
633       "isConstructor" : false,
634       "isPrivate" : false,
635       "example" : "",
636       "deprecated" : "",
637       "since" : "",
638       "see" : "",
639       "exceptions" : "",
640       "requires" : "",
641       "params" : [
642         {
643           "name" : "eventName",
644           "type" : "String",
645           "desc" : "The type of event to listen for",
646           "isOptional" : false
647         },
648         {
649           "name" : "handler",
650           "type" : "Function",
651           "desc" : "The method the event invokes",
652           "isOptional" : false
653         },
654         {
655           "name" : "scope",
656           "type" : "Object",
657           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
658           "isOptional" : false
659         },
660         {
661           "name" : "options",
662           "type" : "Object",
663           "desc" : "(optional)",
664           "isOptional" : false
665         }
666       ],
667       "returns" : []
668     },
669     {
670       "name" : "un",
671       "type" : "function",
672       "desc" : "Removes a listener (shorthand for removeListener)",
673       "sig" : "(eventName, handler, scope)",
674       "static" : false,
675       "memberOf" : "Roo.util.Observable",
676       "isStatic" : false,
677       "isConstructor" : false,
678       "isPrivate" : false,
679       "example" : "",
680       "deprecated" : "",
681       "since" : "",
682       "see" : "",
683       "exceptions" : "",
684       "requires" : "",
685       "params" : [
686         {
687           "name" : "eventName",
688           "type" : "String",
689           "desc" : "The type of event to listen for",
690           "isOptional" : false
691         },
692         {
693           "name" : "handler",
694           "type" : "Function",
695           "desc" : "The handler to remove",
696           "isOptional" : false
697         },
698         {
699           "name" : "scope",
700           "type" : "Object",
701           "desc" : "(optional) The scope (this object) for the handler",
702           "isOptional" : false
703         }
704       ],
705       "returns" : []
706     },
707     {
708       "name" : "addEvents",
709       "type" : "function",
710       "desc" : "Used to define events on this Observable",
711       "sig" : "(object)",
712       "static" : false,
713       "memberOf" : "Roo.util.Observable",
714       "isStatic" : false,
715       "isConstructor" : false,
716       "isPrivate" : false,
717       "example" : "",
718       "deprecated" : "",
719       "since" : "",
720       "see" : "",
721       "exceptions" : "",
722       "requires" : "",
723       "params" : [
724         {
725           "name" : "object",
726           "type" : "Object",
727           "desc" : "The object with the events defined",
728           "isOptional" : false
729         }
730       ],
731       "returns" : []
732     },
733     {
734       "name" : "releaseCapture",
735       "type" : "function",
736       "desc" : "Removes <b>all</b> added captures from the Observable.",
737       "sig" : "(o)",
738       "static" : true,
739       "memberOf" : "Roo.util.Observable",
740       "isStatic" : true,
741       "isConstructor" : false,
742       "isPrivate" : false,
743       "example" : "",
744       "deprecated" : "",
745       "since" : "",
746       "see" : "",
747       "exceptions" : "",
748       "requires" : "",
749       "params" : [
750         {
751           "name" : "o",
752           "type" : "Observable",
753           "desc" : "The Observable to release",
754           "isOptional" : false
755         }
756       ],
757       "returns" : []
758     },
759     {
760       "name" : "removeListener",
761       "type" : "function",
762       "desc" : "Removes a listener",
763       "sig" : "(eventName, handler, scope)",
764       "static" : false,
765       "memberOf" : "Roo.util.Observable",
766       "isStatic" : false,
767       "isConstructor" : false,
768       "isPrivate" : false,
769       "example" : "",
770       "deprecated" : "",
771       "since" : "",
772       "see" : "",
773       "exceptions" : "",
774       "requires" : "",
775       "params" : [
776         {
777           "name" : "eventName",
778           "type" : "String",
779           "desc" : "The type of event to listen for",
780           "isOptional" : false
781         },
782         {
783           "name" : "handler",
784           "type" : "Function",
785           "desc" : "The handler to remove",
786           "isOptional" : false
787         },
788         {
789           "name" : "scope",
790           "type" : "Object",
791           "desc" : "(optional) The scope (this object) for the handler",
792           "isOptional" : false
793         }
794       ],
795       "returns" : []
796     },
797     {
798       "name" : "fireEvent",
799       "type" : "function",
800       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
801       "sig" : "(eventName, args)",
802       "static" : false,
803       "memberOf" : "Roo.util.Observable",
804       "isStatic" : false,
805       "isConstructor" : false,
806       "isPrivate" : false,
807       "example" : "",
808       "deprecated" : "",
809       "since" : "",
810       "see" : "",
811       "exceptions" : "",
812       "requires" : "",
813       "params" : [
814         {
815           "name" : "eventName",
816           "type" : "String",
817           "desc" : "",
818           "isOptional" : false
819         },
820         {
821           "name" : "args",
822           "type" : "Object...",
823           "desc" : "Variable number of parameters are passed to handlers",
824           "isOptional" : false
825         }
826       ],
827       "returns" : [
828         {
829           "name" : "",
830           "type" : "Boolean",
831           "desc" : "returns false if any of the handlers return false otherwise it returns true"
832         }
833       ]
834     },
835     {
836       "name" : "hasListener",
837       "type" : "function",
838       "desc" : "Checks to see if this object has any listeners for a specified event",
839       "sig" : "(eventName)",
840       "static" : false,
841       "memberOf" : "Roo.util.Observable",
842       "isStatic" : false,
843       "isConstructor" : false,
844       "isPrivate" : false,
845       "example" : "",
846       "deprecated" : "",
847       "since" : "",
848       "see" : "",
849       "exceptions" : "",
850       "requires" : "",
851       "params" : [
852         {
853           "name" : "eventName",
854           "type" : "String",
855           "desc" : "The name of the event to check for",
856           "isOptional" : false
857         }
858       ],
859       "returns" : [
860         {
861           "name" : "",
862           "type" : "Boolean",
863           "desc" : "True if the event is being listened for, else false"
864         }
865       ]
866     },
867     {
868       "name" : "capture",
869       "type" : "function",
870       "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.",
871       "sig" : "(o, fn, scope)",
872       "static" : true,
873       "memberOf" : "Roo.util.Observable",
874       "isStatic" : true,
875       "isConstructor" : false,
876       "isPrivate" : false,
877       "example" : "",
878       "deprecated" : "",
879       "since" : "",
880       "see" : "",
881       "exceptions" : "",
882       "requires" : "",
883       "params" : [
884         {
885           "name" : "o",
886           "type" : "Observable",
887           "desc" : "The Observable to capture",
888           "isOptional" : false
889         },
890         {
891           "name" : "fn",
892           "type" : "Function",
893           "desc" : "The function to call",
894           "isOptional" : false
895         },
896         {
897           "name" : "scope",
898           "type" : "Object",
899           "desc" : "(optional) The scope (this object) for the fn",
900           "isOptional" : false
901         }
902       ],
903       "returns" : []
904     },
905     {
906       "name" : "addListener",
907       "type" : "function",
908       "desc" : "Appends an event handler to this component",
909       "sig" : "(eventName, handler, scope, options)",
910       "static" : false,
911       "memberOf" : "Roo.util.Observable",
912       "isStatic" : false,
913       "isConstructor" : false,
914       "isPrivate" : false,
915       "example" : "",
916       "deprecated" : "",
917       "since" : "",
918       "see" : "",
919       "exceptions" : "",
920       "requires" : "",
921       "params" : [
922         {
923           "name" : "eventName",
924           "type" : "String",
925           "desc" : "The type of event to listen for",
926           "isOptional" : false
927         },
928         {
929           "name" : "handler",
930           "type" : "Function",
931           "desc" : "The method the event invokes",
932           "isOptional" : false
933         },
934         {
935           "name" : "scope",
936           "type" : "Object",
937           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
938           "isOptional" : false
939         },
940         {
941           "name" : "options",
942           "type" : "Object",
943           "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>",
944           "isOptional" : false
945         }
946       ],
947       "returns" : []
948     }
949   ],
950   "events" : [
951     {
952       "name" : "click",
953       "type" : "function",
954       "desc" : "The img click event for the img.",
955       "sig" : "function (e)\n{\n\n}",
956       "memberOf" : "",
957       "example" : "",
958       "deprecated" : "",
959       "since" : "",
960       "see" : "",
961       "params" : [
962         {
963           "name" : "e",
964           "type" : "Roo.EventObject",
965           "desc" : "",
966           "isOptional" : false
967         }
968       ],
969       "returns" : []
970     },
971     {
972       "name" : "load",
973       "type" : "function",
974       "desc" : "The when any image loads",
975       "sig" : "function (e)\n{\n\n}",
976       "memberOf" : "",
977       "example" : "",
978       "deprecated" : "",
979       "since" : "",
980       "see" : "",
981       "params" : [
982         {
983           "name" : "e",
984           "type" : "Roo.EventObject",
985           "desc" : "",
986           "isOptional" : false
987         }
988       ],
989       "returns" : []
990     },
991     {
992       "name" : "childrenrendered",
993       "type" : "function",
994       "desc" : "Fires when the children have been rendered..",
995       "sig" : "function (_self)\n{\n\n}",
996       "memberOf" : "Roo.bootstrap.Component",
997       "example" : "",
998       "deprecated" : "",
999       "since" : "",
1000       "see" : "",
1001       "params" : [
1002         {
1003           "name" : "this",
1004           "type" : "Roo.bootstrap.Component",
1005           "desc" : "",
1006           "isOptional" : false
1007         }
1008       ],
1009       "returns" : []
1010     },
1011     {
1012       "name" : "beforerender",
1013       "type" : "function",
1014       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1015       "sig" : "function (_self)\n{\n\n}",
1016       "memberOf" : "Roo.Component",
1017       "example" : "",
1018       "deprecated" : "",
1019       "since" : "",
1020       "see" : "",
1021       "params" : [
1022         {
1023           "name" : "this",
1024           "type" : "Roo.Component",
1025           "desc" : "",
1026           "isOptional" : false
1027         }
1028       ],
1029       "returns" : []
1030     },
1031     {
1032       "name" : "disable",
1033       "type" : "function",
1034       "desc" : "Fires after the component is disabled.",
1035       "sig" : "function (_self)\n{\n\n}",
1036       "memberOf" : "Roo.Component",
1037       "example" : "",
1038       "deprecated" : "",
1039       "since" : "",
1040       "see" : "",
1041       "params" : [
1042         {
1043           "name" : "this",
1044           "type" : "Roo.Component",
1045           "desc" : "",
1046           "isOptional" : false
1047         }
1048       ],
1049       "returns" : []
1050     },
1051     {
1052       "name" : "render",
1053       "type" : "function",
1054       "desc" : "Fires after the component is rendered.",
1055       "sig" : "function (_self)\n{\n\n}",
1056       "memberOf" : "Roo.Component",
1057       "example" : "",
1058       "deprecated" : "",
1059       "since" : "",
1060       "see" : "",
1061       "params" : [
1062         {
1063           "name" : "this",
1064           "type" : "Roo.Component",
1065           "desc" : "",
1066           "isOptional" : false
1067         }
1068       ],
1069       "returns" : []
1070     },
1071     {
1072       "name" : "destroy",
1073       "type" : "function",
1074       "desc" : "Fires after the component is destroyed.",
1075       "sig" : "function (_self)\n{\n\n}",
1076       "memberOf" : "Roo.Component",
1077       "example" : "",
1078       "deprecated" : "",
1079       "since" : "",
1080       "see" : "",
1081       "params" : [
1082         {
1083           "name" : "this",
1084           "type" : "Roo.Component",
1085           "desc" : "",
1086           "isOptional" : false
1087         }
1088       ],
1089       "returns" : []
1090     },
1091     {
1092       "name" : "hide",
1093       "type" : "function",
1094       "desc" : "Fires after the component is hidden.",
1095       "sig" : "function (_self)\n{\n\n}",
1096       "memberOf" : "Roo.Component",
1097       "example" : "",
1098       "deprecated" : "",
1099       "since" : "",
1100       "see" : "",
1101       "params" : [
1102         {
1103           "name" : "this",
1104           "type" : "Roo.Component",
1105           "desc" : "",
1106           "isOptional" : false
1107         }
1108       ],
1109       "returns" : []
1110     },
1111     {
1112       "name" : "beforehide",
1113       "type" : "function",
1114       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1115       "sig" : "function (_self)\n{\n\n}",
1116       "memberOf" : "Roo.Component",
1117       "example" : "",
1118       "deprecated" : "",
1119       "since" : "",
1120       "see" : "",
1121       "params" : [
1122         {
1123           "name" : "this",
1124           "type" : "Roo.Component",
1125           "desc" : "",
1126           "isOptional" : false
1127         }
1128       ],
1129       "returns" : []
1130     },
1131     {
1132       "name" : "show",
1133       "type" : "function",
1134       "desc" : "Fires after the component is shown.",
1135       "sig" : "function (_self)\n{\n\n}",
1136       "memberOf" : "Roo.Component",
1137       "example" : "",
1138       "deprecated" : "",
1139       "since" : "",
1140       "see" : "",
1141       "params" : [
1142         {
1143           "name" : "this",
1144           "type" : "Roo.Component",
1145           "desc" : "",
1146           "isOptional" : false
1147         }
1148       ],
1149       "returns" : []
1150     },
1151     {
1152       "name" : "beforeshow",
1153       "type" : "function",
1154       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1155       "sig" : "function (_self)\n{\n\n}",
1156       "memberOf" : "Roo.Component",
1157       "example" : "",
1158       "deprecated" : "",
1159       "since" : "",
1160       "see" : "",
1161       "params" : [
1162         {
1163           "name" : "this",
1164           "type" : "Roo.Component",
1165           "desc" : "",
1166           "isOptional" : false
1167         }
1168       ],
1169       "returns" : []
1170     },
1171     {
1172       "name" : "enable",
1173       "type" : "function",
1174       "desc" : "Fires after the component is enabled.",
1175       "sig" : "function (_self)\n{\n\n}",
1176       "memberOf" : "Roo.Component",
1177       "example" : "",
1178       "deprecated" : "",
1179       "since" : "",
1180       "see" : "",
1181       "params" : [
1182         {
1183           "name" : "this",
1184           "type" : "Roo.Component",
1185           "desc" : "",
1186           "isOptional" : false
1187         }
1188       ],
1189       "returns" : []
1190     },
1191     {
1192       "name" : "beforedestroy",
1193       "type" : "function",
1194       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1195       "sig" : "function (_self)\n{\n\n}",
1196       "memberOf" : "Roo.Component",
1197       "example" : "",
1198       "deprecated" : "",
1199       "since" : "",
1200       "see" : "",
1201       "params" : [
1202         {
1203           "name" : "this",
1204           "type" : "Roo.Component",
1205           "desc" : "",
1206           "isOptional" : false
1207         }
1208       ],
1209       "returns" : []
1210     }
1211   ]
1212 }