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