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