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

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