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