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