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