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