git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.Img.json

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