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