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