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

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