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