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