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