sync
[roojs1] / docs / symbols / Roo.LayoutDialog.json
1 {
2   "name" : "Roo.LayoutDialog",
3   "augments" : [
4     "Roo.BasicDialog",
5     "Roo.util.Observable"
6   ],
7   "desc" : "Dialog which provides adjustments for working with a layout in a Dialog.\nAdd your necessary layout config options to the dialog's config.<br>\nExample usage (including a nested layout):\n<pre><code>\nif(!dialog){\n    dialog = new Roo.LayoutDialog(\"download-dlg\", {\n        modal: true,\n        width:600,\n        height:450,\n        shadow:true,\n        minWidth:500,\n        minHeight:350,\n        autoTabs:true,\n        proxyDrag:true,\n        // layout config merges with the dialog config\n        center:{\n            tabPosition: \"top\",\n            alwaysShowTabs: true\n        }\n    });\n    dialog.addKeyListener(27, dialog.hide, dialog);\n    dialog.setDefaultButton(dialog.addButton(\"Close\", dialog.hide, dialog));\n    dialog.addButton(\"Build It!\", this.getDownload, this);\n\n    // we can even add nested layouts\n    var innerLayout = new Roo.BorderLayout(\"dl-inner\", {\n        east: {\n            initialSize: 200,\n            autoScroll:true,\n            split:true\n        },\n        center: {\n            autoScroll:true\n        }\n    });\n    innerLayout.beginUpdate();\n    innerLayout.add(\"east\", new Roo.ContentPanel(\"dl-details\"));\n    innerLayout.add(\"center\", new Roo.ContentPanel(\"selection-panel\"));\n    innerLayout.endUpdate(true);\n\n    var layout = dialog.getLayout();\n    layout.beginUpdate();\n    layout.add(\"center\", new Roo.ContentPanel(\"standard-panel\",\n                        {title: \"Download the Source\", fitToFrame:true}));\n    layout.add(\"center\", new Roo.NestedLayoutPanel(innerLayout,\n               {title: \"Build your own roo.js\"}));\n    layout.getRegion(\"center\").showPanel(sp);\n    layout.endUpdate();\n}\n</code></pre>",
8   "isSingleton" : false,
9   "isStatic" : false,
10   "isBuiltin" : false,
11   "memberOf" : "LayoutDialog",
12   "example" : "",
13   "deprecated" : "",
14   "since" : "",
15   "see" : "",
16   "params" : [
17     {
18       "name" : "el",
19       "type" : "String/HTMLElement/Roo.Element",
20       "desc" : "The id of or container element, or config",
21       "isOptional" : false
22     },
23     {
24       "name" : "config",
25       "type" : "Object",
26       "desc" : "configuration options",
27       "isOptional" : false
28     }
29   ],
30   "returns" : [],
31   "throws" : "",
32   "requires" : "",
33   "config" : [
34     {
35       "name" : "buttons[]",
36       "type" : "Roo.Button",
37       "desc" : "Bottom buttons..",
38       "memberOf" : ""
39     },
40     {
41       "name" : "minButtonWidth",
42       "type" : "Number",
43       "desc" : "Minimum width of all dialog buttons (defaults to 75)",
44       "memberOf" : "Roo.BasicDialog"
45     },
46     {
47       "name" : "west",
48       "type" : "Roo.LayoutRegion",
49       "desc" : "",
50       "memberOf" : ""
51     },
52     {
53       "name" : "fixedcenter",
54       "type" : "Boolean",
55       "desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
56       "memberOf" : "Roo.BasicDialog"
57     },
58     {
59       "name" : "minWidth",
60       "type" : "Number",
61       "desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
62       "memberOf" : "Roo.BasicDialog"
63     },
64     {
65       "name" : "title",
66       "type" : "String",
67       "desc" : "Default text to display in the title bar (defaults to null)",
68       "memberOf" : "Roo.BasicDialog"
69     },
70     {
71       "name" : "center",
72       "type" : "Roo.LayoutRegion",
73       "desc" : "",
74       "memberOf" : ""
75     },
76     {
77       "name" : "resizable",
78       "type" : "Boolean",
79       "desc" : "False to disable manual dialog resizing (defaults to true)",
80       "memberOf" : "Roo.BasicDialog"
81     },
82     {
83       "name" : "resizeHandles",
84       "type" : "String",
85       "desc" : "Which resize handles to display - see the {@link Roo.Resizable} handles config\nproperty for valid values (defaults to 'all')",
86       "memberOf" : "Roo.BasicDialog"
87     },
88     {
89       "name" : "width",
90       "type" : "Number",
91       "desc" : "Width of the dialog in pixels (can also be set via CSS).  Determined by browser if unspecified.",
92       "memberOf" : "Roo.BasicDialog"
93     },
94     {
95       "name" : "shim",
96       "type" : "Boolean",
97       "desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
98       "memberOf" : "Roo.BasicDialog"
99     },
100     {
101       "name" : "proxyDrag",
102       "type" : "Boolean",
103       "desc" : "True to drag a lightweight proxy element rather than the dialog itself, used when\ndraggable = true (defaults to false)",
104       "memberOf" : "Roo.BasicDialog"
105     },
106     {
107       "name" : "autoTabs",
108       "type" : "Boolean",
109       "desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
110       "memberOf" : "Roo.BasicDialog"
111     },
112     {
113       "name" : "height",
114       "type" : "Number",
115       "desc" : "Height of the dialog in pixels (can also be set via CSS).  Determined by browser if unspecified.",
116       "memberOf" : "Roo.BasicDialog"
117     },
118     {
119       "name" : "constraintoviewport",
120       "type" : "Boolean",
121       "desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
122       "memberOf" : "Roo.BasicDialog"
123     },
124     {
125       "name" : "shadowOffset",
126       "type" : "Number",
127       "desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
128       "memberOf" : "Roo.BasicDialog"
129     },
130     {
131       "name" : "draggable",
132       "type" : "Boolean",
133       "desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
134       "memberOf" : "Roo.BasicDialog"
135     },
136     {
137       "name" : "listeners",
138       "type" : "Object",
139       "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>",
140       "memberOf" : "Roo.util.Observable"
141     },
142     {
143       "name" : "south",
144       "type" : "Roo.LayoutRegion",
145       "desc" : "",
146       "memberOf" : ""
147     },
148     {
149       "name" : "east",
150       "type" : "Roo.LayoutRegion",
151       "desc" : "",
152       "memberOf" : ""
153     },
154     {
155       "name" : "shadow",
156       "type" : "Boolean/String",
157       "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
158       "memberOf" : "Roo.BasicDialog"
159     },
160     {
161       "name" : "x",
162       "type" : "Number",
163       "desc" : "The default left page coordinate of the dialog (defaults to center screen)",
164       "memberOf" : "Roo.BasicDialog"
165     },
166     {
167       "name" : "collapsible",
168       "type" : "Boolean",
169       "desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
170       "memberOf" : "Roo.BasicDialog"
171     },
172     {
173       "name" : "y",
174       "type" : "Number",
175       "desc" : "The default top page coordinate of the dialog (defaults to center screen)",
176       "memberOf" : "Roo.BasicDialog"
177     },
178     {
179       "name" : "north",
180       "type" : "Roo.LayoutRegion",
181       "desc" : "",
182       "memberOf" : ""
183     },
184     {
185       "name" : "buttons",
186       "type" : "Array",
187       "desc" : "Array of buttons",
188       "memberOf" : "Roo.BasicDialog"
189     },
190     {
191       "name" : "animateTarget",
192       "type" : "String/Element",
193       "desc" : "Id or element from which the dialog should animate while opening\n(defaults to null with no animation)",
194       "memberOf" : "Roo.BasicDialog"
195     },
196     {
197       "name" : "closable",
198       "type" : "Boolean",
199       "desc" : "False to remove the built-in top-right corner close button (defaults to true)",
200       "memberOf" : "Roo.BasicDialog"
201     },
202     {
203       "name" : "autoCreate",
204       "type" : "Boolean/DomHelper",
205       "desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
206       "memberOf" : "Roo.BasicDialog"
207     },
208     {
209       "name" : "autoScroll",
210       "type" : "Boolean",
211       "desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
212       "memberOf" : "Roo.BasicDialog"
213     },
214     {
215       "name" : "modal",
216       "type" : "Boolean",
217       "desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
218       "memberOf" : "Roo.BasicDialog"
219     },
220     {
221       "name" : "tabTag",
222       "type" : "String",
223       "desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
224       "memberOf" : "Roo.BasicDialog"
225     },
226     {
227       "name" : "minHeight",
228       "type" : "Number",
229       "desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
230       "memberOf" : "Roo.BasicDialog"
231     },
232     {
233       "name" : "syncHeightBeforeShow",
234       "type" : "Boolean",
235       "desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
236       "memberOf" : "Roo.BasicDialog"
237     },
238     {
239       "name" : "buttonAlign",
240       "type" : "String",
241       "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
242       "memberOf" : "Roo.BasicDialog"
243     }
244   ],
245   "methods" : [
246     {
247       "name" : "addxtype",
248       "type" : "function",
249       "desc" : "Add an xtype element (actually adds to the layout.)",
250       "sig" : "()\n{\n\n}",
251       "static" : false,
252       "memberOf" : "",
253       "isStatic" : false,
254       "isConstructor" : false,
255       "isPrivate" : false,
256       "example" : "",
257       "deprecated" : "",
258       "since" : "",
259       "see" : "",
260       "exceptions" : "",
261       "requires" : "",
262       "params" : [],
263       "returns" : [
264         {
265           "name" : "",
266           "type" : "Object",
267           "desc" : "xdata xtype object data."
268         }
269       ]
270     },
271     {
272       "name" : "getLayout",
273       "type" : "function",
274       "desc" : "Get the BorderLayout for this dialog",
275       "sig" : "()\n{\n\n}",
276       "static" : false,
277       "memberOf" : "",
278       "isStatic" : false,
279       "isConstructor" : false,
280       "isPrivate" : false,
281       "example" : "",
282       "deprecated" : "",
283       "since" : "",
284       "see" : "",
285       "exceptions" : "",
286       "requires" : "",
287       "params" : [],
288       "returns" : [
289         {
290           "name" : "",
291           "type" : "Roo.BorderLayout",
292           "desc" : ""
293         }
294       ]
295     },
296     {
297       "name" : "endUpdate",
298       "type" : "function",
299       "desc" : "Ends update of the layout <strike>and resets display to none</strike>. Use standard beginUpdate/endUpdate on the layout.",
300       "sig" : "()\n{\n\n}",
301       "static" : false,
302       "memberOf" : "",
303       "isStatic" : false,
304       "isConstructor" : false,
305       "isPrivate" : false,
306       "example" : "",
307       "deprecated" : "This has been deprecated: ",
308       "since" : "",
309       "see" : "",
310       "exceptions" : "",
311       "requires" : "",
312       "params" : [],
313       "returns" : []
314     },
315     {
316       "name" : "beginUpdate",
317       "type" : "function",
318       "desc" : "Begins an update of the layout <strike>and sets display to block and visibility to hidden</strike>. Use standard beginUpdate/endUpdate on the layout.",
319       "sig" : "()\n{\n\n}",
320       "static" : false,
321       "memberOf" : "",
322       "isStatic" : false,
323       "isConstructor" : false,
324       "isPrivate" : false,
325       "example" : "",
326       "deprecated" : "This has been deprecated: ",
327       "since" : "",
328       "see" : "",
329       "exceptions" : "",
330       "requires" : "",
331       "params" : [],
332       "returns" : []
333     },
334     {
335       "name" : "expand",
336       "type" : "function",
337       "desc" : "Expands a collapsed dialog back to its normal state.  Equivalent to the user\nclicking the expand dialog button.",
338       "sig" : "()\n{\n\n}",
339       "static" : false,
340       "memberOf" : "Roo.BasicDialog",
341       "isStatic" : false,
342       "isConstructor" : false,
343       "isPrivate" : false,
344       "example" : "",
345       "deprecated" : "",
346       "since" : "",
347       "see" : "",
348       "exceptions" : "",
349       "requires" : "",
350       "params" : [],
351       "returns" : []
352     },
353     {
354       "name" : "alignTo",
355       "type" : "function",
356       "desc" : "Aligns the dialog to the specified element",
357       "sig" : "(element, position, offsets)",
358       "static" : false,
359       "memberOf" : "Roo.BasicDialog",
360       "isStatic" : false,
361       "isConstructor" : false,
362       "isPrivate" : false,
363       "example" : "",
364       "deprecated" : "",
365       "since" : "",
366       "see" : "",
367       "exceptions" : "",
368       "requires" : "",
369       "params" : [
370         {
371           "name" : "element",
372           "type" : "String/HTMLElement/Roo.Element",
373           "desc" : "The element to align to.",
374           "isOptional" : false
375         },
376         {
377           "name" : "position",
378           "type" : "String",
379           "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details).",
380           "isOptional" : false
381         },
382         {
383           "name" : "offsets",
384           "type" : "Array",
385           "desc" : "(optional) Offset the positioning by [x, y]",
386           "isOptional" : false
387         }
388       ],
389       "returns" : [
390         {
391           "name" : "",
392           "type" : "Roo.BasicDialog",
393           "desc" : "this"
394         }
395       ]
396     },
397     {
398       "name" : "setTitle",
399       "type" : "function",
400       "desc" : "Sets the dialog title text",
401       "sig" : "(text)",
402       "static" : false,
403       "memberOf" : "Roo.BasicDialog",
404       "isStatic" : false,
405       "isConstructor" : false,
406       "isPrivate" : false,
407       "example" : "",
408       "deprecated" : "",
409       "since" : "",
410       "see" : "",
411       "exceptions" : "",
412       "requires" : "",
413       "params" : [
414         {
415           "name" : "text",
416           "type" : "String",
417           "desc" : "The title text to display",
418           "isOptional" : false
419         }
420       ],
421       "returns" : [
422         {
423           "name" : "",
424           "type" : "Roo.BasicDialog",
425           "desc" : "this"
426         }
427       ]
428     },
429     {
430       "name" : "isVisible",
431       "type" : "function",
432       "desc" : "Returns true if the dialog is visible",
433       "sig" : "()\n{\n\n}",
434       "static" : false,
435       "memberOf" : "Roo.BasicDialog",
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           "name" : "",
449           "type" : "Boolean",
450           "desc" : ""
451         }
452       ]
453     },
454     {
455       "name" : "resizeTo",
456       "type" : "function",
457       "desc" : "Resizes the dialog.",
458       "sig" : "(width, height)",
459       "static" : false,
460       "memberOf" : "Roo.BasicDialog",
461       "isStatic" : false,
462       "isConstructor" : false,
463       "isPrivate" : false,
464       "example" : "",
465       "deprecated" : "",
466       "since" : "",
467       "see" : "",
468       "exceptions" : "",
469       "requires" : "",
470       "params" : [
471         {
472           "name" : "width",
473           "type" : "Number",
474           "desc" : "",
475           "isOptional" : false
476         },
477         {
478           "name" : "height",
479           "type" : "Number",
480           "desc" : "",
481           "isOptional" : false
482         }
483       ],
484       "returns" : [
485         {
486           "name" : "",
487           "type" : "Roo.BasicDialog",
488           "desc" : "this"
489         }
490       ]
491     },
492     {
493       "name" : "center",
494       "type" : "function",
495       "desc" : "Centers this dialog in the viewport",
496       "sig" : "()\n{\n\n}",
497       "static" : false,
498       "memberOf" : "Roo.BasicDialog",
499       "isStatic" : false,
500       "isConstructor" : false,
501       "isPrivate" : false,
502       "example" : "",
503       "deprecated" : "",
504       "since" : "",
505       "see" : "",
506       "exceptions" : "",
507       "requires" : "",
508       "params" : [],
509       "returns" : [
510         {
511           "name" : "",
512           "type" : "Roo.BasicDialog",
513           "desc" : "this"
514         }
515       ]
516     },
517     {
518       "name" : "collapse",
519       "type" : "function",
520       "desc" : "Collapses the dialog to its minimized state (only the title bar is visible).\nEquivalent to the user clicking the collapse dialog button.",
521       "sig" : "()\n{\n\n}",
522       "static" : false,
523       "memberOf" : "Roo.BasicDialog",
524       "isStatic" : false,
525       "isConstructor" : false,
526       "isPrivate" : false,
527       "example" : "",
528       "deprecated" : "",
529       "since" : "",
530       "see" : "",
531       "exceptions" : "",
532       "requires" : "",
533       "params" : [],
534       "returns" : []
535     },
536     {
537       "name" : "initTabs",
538       "type" : "function",
539       "desc" : "Reinitializes the tabs component, clearing out old tabs and finding new ones.",
540       "sig" : "()\n{\n\n}",
541       "static" : false,
542       "memberOf" : "Roo.BasicDialog",
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.TabPanel",
557           "desc" : "The tabs component"
558         }
559       ]
560     },
561     {
562       "name" : "toFront",
563       "type" : "function",
564       "desc" : "Brings this dialog to the front of any other visible dialogs",
565       "sig" : "()\n{\n\n}",
566       "static" : false,
567       "memberOf" : "Roo.BasicDialog",
568       "isStatic" : false,
569       "isConstructor" : false,
570       "isPrivate" : false,
571       "example" : "",
572       "deprecated" : "",
573       "since" : "",
574       "see" : "",
575       "exceptions" : "",
576       "requires" : "",
577       "params" : [],
578       "returns" : [
579         {
580           "name" : "",
581           "type" : "Roo.BasicDialog",
582           "desc" : "this"
583         }
584       ]
585     },
586     {
587       "name" : "moveTo",
588       "type" : "function",
589       "desc" : "Moves the dialog's top-left corner to the specified point",
590       "sig" : "(x, y)",
591       "static" : false,
592       "memberOf" : "Roo.BasicDialog",
593       "isStatic" : false,
594       "isConstructor" : false,
595       "isPrivate" : false,
596       "example" : "",
597       "deprecated" : "",
598       "since" : "",
599       "see" : "",
600       "exceptions" : "",
601       "requires" : "",
602       "params" : [
603         {
604           "name" : "x",
605           "type" : "Number",
606           "desc" : "",
607           "isOptional" : false
608         },
609         {
610           "name" : "y",
611           "type" : "Number",
612           "desc" : "",
613           "isOptional" : false
614         }
615       ],
616       "returns" : [
617         {
618           "name" : "",
619           "type" : "Roo.BasicDialog",
620           "desc" : "this"
621         }
622       ]
623     },
624     {
625       "name" : "hide",
626       "type" : "function",
627       "desc" : "Hides the dialog.",
628       "sig" : "(callback)",
629       "static" : false,
630       "memberOf" : "Roo.BasicDialog",
631       "isStatic" : false,
632       "isConstructor" : false,
633       "isPrivate" : false,
634       "example" : "",
635       "deprecated" : "",
636       "since" : "",
637       "see" : "",
638       "exceptions" : "",
639       "requires" : "",
640       "params" : [
641         {
642           "name" : "callback",
643           "type" : "Function",
644           "desc" : "(optional) Function to call when the dialog is hidden",
645           "isOptional" : false
646         }
647       ],
648       "returns" : [
649         {
650           "name" : "",
651           "type" : "Roo.BasicDialog",
652           "desc" : "this"
653         }
654       ]
655     },
656     {
657       "name" : "destroy",
658       "type" : "function",
659       "desc" : "Destroys this dialog and all its supporting elements (including any tabs, shim,\nshadow, proxy, mask, etc.)  Also removes all event listeners.",
660       "sig" : "(removeEl)",
661       "static" : false,
662       "memberOf" : "Roo.BasicDialog",
663       "isStatic" : false,
664       "isConstructor" : false,
665       "isPrivate" : false,
666       "example" : "",
667       "deprecated" : "",
668       "since" : "",
669       "see" : "",
670       "exceptions" : "",
671       "requires" : "",
672       "params" : [
673         {
674           "name" : "removeEl",
675           "type" : "Boolean",
676           "desc" : "(optional) true to remove the element from the DOM",
677           "isOptional" : false
678         }
679       ],
680       "returns" : []
681     },
682     {
683       "name" : "show",
684       "type" : "function",
685       "desc" : "Shows the dialog.",
686       "sig" : "(animateTarget)",
687       "static" : false,
688       "memberOf" : "Roo.BasicDialog",
689       "isStatic" : false,
690       "isConstructor" : false,
691       "isPrivate" : false,
692       "example" : "",
693       "deprecated" : "",
694       "since" : "",
695       "see" : "",
696       "exceptions" : "",
697       "requires" : "",
698       "params" : [
699         {
700           "name" : "animateTarget",
701           "type" : "String/HTMLElement/Roo.Element",
702           "desc" : "(optional) Reset the animation target",
703           "isOptional" : false
704         }
705       ],
706       "returns" : [
707         {
708           "name" : "",
709           "type" : "Roo.BasicDialog",
710           "desc" : "this"
711         }
712       ]
713     },
714     {
715       "name" : "anchorTo",
716       "type" : "function",
717       "desc" : "Anchors an element to another element and realigns it when the window is resized.",
718       "sig" : "(element, position, offsets, monitorScroll)",
719       "static" : false,
720       "memberOf" : "Roo.BasicDialog",
721       "isStatic" : false,
722       "isConstructor" : false,
723       "isPrivate" : false,
724       "example" : "",
725       "deprecated" : "",
726       "since" : "",
727       "see" : "",
728       "exceptions" : "",
729       "requires" : "",
730       "params" : [
731         {
732           "name" : "element",
733           "type" : "String/HTMLElement/Roo.Element",
734           "desc" : "The element to align to.",
735           "isOptional" : false
736         },
737         {
738           "name" : "position",
739           "type" : "String",
740           "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details)",
741           "isOptional" : false
742         },
743         {
744           "name" : "offsets",
745           "type" : "Array",
746           "desc" : "(optional) Offset the positioning by [x, y]",
747           "isOptional" : false
748         },
749         {
750           "name" : "monitorScroll",
751           "type" : "Boolean/Number",
752           "desc" : "(optional) true to monitor body scroll and reposition. If this parameter\nis a number, it is used as the buffer delay (defaults to 50ms).",
753           "isOptional" : false
754         }
755       ],
756       "returns" : [
757         {
758           "name" : "",
759           "type" : "Roo.BasicDialog",
760           "desc" : "this"
761         }
762       ]
763     },
764     {
765       "name" : "addButton",
766       "type" : "function",
767       "desc" : "Adds a button to the footer section of the dialog.",
768       "sig" : "(config, handler, scope)",
769       "static" : false,
770       "memberOf" : "Roo.BasicDialog",
771       "isStatic" : false,
772       "isConstructor" : false,
773       "isPrivate" : false,
774       "example" : "",
775       "deprecated" : "",
776       "since" : "",
777       "see" : "",
778       "exceptions" : "",
779       "requires" : "",
780       "params" : [
781         {
782           "name" : "config",
783           "type" : "String/Object",
784           "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
785           "isOptional" : false
786         },
787         {
788           "name" : "handler",
789           "type" : "Function",
790           "desc" : "The function called when the button is clicked",
791           "isOptional" : false
792         },
793         {
794           "name" : "scope",
795           "type" : "Object",
796           "desc" : "(optional) The scope of the handler function (accepts position as a property)",
797           "isOptional" : false
798         }
799       ],
800       "returns" : [
801         {
802           "name" : "",
803           "type" : "Roo.Button",
804           "desc" : "The new button"
805         }
806       ]
807     },
808     {
809       "name" : "addKeyListener",
810       "type" : "function",
811       "desc" : "Adds a key listener for when this dialog is displayed.  This allows you to hook in a function that will be\nexecuted in response to a particular key being pressed while the dialog is active.",
812       "sig" : "(key, fn, scope)",
813       "static" : false,
814       "memberOf" : "Roo.BasicDialog",
815       "isStatic" : false,
816       "isConstructor" : false,
817       "isPrivate" : false,
818       "example" : "",
819       "deprecated" : "",
820       "since" : "",
821       "see" : "",
822       "exceptions" : "",
823       "requires" : "",
824       "params" : [
825         {
826           "name" : "key",
827           "type" : "Number/Array/Object",
828           "desc" : "Either the numeric key code, array of key codes or an object with the following options:\n                                 {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}",
829           "isOptional" : false
830         },
831         {
832           "name" : "fn",
833           "type" : "Function",
834           "desc" : "The function to call",
835           "isOptional" : false
836         },
837         {
838           "name" : "scope",
839           "type" : "Object",
840           "desc" : "(optional) The scope of the function",
841           "isOptional" : false
842         }
843       ],
844       "returns" : [
845         {
846           "name" : "",
847           "type" : "Roo.BasicDialog",
848           "desc" : "this"
849         }
850       ]
851     },
852     {
853       "name" : "focus",
854       "type" : "function",
855       "desc" : "Focuses the dialog.  If a defaultButton is set, it will receive focus, otherwise the\ndialog itself will receive focus.",
856       "sig" : "()\n{\n\n}",
857       "static" : false,
858       "memberOf" : "Roo.BasicDialog",
859       "isStatic" : false,
860       "isConstructor" : false,
861       "isPrivate" : false,
862       "example" : "",
863       "deprecated" : "",
864       "since" : "",
865       "see" : "",
866       "exceptions" : "",
867       "requires" : "",
868       "params" : [],
869       "returns" : []
870     },
871     {
872       "name" : "getTabs",
873       "type" : "function",
874       "desc" : "Returns the TabPanel component (creates it if it doesn't exist).\nNote: If you wish to simply check for the existence of tabs without creating them,\ncheck for a null 'tabs' property.",
875       "sig" : "()\n{\n\n}",
876       "static" : false,
877       "memberOf" : "Roo.BasicDialog",
878       "isStatic" : false,
879       "isConstructor" : false,
880       "isPrivate" : false,
881       "example" : "",
882       "deprecated" : "",
883       "since" : "",
884       "see" : "",
885       "exceptions" : "",
886       "requires" : "",
887       "params" : [],
888       "returns" : [
889         {
890           "name" : "",
891           "type" : "Roo.TabPanel",
892           "desc" : "The tabs component"
893         }
894       ]
895     },
896     {
897       "name" : "setDefaultButton",
898       "type" : "function",
899       "desc" : "Sets the default button to be focused when the dialog is displayed.",
900       "sig" : "(btn)",
901       "static" : false,
902       "memberOf" : "Roo.BasicDialog",
903       "isStatic" : false,
904       "isConstructor" : false,
905       "isPrivate" : false,
906       "example" : "",
907       "deprecated" : "",
908       "since" : "",
909       "see" : "",
910       "exceptions" : "",
911       "requires" : "",
912       "params" : [
913         {
914           "name" : "btn",
915           "type" : "Roo.BasicDialog.Button",
916           "desc" : "The button object returned by {@link #addButton}",
917           "isOptional" : false
918         }
919       ],
920       "returns" : [
921         {
922           "name" : "",
923           "type" : "Roo.BasicDialog",
924           "desc" : "this"
925         }
926       ]
927     },
928     {
929       "name" : "toBack",
930       "type" : "function",
931       "desc" : "Sends this dialog to the back (under) of any other visible dialogs",
932       "sig" : "()\n{\n\n}",
933       "static" : false,
934       "memberOf" : "Roo.BasicDialog",
935       "isStatic" : false,
936       "isConstructor" : false,
937       "isPrivate" : false,
938       "example" : "",
939       "deprecated" : "",
940       "since" : "",
941       "see" : "",
942       "exceptions" : "",
943       "requires" : "",
944       "params" : [],
945       "returns" : [
946         {
947           "name" : "",
948           "type" : "Roo.BasicDialog",
949           "desc" : "this"
950         }
951       ]
952     },
953     {
954       "name" : "setContentSize",
955       "type" : "function",
956       "desc" : "Resizes the dialog to fit the specified content size.",
957       "sig" : "(width, height)",
958       "static" : false,
959       "memberOf" : "Roo.BasicDialog",
960       "isStatic" : false,
961       "isConstructor" : false,
962       "isPrivate" : false,
963       "example" : "",
964       "deprecated" : "",
965       "since" : "",
966       "see" : "",
967       "exceptions" : "",
968       "requires" : "",
969       "params" : [
970         {
971           "name" : "width",
972           "type" : "Number",
973           "desc" : "",
974           "isOptional" : false
975         },
976         {
977           "name" : "height",
978           "type" : "Number",
979           "desc" : "",
980           "isOptional" : false
981         }
982       ],
983       "returns" : [
984         {
985           "name" : "",
986           "type" : "Roo.BasicDialog",
987           "desc" : "this"
988         }
989       ]
990     },
991     {
992       "name" : "restoreState",
993       "type" : "function",
994       "desc" : "Restores the previous state of the dialog if Roo.state is configured.",
995       "sig" : "()\n{\n\n}",
996       "static" : false,
997       "memberOf" : "Roo.BasicDialog",
998       "isStatic" : false,
999       "isConstructor" : false,
1000       "isPrivate" : false,
1001       "example" : "",
1002       "deprecated" : "",
1003       "since" : "",
1004       "see" : "",
1005       "exceptions" : "",
1006       "requires" : "",
1007       "params" : [],
1008       "returns" : [
1009         {
1010           "name" : "",
1011           "type" : "Roo.BasicDialog",
1012           "desc" : "this"
1013         }
1014       ]
1015     },
1016     {
1017       "name" : "getEl",
1018       "type" : "function",
1019       "desc" : "Returns the element for this dialog",
1020       "sig" : "()\n{\n\n}",
1021       "static" : false,
1022       "memberOf" : "Roo.BasicDialog",
1023       "isStatic" : false,
1024       "isConstructor" : false,
1025       "isPrivate" : false,
1026       "example" : "",
1027       "deprecated" : "",
1028       "since" : "",
1029       "see" : "",
1030       "exceptions" : "",
1031       "requires" : "",
1032       "params" : [],
1033       "returns" : [
1034         {
1035           "name" : "",
1036           "type" : "Roo.Element",
1037           "desc" : "The underlying dialog Element"
1038         }
1039       ]
1040     },
1041     {
1042       "name" : "purgeListeners",
1043       "type" : "function",
1044       "desc" : "Removes all listeners for this object",
1045       "sig" : "()\n{\n\n}",
1046       "static" : false,
1047       "memberOf" : "Roo.util.Observable",
1048       "isStatic" : false,
1049       "isConstructor" : false,
1050       "isPrivate" : false,
1051       "example" : "",
1052       "deprecated" : "",
1053       "since" : "",
1054       "see" : "",
1055       "exceptions" : "",
1056       "requires" : "",
1057       "params" : [],
1058       "returns" : []
1059     },
1060     {
1061       "name" : "on",
1062       "type" : "function",
1063       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1064       "sig" : "(eventName, handler, scope, options)",
1065       "static" : false,
1066       "memberOf" : "Roo.util.Observable",
1067       "isStatic" : false,
1068       "isConstructor" : false,
1069       "isPrivate" : false,
1070       "example" : "",
1071       "deprecated" : "",
1072       "since" : "",
1073       "see" : "",
1074       "exceptions" : "",
1075       "requires" : "",
1076       "params" : [
1077         {
1078           "name" : "eventName",
1079           "type" : "String",
1080           "desc" : "The type of event to listen for",
1081           "isOptional" : false
1082         },
1083         {
1084           "name" : "handler",
1085           "type" : "Function",
1086           "desc" : "The method the event invokes",
1087           "isOptional" : false
1088         },
1089         {
1090           "name" : "scope",
1091           "type" : "Object",
1092           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1093           "isOptional" : false
1094         },
1095         {
1096           "name" : "options",
1097           "type" : "Object",
1098           "desc" : "(optional)",
1099           "isOptional" : false
1100         }
1101       ],
1102       "returns" : []
1103     },
1104     {
1105       "name" : "un",
1106       "type" : "function",
1107       "desc" : "Removes a listener (shorthand for removeListener)",
1108       "sig" : "(eventName, handler, scope)",
1109       "static" : false,
1110       "memberOf" : "Roo.util.Observable",
1111       "isStatic" : false,
1112       "isConstructor" : false,
1113       "isPrivate" : false,
1114       "example" : "",
1115       "deprecated" : "",
1116       "since" : "",
1117       "see" : "",
1118       "exceptions" : "",
1119       "requires" : "",
1120       "params" : [
1121         {
1122           "name" : "eventName",
1123           "type" : "String",
1124           "desc" : "The type of event to listen for",
1125           "isOptional" : false
1126         },
1127         {
1128           "name" : "handler",
1129           "type" : "Function",
1130           "desc" : "The handler to remove",
1131           "isOptional" : false
1132         },
1133         {
1134           "name" : "scope",
1135           "type" : "Object",
1136           "desc" : "(optional) The scope (this object) for the handler",
1137           "isOptional" : false
1138         }
1139       ],
1140       "returns" : []
1141     },
1142     {
1143       "name" : "addEvents",
1144       "type" : "function",
1145       "desc" : "Used to define events on this Observable",
1146       "sig" : "(object)",
1147       "static" : false,
1148       "memberOf" : "Roo.util.Observable",
1149       "isStatic" : false,
1150       "isConstructor" : false,
1151       "isPrivate" : false,
1152       "example" : "",
1153       "deprecated" : "",
1154       "since" : "",
1155       "see" : "",
1156       "exceptions" : "",
1157       "requires" : "",
1158       "params" : [
1159         {
1160           "name" : "object",
1161           "type" : "Object",
1162           "desc" : "The object with the events defined",
1163           "isOptional" : false
1164         }
1165       ],
1166       "returns" : []
1167     },
1168     {
1169       "name" : "releaseCapture",
1170       "type" : "function",
1171       "desc" : "Removes <b>all</b> added captures from the Observable.",
1172       "sig" : "(o)",
1173       "static" : true,
1174       "memberOf" : "Roo.util.Observable",
1175       "isStatic" : true,
1176       "isConstructor" : false,
1177       "isPrivate" : false,
1178       "example" : "",
1179       "deprecated" : "",
1180       "since" : "",
1181       "see" : "",
1182       "exceptions" : "",
1183       "requires" : "",
1184       "params" : [
1185         {
1186           "name" : "o",
1187           "type" : "Observable",
1188           "desc" : "The Observable to release",
1189           "isOptional" : false
1190         }
1191       ],
1192       "returns" : []
1193     },
1194     {
1195       "name" : "removeListener",
1196       "type" : "function",
1197       "desc" : "Removes a listener",
1198       "sig" : "(eventName, handler, scope)",
1199       "static" : false,
1200       "memberOf" : "Roo.util.Observable",
1201       "isStatic" : false,
1202       "isConstructor" : false,
1203       "isPrivate" : false,
1204       "example" : "",
1205       "deprecated" : "",
1206       "since" : "",
1207       "see" : "",
1208       "exceptions" : "",
1209       "requires" : "",
1210       "params" : [
1211         {
1212           "name" : "eventName",
1213           "type" : "String",
1214           "desc" : "The type of event to listen for",
1215           "isOptional" : false
1216         },
1217         {
1218           "name" : "handler",
1219           "type" : "Function",
1220           "desc" : "The handler to remove",
1221           "isOptional" : false
1222         },
1223         {
1224           "name" : "scope",
1225           "type" : "Object",
1226           "desc" : "(optional) The scope (this object) for the handler",
1227           "isOptional" : false
1228         }
1229       ],
1230       "returns" : []
1231     },
1232     {
1233       "name" : "fireEvent",
1234       "type" : "function",
1235       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1236       "sig" : "(eventName, args)",
1237       "static" : false,
1238       "memberOf" : "Roo.util.Observable",
1239       "isStatic" : false,
1240       "isConstructor" : false,
1241       "isPrivate" : false,
1242       "example" : "",
1243       "deprecated" : "",
1244       "since" : "",
1245       "see" : "",
1246       "exceptions" : "",
1247       "requires" : "",
1248       "params" : [
1249         {
1250           "name" : "eventName",
1251           "type" : "String",
1252           "desc" : "",
1253           "isOptional" : false
1254         },
1255         {
1256           "name" : "args",
1257           "type" : "Object...",
1258           "desc" : "Variable number of parameters are passed to handlers",
1259           "isOptional" : false
1260         }
1261       ],
1262       "returns" : [
1263         {
1264           "name" : "",
1265           "type" : "Boolean",
1266           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1267         }
1268       ]
1269     },
1270     {
1271       "name" : "hasListener",
1272       "type" : "function",
1273       "desc" : "Checks to see if this object has any listeners for a specified event",
1274       "sig" : "(eventName)",
1275       "static" : false,
1276       "memberOf" : "Roo.util.Observable",
1277       "isStatic" : false,
1278       "isConstructor" : false,
1279       "isPrivate" : false,
1280       "example" : "",
1281       "deprecated" : "",
1282       "since" : "",
1283       "see" : "",
1284       "exceptions" : "",
1285       "requires" : "",
1286       "params" : [
1287         {
1288           "name" : "eventName",
1289           "type" : "String",
1290           "desc" : "The name of the event to check for",
1291           "isOptional" : false
1292         }
1293       ],
1294       "returns" : [
1295         {
1296           "name" : "",
1297           "type" : "Boolean",
1298           "desc" : "True if the event is being listened for, else false"
1299         }
1300       ]
1301     },
1302     {
1303       "name" : "capture",
1304       "type" : "function",
1305       "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.",
1306       "sig" : "(o, fn, scope)",
1307       "static" : true,
1308       "memberOf" : "Roo.util.Observable",
1309       "isStatic" : true,
1310       "isConstructor" : false,
1311       "isPrivate" : false,
1312       "example" : "",
1313       "deprecated" : "",
1314       "since" : "",
1315       "see" : "",
1316       "exceptions" : "",
1317       "requires" : "",
1318       "params" : [
1319         {
1320           "name" : "o",
1321           "type" : "Observable",
1322           "desc" : "The Observable to capture",
1323           "isOptional" : false
1324         },
1325         {
1326           "name" : "fn",
1327           "type" : "Function",
1328           "desc" : "The function to call",
1329           "isOptional" : false
1330         },
1331         {
1332           "name" : "scope",
1333           "type" : "Object",
1334           "desc" : "(optional) The scope (this object) for the fn",
1335           "isOptional" : false
1336         }
1337       ],
1338       "returns" : []
1339     },
1340     {
1341       "name" : "addListener",
1342       "type" : "function",
1343       "desc" : "Appends an event handler to this component",
1344       "sig" : "(eventName, handler, scope, options)",
1345       "static" : false,
1346       "memberOf" : "Roo.util.Observable",
1347       "isStatic" : false,
1348       "isConstructor" : false,
1349       "isPrivate" : false,
1350       "example" : "",
1351       "deprecated" : "",
1352       "since" : "",
1353       "see" : "",
1354       "exceptions" : "",
1355       "requires" : "",
1356       "params" : [
1357         {
1358           "name" : "eventName",
1359           "type" : "String",
1360           "desc" : "The type of event to listen for",
1361           "isOptional" : false
1362         },
1363         {
1364           "name" : "handler",
1365           "type" : "Function",
1366           "desc" : "The method the event invokes",
1367           "isOptional" : false
1368         },
1369         {
1370           "name" : "scope",
1371           "type" : "Object",
1372           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1373           "isOptional" : false
1374         },
1375         {
1376           "name" : "options",
1377           "type" : "Object",
1378           "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>",
1379           "isOptional" : false
1380         }
1381       ],
1382       "returns" : []
1383     }
1384   ],
1385   "events" : [
1386     {
1387       "name" : "move",
1388       "type" : "function",
1389       "desc" : "Fires when this dialog is moved by the user.",
1390       "sig" : "function (_self, x, y)\n{\n\n}",
1391       "memberOf" : "Roo.BasicDialog",
1392       "example" : "",
1393       "deprecated" : "",
1394       "since" : "",
1395       "see" : "",
1396       "params" : [
1397         {
1398           "name" : "this",
1399           "type" : "Roo.BasicDialog",
1400           "desc" : "",
1401           "isOptional" : false
1402         },
1403         {
1404           "name" : "x",
1405           "type" : "Number",
1406           "desc" : "The new page X",
1407           "isOptional" : false
1408         },
1409         {
1410           "name" : "y",
1411           "type" : "Number",
1412           "desc" : "The new page Y",
1413           "isOptional" : false
1414         }
1415       ],
1416       "returns" : []
1417     },
1418     {
1419       "name" : "resize",
1420       "type" : "function",
1421       "desc" : "Fires when this dialog is resized by the user.",
1422       "sig" : "function (_self, width, height)\n{\n\n}",
1423       "memberOf" : "Roo.BasicDialog",
1424       "example" : "",
1425       "deprecated" : "",
1426       "since" : "",
1427       "see" : "",
1428       "params" : [
1429         {
1430           "name" : "this",
1431           "type" : "Roo.BasicDialog",
1432           "desc" : "",
1433           "isOptional" : false
1434         },
1435         {
1436           "name" : "width",
1437           "type" : "Number",
1438           "desc" : "The new width",
1439           "isOptional" : false
1440         },
1441         {
1442           "name" : "height",
1443           "type" : "Number",
1444           "desc" : "The new height",
1445           "isOptional" : false
1446         }
1447       ],
1448       "returns" : []
1449     },
1450     {
1451       "name" : "beforehide",
1452       "type" : "function",
1453       "desc" : "Fires before this dialog is hidden.",
1454       "sig" : "function (_self)\n{\n\n}",
1455       "memberOf" : "Roo.BasicDialog",
1456       "example" : "",
1457       "deprecated" : "",
1458       "since" : "",
1459       "see" : "",
1460       "params" : [
1461         {
1462           "name" : "this",
1463           "type" : "Roo.BasicDialog",
1464           "desc" : "",
1465           "isOptional" : false
1466         }
1467       ],
1468       "returns" : []
1469     },
1470     {
1471       "name" : "beforeshow",
1472       "type" : "function",
1473       "desc" : "Fires before this dialog is shown.",
1474       "sig" : "function (_self)\n{\n\n}",
1475       "memberOf" : "Roo.BasicDialog",
1476       "example" : "",
1477       "deprecated" : "",
1478       "since" : "",
1479       "see" : "",
1480       "params" : [
1481         {
1482           "name" : "this",
1483           "type" : "Roo.BasicDialog",
1484           "desc" : "",
1485           "isOptional" : false
1486         }
1487       ],
1488       "returns" : []
1489     },
1490     {
1491       "name" : "hide",
1492       "type" : "function",
1493       "desc" : "Fires when this dialog is hidden.",
1494       "sig" : "function (_self)\n{\n\n}",
1495       "memberOf" : "Roo.BasicDialog",
1496       "example" : "",
1497       "deprecated" : "",
1498       "since" : "",
1499       "see" : "",
1500       "params" : [
1501         {
1502           "name" : "this",
1503           "type" : "Roo.BasicDialog",
1504           "desc" : "",
1505           "isOptional" : false
1506         }
1507       ],
1508       "returns" : []
1509     },
1510     {
1511       "name" : "show",
1512       "type" : "function",
1513       "desc" : "Fires when this dialog is shown.",
1514       "sig" : "function (_self)\n{\n\n}",
1515       "memberOf" : "Roo.BasicDialog",
1516       "example" : "",
1517       "deprecated" : "",
1518       "since" : "",
1519       "see" : "",
1520       "params" : [
1521         {
1522           "name" : "this",
1523           "type" : "Roo.BasicDialog",
1524           "desc" : "",
1525           "isOptional" : false
1526         }
1527       ],
1528       "returns" : []
1529     },
1530     {
1531       "name" : "keydown",
1532       "type" : "function",
1533       "desc" : "Fires when a key is pressed",
1534       "sig" : "function (_self, e)\n{\n\n}",
1535       "memberOf" : "Roo.BasicDialog",
1536       "example" : "",
1537       "deprecated" : "",
1538       "since" : "",
1539       "see" : "",
1540       "params" : [
1541         {
1542           "name" : "this",
1543           "type" : "Roo.BasicDialog",
1544           "desc" : "",
1545           "isOptional" : false
1546         },
1547         {
1548           "name" : "e",
1549           "type" : "Roo.EventObject",
1550           "desc" : "",
1551           "isOptional" : false
1552         }
1553       ],
1554       "returns" : []
1555     }
1556   ]
1557 }