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