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