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'",
 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" : "dataId",
 189       "type" : "string",
 190       "desc" : "cutomer id",
 191       "memberOf" : "Roo.bootstrap.Component",
 192       "values" : [
 193       ]
 194     },
 195     {
 196       "name" : "allow_close",
 197       "type" : "Boolean",
 198       "desc" : "default true",
 199       "memberOf" : "Roo.bootstrap.Modal",
 200       "values" : [
 201       ]
 202     },
 203     {
 204       "name" : "size",
 205       "type" : "String",
 206       "desc" : "default empty",
 207       "memberOf" : "Roo.bootstrap.Modal",
 208       "values" : [
 209         "(sm",
 210         "lg)"
 211       ]
 212     },
 213     {
 214       "name" : "name",
 215       "type" : "string",
 216       "desc" : "Specifies name attribute",
 217       "memberOf" : "Roo.bootstrap.Component",
 218       "values" : [
 219       ]
 220     },
 221     {
 222       "name" : "disableClass",
 223       "type" : "String",
 224       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 225       "memberOf" : "Roo.Component",
 226       "values" : [
 227       ]
 228     },
 229     {
 230       "name" : "animate",
 231       "type" : "Boolean",
 232       "desc" : "default true",
 233       "memberOf" : "Roo.bootstrap.Modal",
 234       "values" : [
 235       ]
 236     }
 237   ],
 238   "methods" : [
 239     {
 240       "name" : "applyBody",
 241       "desc" : "Set the body of the Dialog using the template",
 242       "isStatic" : false,
 243       "isConstructor" : false,
 244       "isPrivate" : false,
 245       "memberOf" : "Roo.bootstrap.Modal",
 246       "example" : "",
 247       "deprecated" : "",
 248       "since" : "",
 249       "see" : "",
 250       "params" : [
 251         {
 252           "name" : "data",
 253           "type" : "Obj",
 254           "desc" : "- apply this data to the template and replace the body contents.",
 255           "isOptional" : false
 256         }
 257       ],
 258       "returns" : [
 259       ]
 260     },
 261     {
 262       "name" : "setTitle",
 263       "desc" : "Set the title of the Dialog",
 264       "isStatic" : false,
 265       "isConstructor" : false,
 266       "isPrivate" : false,
 267       "memberOf" : "Roo.bootstrap.Modal",
 268       "example" : "",
 269       "deprecated" : "",
 270       "since" : "",
 271       "see" : "",
 272       "params" : [
 273         {
 274           "name" : "str",
 275           "type" : "String",
 276           "desc" : "new Title",
 277           "isOptional" : false
 278         }
 279       ],
 280       "returns" : [
 281       ]
 282     },
 283     {
 284       "name" : "setBody",
 285       "desc" : "Set the body of the Dialog",
 286       "isStatic" : false,
 287       "isConstructor" : false,
 288       "isPrivate" : false,
 289       "memberOf" : "Roo.bootstrap.Modal",
 290       "example" : "",
 291       "deprecated" : "",
 292       "since" : "",
 293       "see" : "",
 294       "params" : [
 295         {
 296           "name" : "str",
 297           "type" : "String",
 298           "desc" : "new Title",
 299           "isOptional" : false
 300         }
 301       ],
 302       "returns" : [
 303       ]
 304     },
 305     {
 306       "name" : "tooltipEl",
 307       "desc" : "Fetch the element to display the tooltip on.",
 308       "isStatic" : false,
 309       "isConstructor" : false,
 310       "isPrivate" : false,
 311       "memberOf" : "Roo.bootstrap.Component",
 312       "example" : "",
 313       "deprecated" : "",
 314       "since" : "",
 315       "see" : "",
 316       "params" : [
 317       ],
 318       "returns" : [
 319         {
 320           "name" : "",
 321           "type" : "Roo.Element",
 322           "desc" : "defaults to this.el"
 323         }
 324       ]
 325     },
 326     {
 327       "name" : "hide",
 328       "desc" : "Hide a component - adds 'hidden' class",
 329       "isStatic" : false,
 330       "isConstructor" : false,
 331       "isPrivate" : false,
 332       "memberOf" : "Roo.bootstrap.Component",
 333       "example" : "",
 334       "deprecated" : "",
 335       "since" : "",
 336       "see" : "",
 337       "params" : [
 338       ],
 339       "returns" : [
 340       ]
 341     },
 342     {
 343       "name" : "show",
 344       "desc" : "Show a component - removes '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" : "setVisibilityEl",
 360       "desc" : "Set the element that will be used to show or hide",
 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" : "getVisibilityEl",
 376       "desc" : "Get 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" : "initEvents",
 392       "desc" : "Initialize Events for the element",
 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" : "getChildContainer",
 408       "desc" : "Fetch the element to add children to",
 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           "name" : "",
 422           "type" : "Roo.Element",
 423           "desc" : "defaults to this.el"
 424         }
 425       ]
 426     },
 427     {
 428       "name" : "getId",
 429       "desc" : "Returns the id of this component.",
 430       "isStatic" : false,
 431       "isConstructor" : false,
 432       "isPrivate" : false,
 433       "memberOf" : "Roo.Component",
 434       "example" : "",
 435       "deprecated" : "",
 436       "since" : "",
 437       "see" : "",
 438       "params" : [
 439       ],
 440       "returns" : [
 441         {
 442           "name" : "",
 443           "type" : "String",
 444           "desc" : ""
 445         }
 446       ]
 447     },
 448     {
 449       "name" : "render",
 450       "desc" : "If this is a lazy rendering component, render it to its container element.",
 451       "isStatic" : false,
 452       "isConstructor" : false,
 453       "isPrivate" : false,
 454       "memberOf" : "Roo.Component",
 455       "example" : "",
 456       "deprecated" : "",
 457       "since" : "",
 458       "see" : "",
 459       "params" : [
 460         {
 461           "name" : "container",
 462           "type" : "String/HTMLElement/Element",
 463           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 464           "isOptional" : false
 465         }
 466       ],
 467       "returns" : [
 468       ]
 469     },
 470     {
 471       "name" : "destroy",
 472       "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}.",
 473       "isStatic" : false,
 474       "isConstructor" : false,
 475       "isPrivate" : false,
 476       "memberOf" : "Roo.Component",
 477       "example" : "",
 478       "deprecated" : "",
 479       "since" : "",
 480       "see" : "",
 481       "params" : [
 482       ],
 483       "returns" : [
 484       ]
 485     },
 486     {
 487       "name" : "isVisible",
 488       "desc" : "Returns true if this component is visible.",
 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" : "setDisabled",
 504       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 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           "name" : "disabled",
 516           "type" : "Boolean",
 517           "desc" : "",
 518           "isOptional" : false
 519         }
 520       ],
 521       "returns" : [
 522       ]
 523     },
 524     {
 525       "name" : "focus",
 526       "desc" : "Try to focus this component.",
 527       "isStatic" : false,
 528       "isConstructor" : false,
 529       "isPrivate" : false,
 530       "memberOf" : "Roo.Component",
 531       "example" : "",
 532       "deprecated" : "",
 533       "since" : "",
 534       "see" : "",
 535       "params" : [
 536         {
 537           "name" : "selectText",
 538           "type" : "Boolean",
 539           "desc" : "True to also select the text in this component (if applicable)",
 540           "isOptional" : false
 541         }
 542       ],
 543       "returns" : [
 544         {
 545           "name" : "",
 546           "type" : "Roo.Component",
 547           "desc" : "this"
 548         }
 549       ]
 550     },
 551     {
 552       "name" : "enable",
 553       "desc" : "Enable this component.",
 554       "isStatic" : false,
 555       "isConstructor" : false,
 556       "isPrivate" : false,
 557       "memberOf" : "Roo.Component",
 558       "example" : "",
 559       "deprecated" : "",
 560       "since" : "",
 561       "see" : "",
 562       "params" : [
 563       ],
 564       "returns" : [
 565         {
 566           "name" : "",
 567           "type" : "Roo.Component",
 568           "desc" : "this"
 569         }
 570       ]
 571     },
 572     {
 573       "name" : "setVisible",
 574       "desc" : "Convenience function to hide or show this component by boolean.",
 575       "isStatic" : false,
 576       "isConstructor" : false,
 577       "isPrivate" : false,
 578       "memberOf" : "Roo.Component",
 579       "example" : "",
 580       "deprecated" : "",
 581       "since" : "",
 582       "see" : "",
 583       "params" : [
 584         {
 585           "name" : "visible",
 586           "type" : "Boolean",
 587           "desc" : "True to show, false to hide",
 588           "isOptional" : false
 589         }
 590       ],
 591       "returns" : [
 592         {
 593           "name" : "",
 594           "type" : "Roo.Component",
 595           "desc" : "this"
 596         }
 597       ]
 598     },
 599     {
 600       "name" : "disable",
 601       "desc" : "Disable this component.",
 602       "isStatic" : false,
 603       "isConstructor" : false,
 604       "isPrivate" : false,
 605       "memberOf" : "Roo.Component",
 606       "example" : "",
 607       "deprecated" : "",
 608       "since" : "",
 609       "see" : "",
 610       "params" : [
 611       ],
 612       "returns" : [
 613         {
 614           "name" : "",
 615           "type" : "Roo.Component",
 616           "desc" : "this"
 617         }
 618       ]
 619     },
 620     {
 621       "name" : "getEl",
 622       "desc" : "Returns the underlying {@link Roo.Element}.",
 623       "isStatic" : false,
 624       "isConstructor" : false,
 625       "isPrivate" : false,
 626       "memberOf" : "Roo.Component",
 627       "example" : "",
 628       "deprecated" : "",
 629       "since" : "",
 630       "see" : "",
 631       "params" : [
 632       ],
 633       "returns" : [
 634         {
 635           "name" : "",
 636           "type" : "Roo.Element",
 637           "desc" : "The element"
 638         }
 639       ]
 640     },
 641     {
 642       "name" : "purgeListeners",
 643       "desc" : "Removes all listeners for this object",
 644       "isStatic" : false,
 645       "isConstructor" : false,
 646       "isPrivate" : false,
 647       "memberOf" : "Roo.util.Observable",
 648       "example" : "",
 649       "deprecated" : "",
 650       "since" : "",
 651       "see" : "",
 652       "params" : [
 653       ],
 654       "returns" : [
 655       ]
 656     },
 657     {
 658       "name" : "on",
 659       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 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           "name" : "eventName",
 671           "type" : "String",
 672           "desc" : "The type of event to listen for",
 673           "isOptional" : false
 674         },
 675         {
 676           "name" : "handler",
 677           "type" : "Function",
 678           "desc" : "The method the event invokes",
 679           "isOptional" : false
 680         },
 681         {
 682           "name" : "scope",
 683           "type" : "Object",
 684           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 685           "isOptional" : false
 686         },
 687         {
 688           "name" : "options",
 689           "type" : "Object",
 690           "desc" : "(optional)",
 691           "isOptional" : false
 692         }
 693       ],
 694       "returns" : [
 695       ]
 696     },
 697     {
 698       "name" : "un",
 699       "desc" : "Removes a listener (shorthand for removeListener)",
 700       "isStatic" : false,
 701       "isConstructor" : false,
 702       "isPrivate" : false,
 703       "memberOf" : "Roo.util.Observable",
 704       "example" : "",
 705       "deprecated" : "",
 706       "since" : "",
 707       "see" : "",
 708       "params" : [
 709         {
 710           "name" : "eventName",
 711           "type" : "String",
 712           "desc" : "The type of event to listen for",
 713           "isOptional" : false
 714         },
 715         {
 716           "name" : "handler",
 717           "type" : "Function",
 718           "desc" : "The handler to remove",
 719           "isOptional" : false
 720         },
 721         {
 722           "name" : "scope",
 723           "type" : "Object",
 724           "desc" : "(optional) The scope (this object) for the handler",
 725           "isOptional" : false
 726         }
 727       ],
 728       "returns" : [
 729       ]
 730     },
 731     {
 732       "name" : "addEvents",
 733       "desc" : "Used to define events on this Observable",
 734       "isStatic" : false,
 735       "isConstructor" : false,
 736       "isPrivate" : false,
 737       "memberOf" : "Roo.util.Observable",
 738       "example" : "",
 739       "deprecated" : "",
 740       "since" : "",
 741       "see" : "",
 742       "params" : [
 743         {
 744           "name" : "object",
 745           "type" : "Object",
 746           "desc" : "The object with the events defined",
 747           "isOptional" : false
 748         }
 749       ],
 750       "returns" : [
 751       ]
 752     },
 753     {
 754       "name" : "releaseCapture",
 755       "desc" : "Removes <b>all</b> added captures from the Observable.",
 756       "isStatic" : true,
 757       "isConstructor" : false,
 758       "isPrivate" : false,
 759       "memberOf" : "Roo.util.Observable",
 760       "example" : "",
 761       "deprecated" : "",
 762       "since" : "",
 763       "see" : "",
 764       "params" : [
 765         {
 766           "name" : "o",
 767           "type" : "Observable",
 768           "desc" : "The Observable to release",
 769           "isOptional" : false
 770         }
 771       ],
 772       "returns" : [
 773       ]
 774     },
 775     {
 776       "name" : "removeListener",
 777       "desc" : "Removes a listener",
 778       "isStatic" : false,
 779       "isConstructor" : false,
 780       "isPrivate" : false,
 781       "memberOf" : "Roo.util.Observable",
 782       "example" : "",
 783       "deprecated" : "",
 784       "since" : "",
 785       "see" : "",
 786       "params" : [
 787         {
 788           "name" : "eventName",
 789           "type" : "String",
 790           "desc" : "The type of event to listen for",
 791           "isOptional" : false
 792         },
 793         {
 794           "name" : "handler",
 795           "type" : "Function",
 796           "desc" : "The handler to remove",
 797           "isOptional" : false
 798         },
 799         {
 800           "name" : "scope",
 801           "type" : "Object",
 802           "desc" : "(optional) The scope (this object) for the handler",
 803           "isOptional" : false
 804         }
 805       ],
 806       "returns" : [
 807       ]
 808     },
 809     {
 810       "name" : "fireEvent",
 811       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 812       "isStatic" : false,
 813       "isConstructor" : false,
 814       "isPrivate" : false,
 815       "memberOf" : "Roo.util.Observable",
 816       "example" : "",
 817       "deprecated" : "",
 818       "since" : "",
 819       "see" : "",
 820       "params" : [
 821         {
 822           "name" : "eventName",
 823           "type" : "String",
 824           "desc" : "",
 825           "isOptional" : false
 826         },
 827         {
 828           "name" : "args",
 829           "type" : "Object...",
 830           "desc" : "Variable number of parameters are passed to handlers",
 831           "isOptional" : false
 832         }
 833       ],
 834       "returns" : [
 835         {
 836           "name" : "",
 837           "type" : "Boolean",
 838           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 839         }
 840       ]
 841     },
 842     {
 843       "name" : "hasListener",
 844       "desc" : "Checks to see if this object has any listeners for a specified event",
 845       "isStatic" : false,
 846       "isConstructor" : false,
 847       "isPrivate" : false,
 848       "memberOf" : "Roo.util.Observable",
 849       "example" : "",
 850       "deprecated" : "",
 851       "since" : "",
 852       "see" : "",
 853       "params" : [
 854         {
 855           "name" : "eventName",
 856           "type" : "String",
 857           "desc" : "The name of the event to check for",
 858           "isOptional" : false
 859         }
 860       ],
 861       "returns" : [
 862         {
 863           "name" : "",
 864           "type" : "Boolean",
 865           "desc" : "True if the event is being listened for, else false"
 866         }
 867       ]
 868     },
 869     {
 870       "name" : "capture",
 871       "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.",
 872       "isStatic" : true,
 873       "isConstructor" : false,
 874       "isPrivate" : false,
 875       "memberOf" : "Roo.util.Observable",
 876       "example" : "",
 877       "deprecated" : "",
 878       "since" : "",
 879       "see" : "",
 880       "params" : [
 881         {
 882           "name" : "o",
 883           "type" : "Observable",
 884           "desc" : "The Observable to capture",
 885           "isOptional" : false
 886         },
 887         {
 888           "name" : "fn",
 889           "type" : "Function",
 890           "desc" : "The function to call",
 891           "isOptional" : false
 892         },
 893         {
 894           "name" : "scope",
 895           "type" : "Object",
 896           "desc" : "(optional) The scope (this object) for the fn",
 897           "isOptional" : false
 898         }
 899       ],
 900       "returns" : [
 901       ]
 902     },
 903     {
 904       "name" : "addListener",
 905       "desc" : "Appends an event handler to this component",
 906       "isStatic" : false,
 907       "isConstructor" : false,
 908       "isPrivate" : false,
 909       "memberOf" : "Roo.util.Observable",
 910       "example" : "",
 911       "deprecated" : "",
 912       "since" : "",
 913       "see" : "",
 914       "params" : [
 915         {
 916           "name" : "eventName",
 917           "type" : "String",
 918           "desc" : "The type of event to listen for",
 919           "isOptional" : false
 920         },
 921         {
 922           "name" : "handler",
 923           "type" : "Function",
 924           "desc" : "The method the event invokes",
 925           "isOptional" : false
 926         },
 927         {
 928           "name" : "scope",
 929           "type" : "Object",
 930           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 931           "isOptional" : false
 932         },
 933         {
 934           "name" : "options",
 935           "type" : "Object",
 936           "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>",
 937           "isOptional" : false
 938         }
 939       ],
 940       "returns" : [
 941       ]
 942     }
 943   ],
 944   "events" : [
 945     {
 946       "name" : "btnclick",
 947       "desc" : "The raw btnclick event for the button",
 948       "memberOf" : "",
 949       "example" : "",
 950       "deprecated" : "",
 951       "since" : "",
 952       "see" : "",
 953       "params" : [
 954         {
 955           "name" : "e",
 956           "type" : "Roo.EventObject",
 957           "desc" : "",
 958           "isOptional" : false
 959         }
 960       ],
 961       "returns" : [
 962       ]
 963     },
 964     {
 965       "name" : "resize",
 966       "desc" : "Fire when dialog resize",
 967       "memberOf" : "",
 968       "example" : "",
 969       "deprecated" : "",
 970       "since" : "",
 971       "see" : "",
 972       "params" : [
 973         {
 974           "name" : "this",
 975           "type" : "Roo.bootstrap.Modal",
 976           "desc" : "",
 977           "isOptional" : false
 978         },
 979         {
 980           "name" : "e",
 981           "type" : "Roo.EventObject",
 982           "desc" : "",
 983           "isOptional" : false
 984         }
 985       ],
 986       "returns" : [
 987       ]
 988     },
 989     {
 990       "name" : "childrenrendered",
 991       "desc" : "Fires when the children have been rendered..",
 992       "memberOf" : "Roo.bootstrap.Component",
 993       "example" : "",
 994       "deprecated" : "",
 995       "since" : "",
 996       "see" : "",
 997       "params" : [
 998         {
 999           "name" : "this",
1000           "type" : "Roo.bootstrap.Component",
1001           "desc" : "",
1002           "isOptional" : false
1003         }
1004       ],
1005       "returns" : [
1006       ]
1007     },
1008     {
1009       "name" : "beforerender",
1010       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1011       "memberOf" : "Roo.Component",
1012       "example" : "",
1013       "deprecated" : "",
1014       "since" : "",
1015       "see" : "",
1016       "params" : [
1017         {
1018           "name" : "this",
1019           "type" : "Roo.Component",
1020           "desc" : "",
1021           "isOptional" : false
1022         }
1023       ],
1024       "returns" : [
1025       ]
1026     },
1027     {
1028       "name" : "disable",
1029       "desc" : "Fires after the component is disabled.",
1030       "memberOf" : "Roo.Component",
1031       "example" : "",
1032       "deprecated" : "",
1033       "since" : "",
1034       "see" : "",
1035       "params" : [
1036         {
1037           "name" : "this",
1038           "type" : "Roo.Component",
1039           "desc" : "",
1040           "isOptional" : false
1041         }
1042       ],
1043       "returns" : [
1044       ]
1045     },
1046     {
1047       "name" : "render",
1048       "desc" : "Fires after the component is rendered.",
1049       "memberOf" : "Roo.Component",
1050       "example" : "",
1051       "deprecated" : "",
1052       "since" : "",
1053       "see" : "",
1054       "params" : [
1055         {
1056           "name" : "this",
1057           "type" : "Roo.Component",
1058           "desc" : "",
1059           "isOptional" : false
1060         }
1061       ],
1062       "returns" : [
1063       ]
1064     },
1065     {
1066       "name" : "destroy",
1067       "desc" : "Fires after the component is destroyed.",
1068       "memberOf" : "Roo.Component",
1069       "example" : "",
1070       "deprecated" : "",
1071       "since" : "",
1072       "see" : "",
1073       "params" : [
1074         {
1075           "name" : "this",
1076           "type" : "Roo.Component",
1077           "desc" : "",
1078           "isOptional" : false
1079         }
1080       ],
1081       "returns" : [
1082       ]
1083     },
1084     {
1085       "name" : "hide",
1086       "desc" : "Fires after the component is hidden.",
1087       "memberOf" : "Roo.Component",
1088       "example" : "",
1089       "deprecated" : "",
1090       "since" : "",
1091       "see" : "",
1092       "params" : [
1093         {
1094           "name" : "this",
1095           "type" : "Roo.Component",
1096           "desc" : "",
1097           "isOptional" : false
1098         }
1099       ],
1100       "returns" : [
1101       ]
1102     },
1103     {
1104       "name" : "beforehide",
1105       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1106       "memberOf" : "Roo.Component",
1107       "example" : "",
1108       "deprecated" : "",
1109       "since" : "",
1110       "see" : "",
1111       "params" : [
1112         {
1113           "name" : "this",
1114           "type" : "Roo.Component",
1115           "desc" : "",
1116           "isOptional" : false
1117         }
1118       ],
1119       "returns" : [
1120       ]
1121     },
1122     {
1123       "name" : "show",
1124       "desc" : "Fires after the component is shown.",
1125       "memberOf" : "Roo.Component",
1126       "example" : "",
1127       "deprecated" : "",
1128       "since" : "",
1129       "see" : "",
1130       "params" : [
1131         {
1132           "name" : "this",
1133           "type" : "Roo.Component",
1134           "desc" : "",
1135           "isOptional" : false
1136         }
1137       ],
1138       "returns" : [
1139       ]
1140     },
1141     {
1142       "name" : "beforeshow",
1143       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1144       "memberOf" : "Roo.Component",
1145       "example" : "",
1146       "deprecated" : "",
1147       "since" : "",
1148       "see" : "",
1149       "params" : [
1150         {
1151           "name" : "this",
1152           "type" : "Roo.Component",
1153           "desc" : "",
1154           "isOptional" : false
1155         }
1156       ],
1157       "returns" : [
1158       ]
1159     },
1160     {
1161       "name" : "enable",
1162       "desc" : "Fires after the component is enabled.",
1163       "memberOf" : "Roo.Component",
1164       "example" : "",
1165       "deprecated" : "",
1166       "since" : "",
1167       "see" : "",
1168       "params" : [
1169         {
1170           "name" : "this",
1171           "type" : "Roo.Component",
1172           "desc" : "",
1173           "isOptional" : false
1174         }
1175       ],
1176       "returns" : [
1177       ]
1178     },
1179     {
1180       "name" : "beforedestroy",
1181       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1182       "memberOf" : "Roo.Component",
1183       "example" : "",
1184       "deprecated" : "",
1185       "since" : "",
1186       "see" : "",
1187       "params" : [
1188         {
1189           "name" : "this",
1190           "type" : "Roo.Component",
1191           "desc" : "",
1192           "isOptional" : false
1193         }
1194       ],
1195       "returns" : [
1196       ]
1197     }
1198   ]
1199 }