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