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