fix docs add optvalues
[roojs1] / docs / symbols / Roo.bootstrap.Modal.json
1 {
2   "name" : "Roo.bootstrap.Modal",
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.PhoneInput",
62     "Roo.bootstrap.form.Radio",
63     "Roo.bootstrap.form.RadioSet",
64     "Roo.bootstrap.form.SecurePass",
65     "Roo.bootstrap.form.TextArea",
66     "Roo.bootstrap.form.TimeField",
67     "Roo.bootstrap.form.TriggerField",
68     "Roo.bootstrap.layout.Border",
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     "none",
79     "builder"
80   ],
81   "desc" : "Bootstrap Modal class",
82   "isSingleton" : false,
83   "isStatic" : false,
84   "isBuiltin" : false,
85   "isAbstract" : false,
86   "isBuilderTop" : false,
87   "memberOf" : "Modal",
88   "example" : "",
89   "deprecated" : "",
90   "since" : "",
91   "see" : "",
92   "params" : [
93     {
94       "name" : "config",
95       "type" : "Object",
96       "desc" : "The config object",
97       "isOptional" : false
98     }
99   ],
100   "returns" : [],
101   "throws" : "",
102   "requires" : "",
103   "config" : [
104     {
105       "name" : "editableTitle",
106       "type" : "Boolean",
107       "desc" : "can the title be edited",
108       "memberOf" : "",
109       "isOptional" : false,
110       "optvalues" : []
111     },
112     {
113       "name" : "listeners",
114       "type" : "Object",
115       "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>",
116       "memberOf" : "Roo.util.Observable",
117       "isOptional" : false,
118       "optvalues" : []
119     },
120     {
121       "name" : "bodyOverflow",
122       "type" : "Boolean",
123       "desc" : "should the body element have overflow auto added default false",
124       "memberOf" : "",
125       "isOptional" : false,
126       "optvalues" : []
127     },
128     {
129       "name" : "max_width",
130       "type" : "Number",
131       "desc" : "set the max width of modal",
132       "memberOf" : "",
133       "isOptional" : false,
134       "optvalues" : []
135     },
136     {
137       "name" : "tooltip",
138       "type" : "string",
139       "desc" : "Text for the tooltip",
140       "memberOf" : "Roo.bootstrap.Component",
141       "isOptional" : false,
142       "optvalues" : []
143     },
144     {
145       "name" : "container_method",
146       "type" : "string",
147       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
148       "memberOf" : "Roo.bootstrap.Component",
149       "isOptional" : false,
150       "optvalues" : []
151     },
152     {
153       "name" : "visibilityEl",
154       "type" : "string|object",
155       "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
156       "memberOf" : "Roo.bootstrap.Component",
157       "isOptional" : false,
158       "optvalues" : [
159         "el",
160         "parent"
161       ]
162     },
163     {
164       "name" : "buttons[]",
165       "type" : "Roo.bootstrap.Button",
166       "desc" : "Array of buttons or standard button set..",
167       "memberOf" : "",
168       "isOptional" : false,
169       "optvalues" : []
170     },
171     {
172       "name" : "can_build_overlaid",
173       "type" : "Boolean",
174       "desc" : "True if element can be rebuild from a HTML page",
175       "memberOf" : "Roo.bootstrap.Component",
176       "isOptional" : false,
177       "optvalues" : []
178     },
179     {
180       "name" : "hideMode",
181       "type" : "String",
182       "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",
183       "memberOf" : "Roo.Component",
184       "isOptional" : false,
185       "optvalues" : [
186         "display",
187         "visibility"
188       ]
189     },
190     {
191       "name" : "title",
192       "type" : "String",
193       "desc" : "Title of dialog",
194       "memberOf" : "",
195       "isOptional" : false,
196       "optvalues" : []
197     },
198     {
199       "name" : "style",
200       "type" : "String",
201       "desc" : "any extra css",
202       "memberOf" : "Roo.bootstrap.Component",
203       "isOptional" : false,
204       "optvalues" : []
205     },
206     {
207       "name" : "allowDomMove",
208       "type" : "Boolean",
209       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
210       "memberOf" : "Roo.Component",
211       "isOptional" : false,
212       "optvalues" : []
213     },
214     {
215       "name" : "tmpl",
216       "type" : "Roo.Template",
217       "desc" : "- a template with variables. to use it, add a handler in show:method  adn",
218       "memberOf" : "",
219       "isOptional" : false,
220       "optvalues" : []
221     },
222     {
223       "name" : "html",
224       "type" : "String",
225       "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
226       "memberOf" : "",
227       "isOptional" : false,
228       "optvalues" : []
229     },
230     {
231       "name" : "buttonPosition",
232       "type" : "String",
233       "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the le",
234       "memberOf" : "",
235       "isOptional" : false,
236       "optvalues" : [
237         "left",
238         "right",
239         "center"
240       ]
241     },
242     {
243       "name" : "cls",
244       "type" : "String",
245       "desc" : "css class",
246       "memberOf" : "Roo.bootstrap.Component",
247       "isOptional" : false,
248       "optvalues" : []
249     },
250     {
251       "name" : "fitwindow",
252       "type" : "Boolean",
253       "desc" : "default false",
254       "memberOf" : "",
255       "isOptional" : false,
256       "optvalues" : []
257     },
258     {
259       "name" : "xattr",
260       "type" : "Object",
261       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
262       "memberOf" : "Roo.bootstrap.Component",
263       "isOptional" : false,
264       "optvalues" : []
265     },
266     {
267       "name" : "actionMode",
268       "type" : "String",
269       "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",
270       "memberOf" : "Roo.Component",
271       "isOptional" : false,
272       "optvalues" : []
273     },
274     {
275       "name" : "specificTitle",
276       "type" : "Boolean",
277       "desc" : "default false",
278       "memberOf" : "",
279       "isOptional" : false,
280       "optvalues" : []
281     },
282     {
283       "name" : "width",
284       "type" : "Number",
285       "desc" : "fixed width - usefull for chrome extension only really.",
286       "memberOf" : "",
287       "isOptional" : false,
288       "optvalues" : []
289     },
290     {
291       "name" : "dataId",
292       "type" : "string",
293       "desc" : "cutomer id",
294       "memberOf" : "Roo.bootstrap.Component",
295       "isOptional" : false,
296       "optvalues" : []
297     },
298     {
299       "name" : "allow_close",
300       "type" : "Boolean",
301       "desc" : "default true",
302       "memberOf" : "",
303       "isOptional" : false,
304       "optvalues" : []
305     },
306     {
307       "name" : "height",
308       "type" : "Number",
309       "desc" : "fixed height - usefull for chrome extension only really.",
310       "memberOf" : "",
311       "isOptional" : false,
312       "optvalues" : []
313     },
314     {
315       "name" : "size",
316       "type" : "String",
317       "desc" : "l) default emp",
318       "memberOf" : "",
319       "isOptional" : false,
320       "optvalues" : [
321         "sm",
322         "lg",
323         "xl"
324       ]
325     },
326     {
327       "name" : "name",
328       "type" : "string",
329       "desc" : "Specifies name attribute",
330       "memberOf" : "Roo.bootstrap.Component",
331       "isOptional" : false,
332       "optvalues" : []
333     },
334     {
335       "name" : "disableClass",
336       "type" : "String",
337       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
338       "memberOf" : "Roo.Component",
339       "isOptional" : false,
340       "optvalues" : []
341     },
342     {
343       "name" : "animate",
344       "type" : "Boolean",
345       "desc" : "default true",
346       "memberOf" : "",
347       "isOptional" : false,
348       "optvalues" : []
349     }
350   ],
351   "methods" : [
352     {
353       "name" : "applyBody",
354       "type" : "function",
355       "desc" : "Set the body of the Dialog using the template",
356       "sig" : "(data)",
357       "static" : false,
358       "memberOf" : "",
359       "isStatic" : false,
360       "isConstructor" : false,
361       "isPrivate" : false,
362       "example" : "",
363       "deprecated" : "",
364       "since" : "",
365       "see" : "",
366       "exceptions" : "",
367       "requires" : "",
368       "params" : [
369         {
370           "name" : "data",
371           "type" : "Obj",
372           "desc" : "- apply this data to the template and replace the body contents.",
373           "isOptional" : false
374         }
375       ],
376       "returns" : []
377     },
378     {
379       "name" : "setTitle",
380       "type" : "function",
381       "desc" : "Set the title of the Dialog",
382       "sig" : "(str)",
383       "static" : false,
384       "memberOf" : "",
385       "isStatic" : false,
386       "isConstructor" : false,
387       "isPrivate" : false,
388       "example" : "",
389       "deprecated" : "",
390       "since" : "",
391       "see" : "",
392       "exceptions" : "",
393       "requires" : "",
394       "params" : [
395         {
396           "name" : "str",
397           "type" : "String",
398           "desc" : "new Title",
399           "isOptional" : false
400         }
401       ],
402       "returns" : []
403     },
404     {
405       "name" : "setBody",
406       "type" : "function",
407       "desc" : "Set the body of the Dialog",
408       "sig" : "(str)",
409       "static" : false,
410       "memberOf" : "",
411       "isStatic" : false,
412       "isConstructor" : false,
413       "isPrivate" : false,
414       "example" : "",
415       "deprecated" : "",
416       "since" : "",
417       "see" : "",
418       "exceptions" : "",
419       "requires" : "",
420       "params" : [
421         {
422           "name" : "str",
423           "type" : "String",
424           "desc" : "new Title",
425           "isOptional" : false
426         }
427       ],
428       "returns" : []
429     },
430     {
431       "name" : "tooltipEl",
432       "type" : "function",
433       "desc" : "Fetch the element to display the tooltip on.",
434       "sig" : "()\n{\n\n}",
435       "static" : false,
436       "memberOf" : "Roo.bootstrap.Component",
437       "isStatic" : false,
438       "isConstructor" : false,
439       "isPrivate" : false,
440       "example" : "",
441       "deprecated" : "",
442       "since" : "",
443       "see" : "",
444       "exceptions" : "",
445       "requires" : "",
446       "params" : [],
447       "returns" : [
448         {
449           "name" : "",
450           "type" : "Roo.Element",
451           "desc" : "defaults to this.el"
452         }
453       ]
454     },
455     {
456       "name" : "hide",
457       "type" : "function",
458       "desc" : "Hide a component - adds 'hidden' class",
459       "sig" : "()\n{\n\n}",
460       "static" : false,
461       "memberOf" : "Roo.bootstrap.Component",
462       "isStatic" : false,
463       "isConstructor" : false,
464       "isPrivate" : false,
465       "example" : "",
466       "deprecated" : "",
467       "since" : "",
468       "see" : "",
469       "exceptions" : "",
470       "requires" : "",
471       "params" : [],
472       "returns" : []
473     },
474     {
475       "name" : "show",
476       "type" : "function",
477       "desc" : "Show a component - removes 'hidden' class",
478       "sig" : "()\n{\n\n}",
479       "static" : false,
480       "memberOf" : "Roo.bootstrap.Component",
481       "isStatic" : false,
482       "isConstructor" : false,
483       "isPrivate" : false,
484       "example" : "",
485       "deprecated" : "",
486       "since" : "",
487       "see" : "",
488       "exceptions" : "",
489       "requires" : "",
490       "params" : [],
491       "returns" : []
492     },
493     {
494       "name" : "setVisibilityEl",
495       "type" : "function",
496       "desc" : "Set the element that will be used to show or hide",
497       "sig" : "()\n{\n\n}",
498       "static" : false,
499       "memberOf" : "Roo.bootstrap.Component",
500       "isStatic" : false,
501       "isConstructor" : false,
502       "isPrivate" : false,
503       "example" : "",
504       "deprecated" : "",
505       "since" : "",
506       "see" : "",
507       "exceptions" : "",
508       "requires" : "",
509       "params" : [],
510       "returns" : []
511     },
512     {
513       "name" : "getVisibilityEl",
514       "type" : "function",
515       "desc" : "Get the element that will be used to show or hide",
516       "sig" : "()\n{\n\n}",
517       "static" : false,
518       "memberOf" : "Roo.bootstrap.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" : "initEvents",
533       "type" : "function",
534       "desc" : "Initialize Events for the element",
535       "sig" : "()\n{\n\n}",
536       "static" : false,
537       "memberOf" : "Roo.bootstrap.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" : "getChildContainer",
552       "type" : "function",
553       "desc" : "Fetch the element to add children to",
554       "sig" : "()\n{\n\n}",
555       "static" : false,
556       "memberOf" : "Roo.bootstrap.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       "returns" : [
568         {
569           "name" : "",
570           "type" : "Roo.Element",
571           "desc" : "defaults to this.el"
572         }
573       ]
574     },
575     {
576       "name" : "getId",
577       "type" : "function",
578       "desc" : "Returns the id of this component.",
579       "sig" : "()\n{\n\n}",
580       "static" : false,
581       "memberOf" : "Roo.Component",
582       "isStatic" : false,
583       "isConstructor" : false,
584       "isPrivate" : false,
585       "example" : "",
586       "deprecated" : "",
587       "since" : "",
588       "see" : "",
589       "exceptions" : "",
590       "requires" : "",
591       "params" : [],
592       "returns" : [
593         {
594           "name" : "",
595           "type" : "String",
596           "desc" : ""
597         }
598       ]
599     },
600     {
601       "name" : "render",
602       "type" : "function",
603       "desc" : "If this is a lazy rendering component, render it to its container element.",
604       "sig" : "(container)",
605       "static" : false,
606       "memberOf" : "Roo.Component",
607       "isStatic" : false,
608       "isConstructor" : false,
609       "isPrivate" : false,
610       "example" : "",
611       "deprecated" : "",
612       "since" : "",
613       "see" : "",
614       "exceptions" : "",
615       "requires" : "",
616       "params" : [
617         {
618           "name" : "container",
619           "type" : "String/HTMLElement/Element",
620           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
621           "isOptional" : false
622         }
623       ],
624       "returns" : []
625     },
626     {
627       "name" : "destroy",
628       "type" : "function",
629       "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}.",
630       "sig" : "()\n{\n\n}",
631       "static" : false,
632       "memberOf" : "Roo.Component",
633       "isStatic" : false,
634       "isConstructor" : false,
635       "isPrivate" : false,
636       "example" : "",
637       "deprecated" : "",
638       "since" : "",
639       "see" : "",
640       "exceptions" : "",
641       "requires" : "",
642       "params" : [],
643       "returns" : []
644     },
645     {
646       "name" : "isVisible",
647       "type" : "function",
648       "desc" : "Returns true if this component is visible.",
649       "sig" : "()\n{\n\n}",
650       "static" : false,
651       "memberOf" : "Roo.Component",
652       "isStatic" : false,
653       "isConstructor" : false,
654       "isPrivate" : false,
655       "example" : "",
656       "deprecated" : "",
657       "since" : "",
658       "see" : "",
659       "exceptions" : "",
660       "requires" : "",
661       "params" : [],
662       "returns" : []
663     },
664     {
665       "name" : "setDisabled",
666       "type" : "function",
667       "desc" : "Convenience function for setting disabled/enabled by boolean.",
668       "sig" : "(disabled)",
669       "static" : false,
670       "memberOf" : "Roo.Component",
671       "isStatic" : false,
672       "isConstructor" : false,
673       "isPrivate" : false,
674       "example" : "",
675       "deprecated" : "",
676       "since" : "",
677       "see" : "",
678       "exceptions" : "",
679       "requires" : "",
680       "params" : [
681         {
682           "name" : "disabled",
683           "type" : "Boolean",
684           "desc" : "",
685           "isOptional" : false
686         }
687       ],
688       "returns" : []
689     },
690     {
691       "name" : "focus",
692       "type" : "function",
693       "desc" : "Try to focus this component.",
694       "sig" : "(selectText)",
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         {
708           "name" : "selectText",
709           "type" : "Boolean",
710           "desc" : "True to also select the text in this component (if applicable)",
711           "isOptional" : false
712         }
713       ],
714       "returns" : [
715         {
716           "name" : "",
717           "type" : "Roo.Component",
718           "desc" : "this"
719         }
720       ]
721     },
722     {
723       "name" : "enable",
724       "type" : "function",
725       "desc" : "Enable this component.",
726       "sig" : "()\n{\n\n}",
727       "static" : false,
728       "memberOf" : "Roo.Component",
729       "isStatic" : false,
730       "isConstructor" : false,
731       "isPrivate" : false,
732       "example" : "",
733       "deprecated" : "",
734       "since" : "",
735       "see" : "",
736       "exceptions" : "",
737       "requires" : "",
738       "params" : [],
739       "returns" : [
740         {
741           "name" : "",
742           "type" : "Roo.Component",
743           "desc" : "this"
744         }
745       ]
746     },
747     {
748       "name" : "setVisible",
749       "type" : "function",
750       "desc" : "Convenience function to hide or show this component by boolean.",
751       "sig" : "(visible)",
752       "static" : false,
753       "memberOf" : "Roo.Component",
754       "isStatic" : false,
755       "isConstructor" : false,
756       "isPrivate" : false,
757       "example" : "",
758       "deprecated" : "",
759       "since" : "",
760       "see" : "",
761       "exceptions" : "",
762       "requires" : "",
763       "params" : [
764         {
765           "name" : "visible",
766           "type" : "Boolean",
767           "desc" : "True to show, false to hide",
768           "isOptional" : false
769         }
770       ],
771       "returns" : [
772         {
773           "name" : "",
774           "type" : "Roo.Component",
775           "desc" : "this"
776         }
777       ]
778     },
779     {
780       "name" : "disable",
781       "type" : "function",
782       "desc" : "Disable this component.",
783       "sig" : "()\n{\n\n}",
784       "static" : false,
785       "memberOf" : "Roo.Component",
786       "isStatic" : false,
787       "isConstructor" : false,
788       "isPrivate" : false,
789       "example" : "",
790       "deprecated" : "",
791       "since" : "",
792       "see" : "",
793       "exceptions" : "",
794       "requires" : "",
795       "params" : [],
796       "returns" : [
797         {
798           "name" : "",
799           "type" : "Roo.Component",
800           "desc" : "this"
801         }
802       ]
803     },
804     {
805       "name" : "getEl",
806       "type" : "function",
807       "desc" : "Returns the underlying {@link Roo.Element}.",
808       "sig" : "()\n{\n\n}",
809       "static" : false,
810       "memberOf" : "Roo.Component",
811       "isStatic" : false,
812       "isConstructor" : false,
813       "isPrivate" : false,
814       "example" : "",
815       "deprecated" : "",
816       "since" : "",
817       "see" : "",
818       "exceptions" : "",
819       "requires" : "",
820       "params" : [],
821       "returns" : [
822         {
823           "name" : "",
824           "type" : "Roo.Element",
825           "desc" : "The element"
826         }
827       ]
828     },
829     {
830       "name" : "purgeListeners",
831       "type" : "function",
832       "desc" : "Removes all listeners for this object",
833       "sig" : "()\n{\n\n}",
834       "static" : false,
835       "memberOf" : "Roo.util.Observable",
836       "isStatic" : false,
837       "isConstructor" : false,
838       "isPrivate" : false,
839       "example" : "",
840       "deprecated" : "",
841       "since" : "",
842       "see" : "",
843       "exceptions" : "",
844       "requires" : "",
845       "params" : [],
846       "returns" : []
847     },
848     {
849       "name" : "on",
850       "type" : "function",
851       "desc" : "Appends an event handler to this element (shorthand for addListener)",
852       "sig" : "(eventName, handler, scope, options)",
853       "static" : false,
854       "memberOf" : "Roo.util.Observable",
855       "isStatic" : false,
856       "isConstructor" : false,
857       "isPrivate" : false,
858       "example" : "",
859       "deprecated" : "",
860       "since" : "",
861       "see" : "",
862       "exceptions" : "",
863       "requires" : "",
864       "params" : [
865         {
866           "name" : "eventName",
867           "type" : "String",
868           "desc" : "The type of event to listen for",
869           "isOptional" : false
870         },
871         {
872           "name" : "handler",
873           "type" : "Function",
874           "desc" : "The method the event invokes",
875           "isOptional" : false
876         },
877         {
878           "name" : "scope",
879           "type" : "Object",
880           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
881           "isOptional" : false
882         },
883         {
884           "name" : "options",
885           "type" : "Object",
886           "desc" : "(optional)",
887           "isOptional" : false
888         }
889       ],
890       "returns" : []
891     },
892     {
893       "name" : "un",
894       "type" : "function",
895       "desc" : "Removes a listener (shorthand for removeListener)",
896       "sig" : "(eventName, handler, scope)",
897       "static" : false,
898       "memberOf" : "Roo.util.Observable",
899       "isStatic" : false,
900       "isConstructor" : false,
901       "isPrivate" : false,
902       "example" : "",
903       "deprecated" : "",
904       "since" : "",
905       "see" : "",
906       "exceptions" : "",
907       "requires" : "",
908       "params" : [
909         {
910           "name" : "eventName",
911           "type" : "String",
912           "desc" : "The type of event to listen for",
913           "isOptional" : false
914         },
915         {
916           "name" : "handler",
917           "type" : "Function",
918           "desc" : "The handler to remove",
919           "isOptional" : false
920         },
921         {
922           "name" : "scope",
923           "type" : "Object",
924           "desc" : "(optional) The scope (this object) for the handler",
925           "isOptional" : false
926         }
927       ],
928       "returns" : []
929     },
930     {
931       "name" : "addEvents",
932       "type" : "function",
933       "desc" : "Used to define events on this Observable",
934       "sig" : "(object)",
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" : "object",
949           "type" : "Object",
950           "desc" : "The object with the events defined",
951           "isOptional" : false
952         }
953       ],
954       "returns" : []
955     },
956     {
957       "name" : "releaseCapture",
958       "type" : "function",
959       "desc" : "Removes <b>all</b> added captures from the Observable.",
960       "sig" : "(o)",
961       "static" : true,
962       "memberOf" : "Roo.util.Observable",
963       "isStatic" : true,
964       "isConstructor" : false,
965       "isPrivate" : false,
966       "example" : "",
967       "deprecated" : "",
968       "since" : "",
969       "see" : "",
970       "exceptions" : "",
971       "requires" : "",
972       "params" : [
973         {
974           "name" : "o",
975           "type" : "Observable",
976           "desc" : "The Observable to release",
977           "isOptional" : false
978         }
979       ],
980       "returns" : []
981     },
982     {
983       "name" : "removeListener",
984       "type" : "function",
985       "desc" : "Removes a listener",
986       "sig" : "(eventName, handler, scope)",
987       "static" : false,
988       "memberOf" : "Roo.util.Observable",
989       "isStatic" : false,
990       "isConstructor" : false,
991       "isPrivate" : false,
992       "example" : "",
993       "deprecated" : "",
994       "since" : "",
995       "see" : "",
996       "exceptions" : "",
997       "requires" : "",
998       "params" : [
999         {
1000           "name" : "eventName",
1001           "type" : "String",
1002           "desc" : "The type of event to listen for",
1003           "isOptional" : false
1004         },
1005         {
1006           "name" : "handler",
1007           "type" : "Function",
1008           "desc" : "The handler to remove",
1009           "isOptional" : false
1010         },
1011         {
1012           "name" : "scope",
1013           "type" : "Object",
1014           "desc" : "(optional) The scope (this object) for the handler",
1015           "isOptional" : false
1016         }
1017       ],
1018       "returns" : []
1019     },
1020     {
1021       "name" : "fireEvent",
1022       "type" : "function",
1023       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1024       "sig" : "(eventName, args)",
1025       "static" : false,
1026       "memberOf" : "Roo.util.Observable",
1027       "isStatic" : false,
1028       "isConstructor" : false,
1029       "isPrivate" : false,
1030       "example" : "",
1031       "deprecated" : "",
1032       "since" : "",
1033       "see" : "",
1034       "exceptions" : "",
1035       "requires" : "",
1036       "params" : [
1037         {
1038           "name" : "eventName",
1039           "type" : "String",
1040           "desc" : "",
1041           "isOptional" : false
1042         },
1043         {
1044           "name" : "args",
1045           "type" : "Object...",
1046           "desc" : "Variable number of parameters are passed to handlers",
1047           "isOptional" : false
1048         }
1049       ],
1050       "returns" : [
1051         {
1052           "name" : "",
1053           "type" : "Boolean",
1054           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1055         }
1056       ]
1057     },
1058     {
1059       "name" : "hasListener",
1060       "type" : "function",
1061       "desc" : "Checks to see if this object has any listeners for a specified event",
1062       "sig" : "(eventName)",
1063       "static" : false,
1064       "memberOf" : "Roo.util.Observable",
1065       "isStatic" : false,
1066       "isConstructor" : false,
1067       "isPrivate" : false,
1068       "example" : "",
1069       "deprecated" : "",
1070       "since" : "",
1071       "see" : "",
1072       "exceptions" : "",
1073       "requires" : "",
1074       "params" : [
1075         {
1076           "name" : "eventName",
1077           "type" : "String",
1078           "desc" : "The name of the event to check for",
1079           "isOptional" : false
1080         }
1081       ],
1082       "returns" : [
1083         {
1084           "name" : "",
1085           "type" : "Boolean",
1086           "desc" : "True if the event is being listened for, else false"
1087         }
1088       ]
1089     },
1090     {
1091       "name" : "capture",
1092       "type" : "function",
1093       "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.",
1094       "sig" : "(o, fn, scope)",
1095       "static" : true,
1096       "memberOf" : "Roo.util.Observable",
1097       "isStatic" : true,
1098       "isConstructor" : false,
1099       "isPrivate" : false,
1100       "example" : "",
1101       "deprecated" : "",
1102       "since" : "",
1103       "see" : "",
1104       "exceptions" : "",
1105       "requires" : "",
1106       "params" : [
1107         {
1108           "name" : "o",
1109           "type" : "Observable",
1110           "desc" : "The Observable to capture",
1111           "isOptional" : false
1112         },
1113         {
1114           "name" : "fn",
1115           "type" : "Function",
1116           "desc" : "The function to call",
1117           "isOptional" : false
1118         },
1119         {
1120           "name" : "scope",
1121           "type" : "Object",
1122           "desc" : "(optional) The scope (this object) for the fn",
1123           "isOptional" : false
1124         }
1125       ],
1126       "returns" : []
1127     },
1128     {
1129       "name" : "addListener",
1130       "type" : "function",
1131       "desc" : "Appends an event handler to this component",
1132       "sig" : "(eventName, handler, scope, options)",
1133       "static" : false,
1134       "memberOf" : "Roo.util.Observable",
1135       "isStatic" : false,
1136       "isConstructor" : false,
1137       "isPrivate" : false,
1138       "example" : "",
1139       "deprecated" : "",
1140       "since" : "",
1141       "see" : "",
1142       "exceptions" : "",
1143       "requires" : "",
1144       "params" : [
1145         {
1146           "name" : "eventName",
1147           "type" : "String",
1148           "desc" : "The type of event to listen for",
1149           "isOptional" : false
1150         },
1151         {
1152           "name" : "handler",
1153           "type" : "Function",
1154           "desc" : "The method the event invokes",
1155           "isOptional" : false
1156         },
1157         {
1158           "name" : "scope",
1159           "type" : "Object",
1160           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1161           "isOptional" : false
1162         },
1163         {
1164           "name" : "options",
1165           "type" : "Object",
1166           "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>",
1167           "isOptional" : false
1168         }
1169       ],
1170       "returns" : []
1171     }
1172   ],
1173   "events" : [
1174     {
1175       "name" : "titlechanged",
1176       "type" : "function",
1177       "desc" : "Fire when the editable title has been changed",
1178       "sig" : "function (_self, value)\n{\n\n}",
1179       "memberOf" : "",
1180       "example" : "",
1181       "deprecated" : "",
1182       "since" : "",
1183       "see" : "",
1184       "params" : [
1185         {
1186           "name" : "this",
1187           "type" : "Roo.bootstrap.Modal",
1188           "desc" : "",
1189           "isOptional" : false
1190         },
1191         {
1192           "name" : "value",
1193           "type" : "Roo.EventObject",
1194           "desc" : "",
1195           "isOptional" : false
1196         }
1197       ],
1198       "returns" : []
1199     },
1200     {
1201       "name" : "btnclick",
1202       "type" : "function",
1203       "desc" : "The raw btnclick event for the button",
1204       "sig" : "function (e)\n{\n\n}",
1205       "memberOf" : "",
1206       "example" : "",
1207       "deprecated" : "",
1208       "since" : "",
1209       "see" : "",
1210       "params" : [
1211         {
1212           "name" : "e",
1213           "type" : "Roo.EventObject",
1214           "desc" : "",
1215           "isOptional" : false
1216         }
1217       ],
1218       "returns" : []
1219     },
1220     {
1221       "name" : "resize",
1222       "type" : "function",
1223       "desc" : "Fire when dialog resize",
1224       "sig" : "function (_self, e)\n{\n\n}",
1225       "memberOf" : "",
1226       "example" : "",
1227       "deprecated" : "",
1228       "since" : "",
1229       "see" : "",
1230       "params" : [
1231         {
1232           "name" : "this",
1233           "type" : "Roo.bootstrap.Modal",
1234           "desc" : "",
1235           "isOptional" : false
1236         },
1237         {
1238           "name" : "e",
1239           "type" : "Roo.EventObject",
1240           "desc" : "",
1241           "isOptional" : false
1242         }
1243       ],
1244       "returns" : []
1245     },
1246     {
1247       "name" : "childrenrendered",
1248       "type" : "function",
1249       "desc" : "Fires when the children have been rendered..",
1250       "sig" : "function (_self)\n{\n\n}",
1251       "memberOf" : "Roo.bootstrap.Component",
1252       "example" : "",
1253       "deprecated" : "",
1254       "since" : "",
1255       "see" : "",
1256       "params" : [
1257         {
1258           "name" : "this",
1259           "type" : "Roo.bootstrap.Component",
1260           "desc" : "",
1261           "isOptional" : false
1262         }
1263       ],
1264       "returns" : []
1265     },
1266     {
1267       "name" : "beforerender",
1268       "type" : "function",
1269       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1270       "sig" : "function (_self)\n{\n\n}",
1271       "memberOf" : "Roo.Component",
1272       "example" : "",
1273       "deprecated" : "",
1274       "since" : "",
1275       "see" : "",
1276       "params" : [
1277         {
1278           "name" : "this",
1279           "type" : "Roo.Component",
1280           "desc" : "",
1281           "isOptional" : false
1282         }
1283       ],
1284       "returns" : []
1285     },
1286     {
1287       "name" : "disable",
1288       "type" : "function",
1289       "desc" : "Fires after the component is disabled.",
1290       "sig" : "function (_self)\n{\n\n}",
1291       "memberOf" : "Roo.Component",
1292       "example" : "",
1293       "deprecated" : "",
1294       "since" : "",
1295       "see" : "",
1296       "params" : [
1297         {
1298           "name" : "this",
1299           "type" : "Roo.Component",
1300           "desc" : "",
1301           "isOptional" : false
1302         }
1303       ],
1304       "returns" : []
1305     },
1306     {
1307       "name" : "render",
1308       "type" : "function",
1309       "desc" : "Fires after the component is rendered.",
1310       "sig" : "function (_self)\n{\n\n}",
1311       "memberOf" : "Roo.Component",
1312       "example" : "",
1313       "deprecated" : "",
1314       "since" : "",
1315       "see" : "",
1316       "params" : [
1317         {
1318           "name" : "this",
1319           "type" : "Roo.Component",
1320           "desc" : "",
1321           "isOptional" : false
1322         }
1323       ],
1324       "returns" : []
1325     },
1326     {
1327       "name" : "destroy",
1328       "type" : "function",
1329       "desc" : "Fires after the component is destroyed.",
1330       "sig" : "function (_self)\n{\n\n}",
1331       "memberOf" : "Roo.Component",
1332       "example" : "",
1333       "deprecated" : "",
1334       "since" : "",
1335       "see" : "",
1336       "params" : [
1337         {
1338           "name" : "this",
1339           "type" : "Roo.Component",
1340           "desc" : "",
1341           "isOptional" : false
1342         }
1343       ],
1344       "returns" : []
1345     },
1346     {
1347       "name" : "hide",
1348       "type" : "function",
1349       "desc" : "Fires after the component is hidden.",
1350       "sig" : "function (_self)\n{\n\n}",
1351       "memberOf" : "Roo.Component",
1352       "example" : "",
1353       "deprecated" : "",
1354       "since" : "",
1355       "see" : "",
1356       "params" : [
1357         {
1358           "name" : "this",
1359           "type" : "Roo.Component",
1360           "desc" : "",
1361           "isOptional" : false
1362         }
1363       ],
1364       "returns" : []
1365     },
1366     {
1367       "name" : "beforehide",
1368       "type" : "function",
1369       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1370       "sig" : "function (_self)\n{\n\n}",
1371       "memberOf" : "Roo.Component",
1372       "example" : "",
1373       "deprecated" : "",
1374       "since" : "",
1375       "see" : "",
1376       "params" : [
1377         {
1378           "name" : "this",
1379           "type" : "Roo.Component",
1380           "desc" : "",
1381           "isOptional" : false
1382         }
1383       ],
1384       "returns" : []
1385     },
1386     {
1387       "name" : "show",
1388       "type" : "function",
1389       "desc" : "Fires after the component is shown.",
1390       "sig" : "function (_self)\n{\n\n}",
1391       "memberOf" : "Roo.Component",
1392       "example" : "",
1393       "deprecated" : "",
1394       "since" : "",
1395       "see" : "",
1396       "params" : [
1397         {
1398           "name" : "this",
1399           "type" : "Roo.Component",
1400           "desc" : "",
1401           "isOptional" : false
1402         }
1403       ],
1404       "returns" : []
1405     },
1406     {
1407       "name" : "beforeshow",
1408       "type" : "function",
1409       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1410       "sig" : "function (_self)\n{\n\n}",
1411       "memberOf" : "Roo.Component",
1412       "example" : "",
1413       "deprecated" : "",
1414       "since" : "",
1415       "see" : "",
1416       "params" : [
1417         {
1418           "name" : "this",
1419           "type" : "Roo.Component",
1420           "desc" : "",
1421           "isOptional" : false
1422         }
1423       ],
1424       "returns" : []
1425     },
1426     {
1427       "name" : "enable",
1428       "type" : "function",
1429       "desc" : "Fires after the component is enabled.",
1430       "sig" : "function (_self)\n{\n\n}",
1431       "memberOf" : "Roo.Component",
1432       "example" : "",
1433       "deprecated" : "",
1434       "since" : "",
1435       "see" : "",
1436       "params" : [
1437         {
1438           "name" : "this",
1439           "type" : "Roo.Component",
1440           "desc" : "",
1441           "isOptional" : false
1442         }
1443       ],
1444       "returns" : []
1445     },
1446     {
1447       "name" : "beforedestroy",
1448       "type" : "function",
1449       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1450       "sig" : "function (_self)\n{\n\n}",
1451       "memberOf" : "Roo.Component",
1452       "example" : "",
1453       "deprecated" : "",
1454       "since" : "",
1455       "see" : "",
1456       "params" : [
1457         {
1458           "name" : "this",
1459           "type" : "Roo.Component",
1460           "desc" : "",
1461           "isOptional" : false
1462         }
1463       ],
1464       "returns" : []
1465     }
1466   ]
1467 }