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