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