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

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