git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.LayoutDialog.json

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