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

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