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