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