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

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