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