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