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