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