git.roojs.org Git - roojs1/blob - docs/symbols/Roo.menu.Item.json

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