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