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