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