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