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