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