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