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