git.roojs.org Git - roojs1/blob - docs/symbols/Roo.LayoutDialog.json

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