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