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

   1 {
   2   "name" : "Roo.bootstrap.Modal",
   3   "augments" : [
   4     "Roo.bootstrap.Component",
   5     "Roo.Component",
   6     "Roo.util.Observable"
   7   ],
   8   "childClasses" : [],
   9   "desc" : "Bootstrap Modal class",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "memberOf" : "Modal",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [
  19     {
  20       "name" : "config",
  21       "type" : "Object",
  22       "desc" : "The config object",
  23       "isOptional" : false
  24     }
  25   ],
  26   "returns" : [],
  27   "throws" : "",
  28   "requires" : "",
  29   "config" : [
  30     {
  31       "name" : "editableTitle",
  32       "type" : "Boolean",
  33       "desc" : "can the title be edited",
  34       "memberOf" : ""
  35     },
  36     {
  37       "name" : "listeners",
  38       "type" : "Object",
  39       "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>",
  40       "memberOf" : "Roo.util.Observable"
  41     },
  42     {
  43       "name" : "bodyOverflow",
  44       "type" : "Boolean",
  45       "desc" : "should the body element have overflow auto added default false",
  46       "memberOf" : ""
  47     },
  48     {
  49       "name" : "max_width",
  50       "type" : "Number",
  51       "desc" : "set the max width of modal",
  52       "memberOf" : ""
  53     },
  54     {
  55       "name" : "tooltip",
  56       "type" : "string",
  57       "desc" : "Text for the tooltip",
  58       "memberOf" : "Roo.bootstrap.Component"
  59     },
  60     {
  61       "name" : "container_method",
  62       "type" : "string",
  63       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
  64       "memberOf" : "Roo.bootstrap.Component"
  65     },
  66     {
  67       "name" : "visibilityEl",
  68       "type" : "string|object",
  69       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
  70       "memberOf" : "Roo.bootstrap.Component"
  71     },
  72     {
  73       "name" : "buttons[]",
  74       "type" : "Roo.bootstrap.Button",
  75       "desc" : "Array of buttons or standard button set..",
  76       "memberOf" : ""
  77     },
  78     {
  79       "name" : "can_build_overlaid",
  80       "type" : "Boolean",
  81       "desc" : "True if element can be rebuild from a HTML page",
  82       "memberOf" : "Roo.bootstrap.Component"
  83     },
  84     {
  85       "name" : "hideMode",
  86       "type" : "String",
  87       "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
  88       "memberOf" : "Roo.Component"
  89     },
  90     {
  91       "name" : "title",
  92       "type" : "String",
  93       "desc" : "Title of dialog",
  94       "memberOf" : ""
  95     },
  96     {
  97       "name" : "style",
  98       "type" : "String",
  99       "desc" : "any extra css",
 100       "memberOf" : "Roo.bootstrap.Component"
 101     },
 102     {
 103       "name" : "allowDomMove",
 104       "type" : "Boolean",
 105       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 106       "memberOf" : "Roo.Component"
 107     },
 108     {
 109       "name" : "tmpl",
 110       "type" : "Roo.Template",
 111       "desc" : "- a template with variables. to use it, add a handler in show:method  adn",
 112       "memberOf" : ""
 113     },
 114     {
 115       "name" : "html",
 116       "type" : "String",
 117       "desc" : "- the body of the dialog (for simple ones) - you can also use template..",
 118       "memberOf" : ""
 119     },
 120     {
 121       "name" : "buttonPosition",
 122       "type" : "String",
 123       "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left",
 124       "memberOf" : ""
 125     },
 126     {
 127       "name" : "cls",
 128       "type" : "String",
 129       "desc" : "css class",
 130       "memberOf" : "Roo.bootstrap.Component"
 131     },
 132     {
 133       "name" : "fitwindow",
 134       "type" : "Boolean",
 135       "desc" : "default false",
 136       "memberOf" : ""
 137     },
 138     {
 139       "name" : "xattr",
 140       "type" : "Object",
 141       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 142       "memberOf" : "Roo.bootstrap.Component"
 143     },
 144     {
 145       "name" : "actionMode",
 146       "type" : "String",
 147       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
 148       "memberOf" : "Roo.Component"
 149     },
 150     {
 151       "name" : "specificTitle",
 152       "type" : "Boolean",
 153       "desc" : "default false",
 154       "memberOf" : ""
 155     },
 156     {
 157       "name" : "width",
 158       "type" : "Number",
 159       "desc" : "fixed width - usefull for chrome extension only really.",
 160       "memberOf" : ""
 161     },
 162     {
 163       "name" : "dataId",
 164       "type" : "string",
 165       "desc" : "cutomer id",
 166       "memberOf" : "Roo.bootstrap.Component"
 167     },
 168     {
 169       "name" : "allow_close",
 170       "type" : "Boolean",
 171       "desc" : "default true",
 172       "memberOf" : ""
 173     },
 174     {
 175       "name" : "height",
 176       "type" : "Number",
 177       "desc" : "fixed height - usefull for chrome extension only really.",
 178       "memberOf" : ""
 179     },
 180     {
 181       "name" : "size",
 182       "type" : "String",
 183       "desc" : "l) default empty",
 184       "memberOf" : ""
 185     },
 186     {
 187       "name" : "name",
 188       "type" : "string",
 189       "desc" : "Specifies name attribute",
 190       "memberOf" : "Roo.bootstrap.Component"
 191     },
 192     {
 193       "name" : "disableClass",
 194       "type" : "String",
 195       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 196       "memberOf" : "Roo.Component"
 197     },
 198     {
 199       "name" : "animate",
 200       "type" : "Boolean",
 201       "desc" : "default true",
 202       "memberOf" : ""
 203     }
 204   ],
 205   "methods" : [
 206     {
 207       "name" : "applyBody",
 208       "type" : "function",
 209       "desc" : "Set the body of the Dialog using the template",
 210       "sig" : "(data)",
 211       "static" : false,
 212       "memberOf" : "",
 213       "isStatic" : false,
 214       "isConstructor" : false,
 215       "isPrivate" : false,
 216       "example" : "",
 217       "deprecated" : "",
 218       "since" : "",
 219       "see" : "",
 220       "exceptions" : "",
 221       "requires" : "",
 222       "params" : [
 223         {
 224           "name" : "data",
 225           "type" : "Obj",
 226           "desc" : "- apply this data to the template and replace the body contents.",
 227           "isOptional" : false
 228         }
 229       ],
 230       "returns" : []
 231     },
 232     {
 233       "name" : "setTitle",
 234       "type" : "function",
 235       "desc" : "Set the title of the Dialog",
 236       "sig" : "(str)",
 237       "static" : false,
 238       "memberOf" : "",
 239       "isStatic" : false,
 240       "isConstructor" : false,
 241       "isPrivate" : false,
 242       "example" : "",
 243       "deprecated" : "",
 244       "since" : "",
 245       "see" : "",
 246       "exceptions" : "",
 247       "requires" : "",
 248       "params" : [
 249         {
 250           "name" : "str",
 251           "type" : "String",
 252           "desc" : "new Title",
 253           "isOptional" : false
 254         }
 255       ],
 256       "returns" : []
 257     },
 258     {
 259       "name" : "setBody",
 260       "type" : "function",
 261       "desc" : "Set the body of the Dialog",
 262       "sig" : "(str)",
 263       "static" : false,
 264       "memberOf" : "",
 265       "isStatic" : false,
 266       "isConstructor" : false,
 267       "isPrivate" : false,
 268       "example" : "",
 269       "deprecated" : "",
 270       "since" : "",
 271       "see" : "",
 272       "exceptions" : "",
 273       "requires" : "",
 274       "params" : [
 275         {
 276           "name" : "str",
 277           "type" : "String",
 278           "desc" : "new Title",
 279           "isOptional" : false
 280         }
 281       ],
 282       "returns" : []
 283     },
 284     {
 285       "name" : "tooltipEl",
 286       "type" : "function",
 287       "desc" : "Fetch the element to display the tooltip on.",
 288       "sig" : "()\n{\n\n}",
 289       "static" : false,
 290       "memberOf" : "Roo.bootstrap.Component",
 291       "isStatic" : false,
 292       "isConstructor" : false,
 293       "isPrivate" : false,
 294       "example" : "",
 295       "deprecated" : "",
 296       "since" : "",
 297       "see" : "",
 298       "exceptions" : "",
 299       "requires" : "",
 300       "params" : [],
 301       "returns" : [
 302         {
 303           "name" : "",
 304           "type" : "Roo.Element",
 305           "desc" : "defaults to this.el"
 306         }
 307       ]
 308     },
 309     {
 310       "name" : "hide",
 311       "type" : "function",
 312       "desc" : "Hide a component - adds 'hidden' class",
 313       "sig" : "()\n{\n\n}",
 314       "static" : false,
 315       "memberOf" : "Roo.bootstrap.Component",
 316       "isStatic" : false,
 317       "isConstructor" : false,
 318       "isPrivate" : false,
 319       "example" : "",
 320       "deprecated" : "",
 321       "since" : "",
 322       "see" : "",
 323       "exceptions" : "",
 324       "requires" : "",
 325       "params" : [],
 326       "returns" : []
 327     },
 328     {
 329       "name" : "show",
 330       "type" : "function",
 331       "desc" : "Show a component - removes 'hidden' class",
 332       "sig" : "()\n{\n\n}",
 333       "static" : false,
 334       "memberOf" : "Roo.bootstrap.Component",
 335       "isStatic" : false,
 336       "isConstructor" : false,
 337       "isPrivate" : false,
 338       "example" : "",
 339       "deprecated" : "",
 340       "since" : "",
 341       "see" : "",
 342       "exceptions" : "",
 343       "requires" : "",
 344       "params" : [],
 345       "returns" : []
 346     },
 347     {
 348       "name" : "setVisibilityEl",
 349       "type" : "function",
 350       "desc" : "Set the element that will be used to show or hide",
 351       "sig" : "()\n{\n\n}",
 352       "static" : false,
 353       "memberOf" : "Roo.bootstrap.Component",
 354       "isStatic" : false,
 355       "isConstructor" : false,
 356       "isPrivate" : false,
 357       "example" : "",
 358       "deprecated" : "",
 359       "since" : "",
 360       "see" : "",
 361       "exceptions" : "",
 362       "requires" : "",
 363       "params" : [],
 364       "returns" : []
 365     },
 366     {
 367       "name" : "getVisibilityEl",
 368       "type" : "function",
 369       "desc" : "Get the element that will be used to show or hide",
 370       "sig" : "()\n{\n\n}",
 371       "static" : false,
 372       "memberOf" : "Roo.bootstrap.Component",
 373       "isStatic" : false,
 374       "isConstructor" : false,
 375       "isPrivate" : false,
 376       "example" : "",
 377       "deprecated" : "",
 378       "since" : "",
 379       "see" : "",
 380       "exceptions" : "",
 381       "requires" : "",
 382       "params" : [],
 383       "returns" : []
 384     },
 385     {
 386       "name" : "initEvents",
 387       "type" : "function",
 388       "desc" : "Initialize Events for the element",
 389       "sig" : "()\n{\n\n}",
 390       "static" : false,
 391       "memberOf" : "Roo.bootstrap.Component",
 392       "isStatic" : false,
 393       "isConstructor" : false,
 394       "isPrivate" : false,
 395       "example" : "",
 396       "deprecated" : "",
 397       "since" : "",
 398       "see" : "",
 399       "exceptions" : "",
 400       "requires" : "",
 401       "params" : [],
 402       "returns" : []
 403     },
 404     {
 405       "name" : "getChildContainer",
 406       "type" : "function",
 407       "desc" : "Fetch the element to add children to",
 408       "sig" : "()\n{\n\n}",
 409       "static" : false,
 410       "memberOf" : "Roo.bootstrap.Component",
 411       "isStatic" : false,
 412       "isConstructor" : false,
 413       "isPrivate" : false,
 414       "example" : "",
 415       "deprecated" : "",
 416       "since" : "",
 417       "see" : "",
 418       "exceptions" : "",
 419       "requires" : "",
 420       "params" : [],
 421       "returns" : [
 422         {
 423           "name" : "",
 424           "type" : "Roo.Element",
 425           "desc" : "defaults to this.el"
 426         }
 427       ]
 428     },
 429     {
 430       "name" : "getId",
 431       "type" : "function",
 432       "desc" : "Returns the id of this component.",
 433       "sig" : "()\n{\n\n}",
 434       "static" : false,
 435       "memberOf" : "Roo.Component",
 436       "isStatic" : false,
 437       "isConstructor" : false,
 438       "isPrivate" : false,
 439       "example" : "",
 440       "deprecated" : "",
 441       "since" : "",
 442       "see" : "",
 443       "exceptions" : "",
 444       "requires" : "",
 445       "params" : [],
 446       "returns" : [
 447         {
 448           "name" : "",
 449           "type" : "String",
 450           "desc" : ""
 451         }
 452       ]
 453     },
 454     {
 455       "name" : "render",
 456       "type" : "function",
 457       "desc" : "If this is a lazy rendering component, render it to its container element.",
 458       "sig" : "(container)",
 459       "static" : false,
 460       "memberOf" : "Roo.Component",
 461       "isStatic" : false,
 462       "isConstructor" : false,
 463       "isPrivate" : false,
 464       "example" : "",
 465       "deprecated" : "",
 466       "since" : "",
 467       "see" : "",
 468       "exceptions" : "",
 469       "requires" : "",
 470       "params" : [
 471         {
 472           "name" : "container",
 473           "type" : "String/HTMLElement/Element",
 474           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 475           "isOptional" : false
 476         }
 477       ],
 478       "returns" : []
 479     },
 480     {
 481       "name" : "destroy",
 482       "type" : "function",
 483       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
 484       "sig" : "()\n{\n\n}",
 485       "static" : false,
 486       "memberOf" : "Roo.Component",
 487       "isStatic" : false,
 488       "isConstructor" : false,
 489       "isPrivate" : false,
 490       "example" : "",
 491       "deprecated" : "",
 492       "since" : "",
 493       "see" : "",
 494       "exceptions" : "",
 495       "requires" : "",
 496       "params" : [],
 497       "returns" : []
 498     },
 499     {
 500       "name" : "isVisible",
 501       "type" : "function",
 502       "desc" : "Returns true if this component is visible.",
 503       "sig" : "()\n{\n\n}",
 504       "static" : false,
 505       "memberOf" : "Roo.Component",
 506       "isStatic" : false,
 507       "isConstructor" : false,
 508       "isPrivate" : false,
 509       "example" : "",
 510       "deprecated" : "",
 511       "since" : "",
 512       "see" : "",
 513       "exceptions" : "",
 514       "requires" : "",
 515       "params" : [],
 516       "returns" : []
 517     },
 518     {
 519       "name" : "setDisabled",
 520       "type" : "function",
 521       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 522       "sig" : "(disabled)",
 523       "static" : false,
 524       "memberOf" : "Roo.Component",
 525       "isStatic" : false,
 526       "isConstructor" : false,
 527       "isPrivate" : false,
 528       "example" : "",
 529       "deprecated" : "",
 530       "since" : "",
 531       "see" : "",
 532       "exceptions" : "",
 533       "requires" : "",
 534       "params" : [
 535         {
 536           "name" : "disabled",
 537           "type" : "Boolean",
 538           "desc" : "",
 539           "isOptional" : false
 540         }
 541       ],
 542       "returns" : []
 543     },
 544     {
 545       "name" : "focus",
 546       "type" : "function",
 547       "desc" : "Try to focus this component.",
 548       "sig" : "(selectText)",
 549       "static" : false,
 550       "memberOf" : "Roo.Component",
 551       "isStatic" : false,
 552       "isConstructor" : false,
 553       "isPrivate" : false,
 554       "example" : "",
 555       "deprecated" : "",
 556       "since" : "",
 557       "see" : "",
 558       "exceptions" : "",
 559       "requires" : "",
 560       "params" : [
 561         {
 562           "name" : "selectText",
 563           "type" : "Boolean",
 564           "desc" : "True to also select the text in this component (if applicable)",
 565           "isOptional" : false
 566         }
 567       ],
 568       "returns" : [
 569         {
 570           "name" : "",
 571           "type" : "Roo.Component",
 572           "desc" : "this"
 573         }
 574       ]
 575     },
 576     {
 577       "name" : "enable",
 578       "type" : "function",
 579       "desc" : "Enable this component.",
 580       "sig" : "()\n{\n\n}",
 581       "static" : false,
 582       "memberOf" : "Roo.Component",
 583       "isStatic" : false,
 584       "isConstructor" : false,
 585       "isPrivate" : false,
 586       "example" : "",
 587       "deprecated" : "",
 588       "since" : "",
 589       "see" : "",
 590       "exceptions" : "",
 591       "requires" : "",
 592       "params" : [],
 593       "returns" : [
 594         {
 595           "name" : "",
 596           "type" : "Roo.Component",
 597           "desc" : "this"
 598         }
 599       ]
 600     },
 601     {
 602       "name" : "setVisible",
 603       "type" : "function",
 604       "desc" : "Convenience function to hide or show this component by boolean.",
 605       "sig" : "(visible)",
 606       "static" : false,
 607       "memberOf" : "Roo.Component",
 608       "isStatic" : false,
 609       "isConstructor" : false,
 610       "isPrivate" : false,
 611       "example" : "",
 612       "deprecated" : "",
 613       "since" : "",
 614       "see" : "",
 615       "exceptions" : "",
 616       "requires" : "",
 617       "params" : [
 618         {
 619           "name" : "visible",
 620           "type" : "Boolean",
 621           "desc" : "True to show, false to hide",
 622           "isOptional" : false
 623         }
 624       ],
 625       "returns" : [
 626         {
 627           "name" : "",
 628           "type" : "Roo.Component",
 629           "desc" : "this"
 630         }
 631       ]
 632     },
 633     {
 634       "name" : "disable",
 635       "type" : "function",
 636       "desc" : "Disable this component.",
 637       "sig" : "()\n{\n\n}",
 638       "static" : false,
 639       "memberOf" : "Roo.Component",
 640       "isStatic" : false,
 641       "isConstructor" : false,
 642       "isPrivate" : false,
 643       "example" : "",
 644       "deprecated" : "",
 645       "since" : "",
 646       "see" : "",
 647       "exceptions" : "",
 648       "requires" : "",
 649       "params" : [],
 650       "returns" : [
 651         {
 652           "name" : "",
 653           "type" : "Roo.Component",
 654           "desc" : "this"
 655         }
 656       ]
 657     },
 658     {
 659       "name" : "getEl",
 660       "type" : "function",
 661       "desc" : "Returns the underlying {@link Roo.Element}.",
 662       "sig" : "()\n{\n\n}",
 663       "static" : false,
 664       "memberOf" : "Roo.Component",
 665       "isStatic" : false,
 666       "isConstructor" : false,
 667       "isPrivate" : false,
 668       "example" : "",
 669       "deprecated" : "",
 670       "since" : "",
 671       "see" : "",
 672       "exceptions" : "",
 673       "requires" : "",
 674       "params" : [],
 675       "returns" : [
 676         {
 677           "name" : "",
 678           "type" : "Roo.Element",
 679           "desc" : "The element"
 680         }
 681       ]
 682     },
 683     {
 684       "name" : "purgeListeners",
 685       "type" : "function",
 686       "desc" : "Removes all listeners for this object",
 687       "sig" : "()\n{\n\n}",
 688       "static" : false,
 689       "memberOf" : "Roo.util.Observable",
 690       "isStatic" : false,
 691       "isConstructor" : false,
 692       "isPrivate" : false,
 693       "example" : "",
 694       "deprecated" : "",
 695       "since" : "",
 696       "see" : "",
 697       "exceptions" : "",
 698       "requires" : "",
 699       "params" : [],
 700       "returns" : []
 701     },
 702     {
 703       "name" : "on",
 704       "type" : "function",
 705       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 706       "sig" : "(eventName, handler, scope, options)",
 707       "static" : false,
 708       "memberOf" : "Roo.util.Observable",
 709       "isStatic" : false,
 710       "isConstructor" : false,
 711       "isPrivate" : false,
 712       "example" : "",
 713       "deprecated" : "",
 714       "since" : "",
 715       "see" : "",
 716       "exceptions" : "",
 717       "requires" : "",
 718       "params" : [
 719         {
 720           "name" : "eventName",
 721           "type" : "String",
 722           "desc" : "The type of event to listen for",
 723           "isOptional" : false
 724         },
 725         {
 726           "name" : "handler",
 727           "type" : "Function",
 728           "desc" : "The method the event invokes",
 729           "isOptional" : false
 730         },
 731         {
 732           "name" : "scope",
 733           "type" : "Object",
 734           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 735           "isOptional" : false
 736         },
 737         {
 738           "name" : "options",
 739           "type" : "Object",
 740           "desc" : "(optional)",
 741           "isOptional" : false
 742         }
 743       ],
 744       "returns" : []
 745     },
 746     {
 747       "name" : "un",
 748       "type" : "function",
 749       "desc" : "Removes a listener (shorthand for removeListener)",
 750       "sig" : "(eventName, handler, scope)",
 751       "static" : false,
 752       "memberOf" : "Roo.util.Observable",
 753       "isStatic" : false,
 754       "isConstructor" : false,
 755       "isPrivate" : false,
 756       "example" : "",
 757       "deprecated" : "",
 758       "since" : "",
 759       "see" : "",
 760       "exceptions" : "",
 761       "requires" : "",
 762       "params" : [
 763         {
 764           "name" : "eventName",
 765           "type" : "String",
 766           "desc" : "The type of event to listen for",
 767           "isOptional" : false
 768         },
 769         {
 770           "name" : "handler",
 771           "type" : "Function",
 772           "desc" : "The handler to remove",
 773           "isOptional" : false
 774         },
 775         {
 776           "name" : "scope",
 777           "type" : "Object",
 778           "desc" : "(optional) The scope (this object) for the handler",
 779           "isOptional" : false
 780         }
 781       ],
 782       "returns" : []
 783     },
 784     {
 785       "name" : "addEvents",
 786       "type" : "function",
 787       "desc" : "Used to define events on this Observable",
 788       "sig" : "(object)",
 789       "static" : false,
 790       "memberOf" : "Roo.util.Observable",
 791       "isStatic" : false,
 792       "isConstructor" : false,
 793       "isPrivate" : false,
 794       "example" : "",
 795       "deprecated" : "",
 796       "since" : "",
 797       "see" : "",
 798       "exceptions" : "",
 799       "requires" : "",
 800       "params" : [
 801         {
 802           "name" : "object",
 803           "type" : "Object",
 804           "desc" : "The object with the events defined",
 805           "isOptional" : false
 806         }
 807       ],
 808       "returns" : []
 809     },
 810     {
 811       "name" : "releaseCapture",
 812       "type" : "function",
 813       "desc" : "Removes <b>all</b> added captures from the Observable.",
 814       "sig" : "(o)",
 815       "static" : true,
 816       "memberOf" : "Roo.util.Observable",
 817       "isStatic" : true,
 818       "isConstructor" : false,
 819       "isPrivate" : false,
 820       "example" : "",
 821       "deprecated" : "",
 822       "since" : "",
 823       "see" : "",
 824       "exceptions" : "",
 825       "requires" : "",
 826       "params" : [
 827         {
 828           "name" : "o",
 829           "type" : "Observable",
 830           "desc" : "The Observable to release",
 831           "isOptional" : false
 832         }
 833       ],
 834       "returns" : []
 835     },
 836     {
 837       "name" : "removeListener",
 838       "type" : "function",
 839       "desc" : "Removes a listener",
 840       "sig" : "(eventName, handler, scope)",
 841       "static" : false,
 842       "memberOf" : "Roo.util.Observable",
 843       "isStatic" : false,
 844       "isConstructor" : false,
 845       "isPrivate" : false,
 846       "example" : "",
 847       "deprecated" : "",
 848       "since" : "",
 849       "see" : "",
 850       "exceptions" : "",
 851       "requires" : "",
 852       "params" : [
 853         {
 854           "name" : "eventName",
 855           "type" : "String",
 856           "desc" : "The type of event to listen for",
 857           "isOptional" : false
 858         },
 859         {
 860           "name" : "handler",
 861           "type" : "Function",
 862           "desc" : "The handler to remove",
 863           "isOptional" : false
 864         },
 865         {
 866           "name" : "scope",
 867           "type" : "Object",
 868           "desc" : "(optional) The scope (this object) for the handler",
 869           "isOptional" : false
 870         }
 871       ],
 872       "returns" : []
 873     },
 874     {
 875       "name" : "fireEvent",
 876       "type" : "function",
 877       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 878       "sig" : "(eventName, args)",
 879       "static" : false,
 880       "memberOf" : "Roo.util.Observable",
 881       "isStatic" : false,
 882       "isConstructor" : false,
 883       "isPrivate" : false,
 884       "example" : "",
 885       "deprecated" : "",
 886       "since" : "",
 887       "see" : "",
 888       "exceptions" : "",
 889       "requires" : "",
 890       "params" : [
 891         {
 892           "name" : "eventName",
 893           "type" : "String",
 894           "desc" : "",
 895           "isOptional" : false
 896         },
 897         {
 898           "name" : "args",
 899           "type" : "Object...",
 900           "desc" : "Variable number of parameters are passed to handlers",
 901           "isOptional" : false
 902         }
 903       ],
 904       "returns" : [
 905         {
 906           "name" : "",
 907           "type" : "Boolean",
 908           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 909         }
 910       ]
 911     },
 912     {
 913       "name" : "hasListener",
 914       "type" : "function",
 915       "desc" : "Checks to see if this object has any listeners for a specified event",
 916       "sig" : "(eventName)",
 917       "static" : false,
 918       "memberOf" : "Roo.util.Observable",
 919       "isStatic" : false,
 920       "isConstructor" : false,
 921       "isPrivate" : false,
 922       "example" : "",
 923       "deprecated" : "",
 924       "since" : "",
 925       "see" : "",
 926       "exceptions" : "",
 927       "requires" : "",
 928       "params" : [
 929         {
 930           "name" : "eventName",
 931           "type" : "String",
 932           "desc" : "The name of the event to check for",
 933           "isOptional" : false
 934         }
 935       ],
 936       "returns" : [
 937         {
 938           "name" : "",
 939           "type" : "Boolean",
 940           "desc" : "True if the event is being listened for, else false"
 941         }
 942       ]
 943     },
 944     {
 945       "name" : "capture",
 946       "type" : "function",
 947       "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.",
 948       "sig" : "(o, fn, scope)",
 949       "static" : true,
 950       "memberOf" : "Roo.util.Observable",
 951       "isStatic" : true,
 952       "isConstructor" : false,
 953       "isPrivate" : false,
 954       "example" : "",
 955       "deprecated" : "",
 956       "since" : "",
 957       "see" : "",
 958       "exceptions" : "",
 959       "requires" : "",
 960       "params" : [
 961         {
 962           "name" : "o",
 963           "type" : "Observable",
 964           "desc" : "The Observable to capture",
 965           "isOptional" : false
 966         },
 967         {
 968           "name" : "fn",
 969           "type" : "Function",
 970           "desc" : "The function to call",
 971           "isOptional" : false
 972         },
 973         {
 974           "name" : "scope",
 975           "type" : "Object",
 976           "desc" : "(optional) The scope (this object) for the fn",
 977           "isOptional" : false
 978         }
 979       ],
 980       "returns" : []
 981     },
 982     {
 983       "name" : "addListener",
 984       "type" : "function",
 985       "desc" : "Appends an event handler to this component",
 986       "sig" : "(eventName, handler, scope, options)",
 987       "static" : false,
 988       "memberOf" : "Roo.util.Observable",
 989       "isStatic" : false,
 990       "isConstructor" : false,
 991       "isPrivate" : false,
 992       "example" : "",
 993       "deprecated" : "",
 994       "since" : "",
 995       "see" : "",
 996       "exceptions" : "",
 997       "requires" : "",
 998       "params" : [
 999         {
1000           "name" : "eventName",
1001           "type" : "String",
1002           "desc" : "The type of event to listen for",
1003           "isOptional" : false
1004         },
1005         {
1006           "name" : "handler",
1007           "type" : "Function",
1008           "desc" : "The method the event invokes",
1009           "isOptional" : false
1010         },
1011         {
1012           "name" : "scope",
1013           "type" : "Object",
1014           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1015           "isOptional" : false
1016         },
1017         {
1018           "name" : "options",
1019           "type" : "Object",
1020           "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>",
1021           "isOptional" : false
1022         }
1023       ],
1024       "returns" : []
1025     }
1026   ],
1027   "events" : [
1028     {
1029       "name" : "titlechanged",
1030       "type" : "function",
1031       "desc" : "Fire when the editable title has been changed",
1032       "sig" : "function (_self, value)\n{\n\n}",
1033       "memberOf" : "",
1034       "example" : "",
1035       "deprecated" : "",
1036       "since" : "",
1037       "see" : "",
1038       "params" : [
1039         {
1040           "name" : "this",
1041           "type" : "Roo.bootstrap.Modal",
1042           "desc" : "",
1043           "isOptional" : false
1044         },
1045         {
1046           "name" : "value",
1047           "type" : "Roo.EventObject",
1048           "desc" : "",
1049           "isOptional" : false
1050         }
1051       ],
1052       "returns" : []
1053     },
1054     {
1055       "name" : "btnclick",
1056       "type" : "function",
1057       "desc" : "The raw btnclick event for the button",
1058       "sig" : "function (e)\n{\n\n}",
1059       "memberOf" : "",
1060       "example" : "",
1061       "deprecated" : "",
1062       "since" : "",
1063       "see" : "",
1064       "params" : [
1065         {
1066           "name" : "e",
1067           "type" : "Roo.EventObject",
1068           "desc" : "",
1069           "isOptional" : false
1070         }
1071       ],
1072       "returns" : []
1073     },
1074     {
1075       "name" : "resize",
1076       "type" : "function",
1077       "desc" : "Fire when dialog resize",
1078       "sig" : "function (_self, e)\n{\n\n}",
1079       "memberOf" : "",
1080       "example" : "",
1081       "deprecated" : "",
1082       "since" : "",
1083       "see" : "",
1084       "params" : [
1085         {
1086           "name" : "this",
1087           "type" : "Roo.bootstrap.Modal",
1088           "desc" : "",
1089           "isOptional" : false
1090         },
1091         {
1092           "name" : "e",
1093           "type" : "Roo.EventObject",
1094           "desc" : "",
1095           "isOptional" : false
1096         }
1097       ],
1098       "returns" : []
1099     },
1100     {
1101       "name" : "childrenrendered",
1102       "type" : "function",
1103       "desc" : "Fires when the children have been rendered..",
1104       "sig" : "function (_self)\n{\n\n}",
1105       "memberOf" : "Roo.bootstrap.Component",
1106       "example" : "",
1107       "deprecated" : "",
1108       "since" : "",
1109       "see" : "",
1110       "params" : [
1111         {
1112           "name" : "this",
1113           "type" : "Roo.bootstrap.Component",
1114           "desc" : "",
1115           "isOptional" : false
1116         }
1117       ],
1118       "returns" : []
1119     },
1120     {
1121       "name" : "beforerender",
1122       "type" : "function",
1123       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1124       "sig" : "function (_self)\n{\n\n}",
1125       "memberOf" : "Roo.Component",
1126       "example" : "",
1127       "deprecated" : "",
1128       "since" : "",
1129       "see" : "",
1130       "params" : [
1131         {
1132           "name" : "this",
1133           "type" : "Roo.Component",
1134           "desc" : "",
1135           "isOptional" : false
1136         }
1137       ],
1138       "returns" : []
1139     },
1140     {
1141       "name" : "disable",
1142       "type" : "function",
1143       "desc" : "Fires after the component is disabled.",
1144       "sig" : "function (_self)\n{\n\n}",
1145       "memberOf" : "Roo.Component",
1146       "example" : "",
1147       "deprecated" : "",
1148       "since" : "",
1149       "see" : "",
1150       "params" : [
1151         {
1152           "name" : "this",
1153           "type" : "Roo.Component",
1154           "desc" : "",
1155           "isOptional" : false
1156         }
1157       ],
1158       "returns" : []
1159     },
1160     {
1161       "name" : "render",
1162       "type" : "function",
1163       "desc" : "Fires after the component is rendered.",
1164       "sig" : "function (_self)\n{\n\n}",
1165       "memberOf" : "Roo.Component",
1166       "example" : "",
1167       "deprecated" : "",
1168       "since" : "",
1169       "see" : "",
1170       "params" : [
1171         {
1172           "name" : "this",
1173           "type" : "Roo.Component",
1174           "desc" : "",
1175           "isOptional" : false
1176         }
1177       ],
1178       "returns" : []
1179     },
1180     {
1181       "name" : "destroy",
1182       "type" : "function",
1183       "desc" : "Fires after the component is destroyed.",
1184       "sig" : "function (_self)\n{\n\n}",
1185       "memberOf" : "Roo.Component",
1186       "example" : "",
1187       "deprecated" : "",
1188       "since" : "",
1189       "see" : "",
1190       "params" : [
1191         {
1192           "name" : "this",
1193           "type" : "Roo.Component",
1194           "desc" : "",
1195           "isOptional" : false
1196         }
1197       ],
1198       "returns" : []
1199     },
1200     {
1201       "name" : "hide",
1202       "type" : "function",
1203       "desc" : "Fires after the component is hidden.",
1204       "sig" : "function (_self)\n{\n\n}",
1205       "memberOf" : "Roo.Component",
1206       "example" : "",
1207       "deprecated" : "",
1208       "since" : "",
1209       "see" : "",
1210       "params" : [
1211         {
1212           "name" : "this",
1213           "type" : "Roo.Component",
1214           "desc" : "",
1215           "isOptional" : false
1216         }
1217       ],
1218       "returns" : []
1219     },
1220     {
1221       "name" : "beforehide",
1222       "type" : "function",
1223       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1224       "sig" : "function (_self)\n{\n\n}",
1225       "memberOf" : "Roo.Component",
1226       "example" : "",
1227       "deprecated" : "",
1228       "since" : "",
1229       "see" : "",
1230       "params" : [
1231         {
1232           "name" : "this",
1233           "type" : "Roo.Component",
1234           "desc" : "",
1235           "isOptional" : false
1236         }
1237       ],
1238       "returns" : []
1239     },
1240     {
1241       "name" : "show",
1242       "type" : "function",
1243       "desc" : "Fires after the component is shown.",
1244       "sig" : "function (_self)\n{\n\n}",
1245       "memberOf" : "Roo.Component",
1246       "example" : "",
1247       "deprecated" : "",
1248       "since" : "",
1249       "see" : "",
1250       "params" : [
1251         {
1252           "name" : "this",
1253           "type" : "Roo.Component",
1254           "desc" : "",
1255           "isOptional" : false
1256         }
1257       ],
1258       "returns" : []
1259     },
1260     {
1261       "name" : "beforeshow",
1262       "type" : "function",
1263       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1264       "sig" : "function (_self)\n{\n\n}",
1265       "memberOf" : "Roo.Component",
1266       "example" : "",
1267       "deprecated" : "",
1268       "since" : "",
1269       "see" : "",
1270       "params" : [
1271         {
1272           "name" : "this",
1273           "type" : "Roo.Component",
1274           "desc" : "",
1275           "isOptional" : false
1276         }
1277       ],
1278       "returns" : []
1279     },
1280     {
1281       "name" : "enable",
1282       "type" : "function",
1283       "desc" : "Fires after the component is enabled.",
1284       "sig" : "function (_self)\n{\n\n}",
1285       "memberOf" : "Roo.Component",
1286       "example" : "",
1287       "deprecated" : "",
1288       "since" : "",
1289       "see" : "",
1290       "params" : [
1291         {
1292           "name" : "this",
1293           "type" : "Roo.Component",
1294           "desc" : "",
1295           "isOptional" : false
1296         }
1297       ],
1298       "returns" : []
1299     },
1300     {
1301       "name" : "beforedestroy",
1302       "type" : "function",
1303       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1304       "sig" : "function (_self)\n{\n\n}",
1305       "memberOf" : "Roo.Component",
1306       "example" : "",
1307       "deprecated" : "",
1308       "since" : "",
1309       "see" : "",
1310       "params" : [
1311         {
1312           "name" : "this",
1313           "type" : "Roo.Component",
1314           "desc" : "",
1315           "isOptional" : false
1316         }
1317       ],
1318       "returns" : []
1319     }
1320   ]
1321 }