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