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