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

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