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

   1 {
   2   "name" : "Roo.menu.Menu",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "A menu object.  This is the container to which you add all other menu items.  Menu can also serve a as a base class\nwhen you want a specialzed menu based off of another component (like {@link Roo.menu.DateMenu} for example).",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "Menu",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "config",
  18       "type" : "Object",
  19       "desc" : "Configuration options",
  20       "isOptional" : false
  21     }
  22   ],
  23   "returns" : [],
  24   "throws" : "",
  25   "requires" : "",
  26   "config" : [
  27     {
  28       "name" : "listeners",
  29       "type" : "Object",
  30       "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>",
  31       "memberOf" : "Roo.util.Observable"
  32     },
  33     {
  34       "name" : "shadow",
  35       "type" : "Boolean/String",
  36       "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"sides\")",
  37       "memberOf" : ""
  38     },
  39     {
  40       "name" : "defaultAlign",
  41       "type" : "String",
  42       "desc" : "The default {@link Roo.Element#alignTo) anchor position value for this menu\nrelative to its element of origin (defaults to \"tl-bl?\")",
  43       "memberOf" : ""
  44     },
  45     {
  46       "name" : "subMenuAlign",
  47       "type" : "String",
  48       "desc" : "The {@link Roo.Element#alignTo} anchor position value to use for submenus of\nthis menu (defaults to \"tl-tr?\")",
  49       "memberOf" : ""
  50     },
  51     {
  52       "name" : "minWidth",
  53       "type" : "Number",
  54       "desc" : "The minimum width of the menu in pixels (defaults to 120)",
  55       "memberOf" : ""
  56     },
  57     {
  58       "name" : "registerMenu",
  59       "type" : "Boolean",
  60       "desc" : "True (default) - means that clicking on screen etc. hides it.",
  61       "memberOf" : ""
  62     },
  63     {
  64       "name" : "allowOtherMenus",
  65       "type" : "Boolean",
  66       "desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
  67       "memberOf" : ""
  68     }
  69   ],
  70   "methods" : [
  71     {
  72       "name" : "addMenuItem",
  73       "type" : "function",
  74       "desc" : "Creates a new {@link Roo.menu.Item} based an the supplied config object and adds it to the menu",
  75       "sig" : "(config)",
  76       "static" : false,
  77       "memberOf" : "",
  78       "isStatic" : false,
  79       "isConstructor" : false,
  80       "isPrivate" : false,
  81       "example" : "",
  82       "deprecated" : "",
  83       "since" : "",
  84       "see" : "",
  85       "exceptions" : "",
  86       "requires" : "",
  87       "params" : [
  88         {
  89           "name" : "config",
  90           "type" : "Object",
  91           "desc" : "A MenuItem config object",
  92           "isOptional" : false
  93         }
  94       ],
  95       "returns" : [
  96         {
  97           "name" : "",
  98           "type" : "Roo.menu.Item",
  99           "desc" : "The menu item that was added"
 100         }
 101       ]
 102     },
 103     {
 104       "name" : "addElement",
 105       "type" : "function",
 106       "desc" : "Adds an {@link Roo.Element} object to the menu",
 107       "sig" : "(el)",
 108       "static" : false,
 109       "memberOf" : "",
 110       "isStatic" : false,
 111       "isConstructor" : false,
 112       "isPrivate" : false,
 113       "example" : "",
 114       "deprecated" : "",
 115       "since" : "",
 116       "see" : "",
 117       "exceptions" : "",
 118       "requires" : "",
 119       "params" : [
 120         {
 121           "name" : "el",
 122           "type" : "String/HTMLElement/Roo.Element",
 123           "desc" : "The element or DOM node to add, or its id",
 124           "isOptional" : false
 125         }
 126       ],
 127       "returns" : [
 128         {
 129           "name" : "",
 130           "type" : "Roo.menu.Item",
 131           "desc" : "The menu item that was added"
 132         }
 133       ]
 134     },
 135     {
 136       "name" : "isVisible",
 137       "type" : "function",
 138       "desc" : "Read-only.  Returns true if the menu is currently displayed, else false.",
 139       "sig" : "()\n{\n\n}",
 140       "static" : false,
 141       "memberOf" : "",
 142       "isStatic" : false,
 143       "isConstructor" : false,
 144       "isPrivate" : false,
 145       "example" : "",
 146       "deprecated" : "",
 147       "since" : "",
 148       "see" : "",
 149       "exceptions" : "",
 150       "requires" : "",
 151       "params" : [],
 152       "returns" : []
 153     },
 154     {
 155       "name" : "add",
 156       "type" : "function",
 157       "desc" : "Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.\nAny of the following are valid:\n<ul>\n<li>Any menu item object based on {@link Roo.menu.Item}</li>\n<li>An HTMLElement object which will be converted to a menu item</li>\n<li>A menu item config object that will be created as a new menu item</li>\n<li>A string, which can either be '-' or 'separator' to add a menu separator, otherwise\nit will be converted into a {@link Roo.menu.TextItem} and added</li>\n</ul>\nUsage:\n<pre><code>\n// Create the menu\nvar menu = new Roo.menu.Menu();\n\n// Create a menu item to add by reference\nvar menuItem = new Roo.menu.Item({ text: 'New Item!' });\n\n// Add a bunch of items at once using different methods.\n// Only the last item added will be returned.\nvar item = menu.add(\n    menuItem,                // add existing item by ref\n    'Dynamic Item',          // new TextItem\n    '-',                     // new separator\n    { text: 'Config Item' }  // new item by config\n);\n</code></pre>",
 158       "sig" : "(args)",
 159       "static" : false,
 160       "memberOf" : "",
 161       "isStatic" : false,
 162       "isConstructor" : false,
 163       "isPrivate" : false,
 164       "example" : "",
 165       "deprecated" : "",
 166       "since" : "",
 167       "see" : "",
 168       "exceptions" : "",
 169       "requires" : "",
 170       "params" : [
 171         {
 172           "name" : "args",
 173           "type" : "Mixed",
 174           "desc" : "One or more menu items, menu item configs or other objects that can be converted to menu items",
 175           "isOptional" : false
 176         }
 177       ],
 178       "returns" : [
 179         {
 180           "name" : "",
 181           "type" : "Roo.menu.Item",
 182           "desc" : "The menu item that was added, or the last one if multiple items were added"
 183         }
 184       ]
 185     },
 186     {
 187       "name" : "addSeparator",
 188       "type" : "function",
 189       "desc" : "Adds a separator bar to the menu",
 190       "sig" : "()\n{\n\n}",
 191       "static" : false,
 192       "memberOf" : "",
 193       "isStatic" : false,
 194       "isConstructor" : false,
 195       "isPrivate" : false,
 196       "example" : "",
 197       "deprecated" : "",
 198       "since" : "",
 199       "see" : "",
 200       "exceptions" : "",
 201       "requires" : "",
 202       "params" : [],
 203       "returns" : [
 204         {
 205           "name" : "",
 206           "type" : "Roo.menu.Item",
 207           "desc" : "The menu item that was added"
 208         }
 209       ]
 210     },
 211     {
 212       "name" : "removeAll",
 213       "type" : "function",
 214       "desc" : "Removes and destroys all items in the menu",
 215       "sig" : "()\n{\n\n}",
 216       "static" : false,
 217       "memberOf" : "",
 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     {
 231       "name" : "remove",
 232       "type" : "function",
 233       "desc" : "Removes an {@link Roo.menu.Item} from the menu and destroys the object",
 234       "sig" : "(item)",
 235       "static" : false,
 236       "memberOf" : "",
 237       "isStatic" : false,
 238       "isConstructor" : false,
 239       "isPrivate" : false,
 240       "example" : "",
 241       "deprecated" : "",
 242       "since" : "",
 243       "see" : "",
 244       "exceptions" : "",
 245       "requires" : "",
 246       "params" : [
 247         {
 248           "name" : "item",
 249           "type" : "Roo.menu.Item",
 250           "desc" : "The menu item to remove",
 251           "isOptional" : false
 252         }
 253       ],
 254       "returns" : []
 255     },
 256     {
 257       "name" : "getEl",
 258       "type" : "function",
 259       "desc" : "Returns this menu's underlying {@link Roo.Element} object",
 260       "sig" : "()\n{\n\n}",
 261       "static" : false,
 262       "memberOf" : "",
 263       "isStatic" : false,
 264       "isConstructor" : false,
 265       "isPrivate" : false,
 266       "example" : "",
 267       "deprecated" : "",
 268       "since" : "",
 269       "see" : "",
 270       "exceptions" : "",
 271       "requires" : "",
 272       "params" : [],
 273       "returns" : [
 274         {
 275           "name" : "",
 276           "type" : "Roo.Element",
 277           "desc" : "The element"
 278         }
 279       ]
 280     },
 281     {
 282       "name" : "insert",
 283       "type" : "function",
 284       "desc" : "Inserts an existing object based on {@link Roo.menu.Item} to the menu at a specified index",
 285       "sig" : "(index, item)",
 286       "static" : false,
 287       "memberOf" : "",
 288       "isStatic" : false,
 289       "isConstructor" : false,
 290       "isPrivate" : false,
 291       "example" : "",
 292       "deprecated" : "",
 293       "since" : "",
 294       "see" : "",
 295       "exceptions" : "",
 296       "requires" : "",
 297       "params" : [
 298         {
 299           "name" : "index",
 300           "type" : "Number",
 301           "desc" : "The index in the menu's list of current items where the new item should be inserted",
 302           "isOptional" : false
 303         },
 304         {
 305           "name" : "item",
 306           "type" : "Roo.menu.Item",
 307           "desc" : "The menu item to add",
 308           "isOptional" : false
 309         }
 310       ],
 311       "returns" : [
 312         {
 313           "name" : "",
 314           "type" : "Roo.menu.Item",
 315           "desc" : "The menu item that was added"
 316         }
 317       ]
 318     },
 319     {
 320       "name" : "hide",
 321       "type" : "function",
 322       "desc" : "Hides this menu and optionally all parent menus",
 323       "sig" : "(deep)",
 324       "static" : false,
 325       "memberOf" : "",
 326       "isStatic" : false,
 327       "isConstructor" : false,
 328       "isPrivate" : false,
 329       "example" : "",
 330       "deprecated" : "",
 331       "since" : "",
 332       "see" : "",
 333       "exceptions" : "",
 334       "requires" : "",
 335       "params" : [
 336         {
 337           "name" : "deep",
 338           "type" : "Boolean",
 339           "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
 340           "isOptional" : false
 341         }
 342       ],
 343       "returns" : []
 344     },
 345     {
 346       "name" : "show",
 347       "type" : "function",
 348       "desc" : "Displays this menu relative to another element",
 349       "sig" : "(element, position, parentMenu)",
 350       "static" : false,
 351       "memberOf" : "",
 352       "isStatic" : false,
 353       "isConstructor" : false,
 354       "isPrivate" : false,
 355       "example" : "",
 356       "deprecated" : "",
 357       "since" : "",
 358       "see" : "",
 359       "exceptions" : "",
 360       "requires" : "",
 361       "params" : [
 362         {
 363           "name" : "element",
 364           "type" : "String/HTMLElement/Roo.Element",
 365           "desc" : "The element to align to",
 366           "isOptional" : false
 367         },
 368         {
 369           "name" : "position",
 370           "type" : "String",
 371           "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
 372           "isOptional" : false
 373         },
 374         {
 375           "name" : "parentMenu",
 376           "type" : "Roo.menu.Menu",
 377           "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
 378           "isOptional" : false
 379         }
 380       ],
 381       "returns" : []
 382     },
 383     {
 384       "name" : "addText",
 385       "type" : "function",
 386       "desc" : "Creates a new {@link Roo.menu.TextItem} with the supplied text and adds it to the menu",
 387       "sig" : "(text)",
 388       "static" : false,
 389       "memberOf" : "",
 390       "isStatic" : false,
 391       "isConstructor" : false,
 392       "isPrivate" : false,
 393       "example" : "",
 394       "deprecated" : "",
 395       "since" : "",
 396       "see" : "",
 397       "exceptions" : "",
 398       "requires" : "",
 399       "params" : [
 400         {
 401           "name" : "text",
 402           "type" : "String",
 403           "desc" : "The text to display in the menu item",
 404           "isOptional" : false
 405         }
 406       ],
 407       "returns" : [
 408         {
 409           "name" : "",
 410           "type" : "Roo.menu.Item",
 411           "desc" : "The menu item that was added"
 412         }
 413       ]
 414     },
 415     {
 416       "name" : "addItem",
 417       "type" : "function",
 418       "desc" : "Adds an existing object based on {@link Roo.menu.Item} to the menu",
 419       "sig" : "(item)",
 420       "static" : false,
 421       "memberOf" : "",
 422       "isStatic" : false,
 423       "isConstructor" : false,
 424       "isPrivate" : false,
 425       "example" : "",
 426       "deprecated" : "",
 427       "since" : "",
 428       "see" : "",
 429       "exceptions" : "",
 430       "requires" : "",
 431       "params" : [
 432         {
 433           "name" : "item",
 434           "type" : "Roo.menu.Item",
 435           "desc" : "The menu item to add",
 436           "isOptional" : false
 437         }
 438       ],
 439       "returns" : [
 440         {
 441           "name" : "",
 442           "type" : "Roo.menu.Item",
 443           "desc" : "The menu item that was added"
 444         }
 445       ]
 446     },
 447     {
 448       "name" : "showAt",
 449       "type" : "function",
 450       "desc" : "Displays this menu at a specific xy position",
 451       "sig" : "(xyPosition, parentMenu)",
 452       "static" : false,
 453       "memberOf" : "",
 454       "isStatic" : false,
 455       "isConstructor" : false,
 456       "isPrivate" : false,
 457       "example" : "",
 458       "deprecated" : "",
 459       "since" : "",
 460       "see" : "",
 461       "exceptions" : "",
 462       "requires" : "",
 463       "params" : [
 464         {
 465           "name" : "xyPosition",
 466           "type" : "Array",
 467           "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
 468           "isOptional" : false
 469         },
 470         {
 471           "name" : "parentMenu",
 472           "type" : "Roo.menu.Menu",
 473           "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
 474           "isOptional" : false
 475         }
 476       ],
 477       "returns" : []
 478     },
 479     {
 480       "name" : "purgeListeners",
 481       "type" : "function",
 482       "desc" : "Removes all listeners for this object",
 483       "sig" : "()\n{\n\n}",
 484       "static" : false,
 485       "memberOf" : "Roo.util.Observable",
 486       "isStatic" : false,
 487       "isConstructor" : false,
 488       "isPrivate" : false,
 489       "example" : "",
 490       "deprecated" : "",
 491       "since" : "",
 492       "see" : "",
 493       "exceptions" : "",
 494       "requires" : "",
 495       "params" : [],
 496       "returns" : []
 497     },
 498     {
 499       "name" : "on",
 500       "type" : "function",
 501       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 502       "sig" : "(eventName, handler, scope, options)",
 503       "static" : false,
 504       "memberOf" : "Roo.util.Observable",
 505       "isStatic" : false,
 506       "isConstructor" : false,
 507       "isPrivate" : false,
 508       "example" : "",
 509       "deprecated" : "",
 510       "since" : "",
 511       "see" : "",
 512       "exceptions" : "",
 513       "requires" : "",
 514       "params" : [
 515         {
 516           "name" : "eventName",
 517           "type" : "String",
 518           "desc" : "The type of event to listen for",
 519           "isOptional" : false
 520         },
 521         {
 522           "name" : "handler",
 523           "type" : "Function",
 524           "desc" : "The method the event invokes",
 525           "isOptional" : false
 526         },
 527         {
 528           "name" : "scope",
 529           "type" : "Object",
 530           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 531           "isOptional" : false
 532         },
 533         {
 534           "name" : "options",
 535           "type" : "Object",
 536           "desc" : "(optional)",
 537           "isOptional" : false
 538         }
 539       ],
 540       "returns" : []
 541     },
 542     {
 543       "name" : "un",
 544       "type" : "function",
 545       "desc" : "Removes a listener (shorthand for removeListener)",
 546       "sig" : "(eventName, handler, scope)",
 547       "static" : false,
 548       "memberOf" : "Roo.util.Observable",
 549       "isStatic" : false,
 550       "isConstructor" : false,
 551       "isPrivate" : false,
 552       "example" : "",
 553       "deprecated" : "",
 554       "since" : "",
 555       "see" : "",
 556       "exceptions" : "",
 557       "requires" : "",
 558       "params" : [
 559         {
 560           "name" : "eventName",
 561           "type" : "String",
 562           "desc" : "The type of event to listen for",
 563           "isOptional" : false
 564         },
 565         {
 566           "name" : "handler",
 567           "type" : "Function",
 568           "desc" : "The handler to remove",
 569           "isOptional" : false
 570         },
 571         {
 572           "name" : "scope",
 573           "type" : "Object",
 574           "desc" : "(optional) The scope (this object) for the handler",
 575           "isOptional" : false
 576         }
 577       ],
 578       "returns" : []
 579     },
 580     {
 581       "name" : "addEvents",
 582       "type" : "function",
 583       "desc" : "Used to define events on this Observable",
 584       "sig" : "(object)",
 585       "static" : false,
 586       "memberOf" : "Roo.util.Observable",
 587       "isStatic" : false,
 588       "isConstructor" : false,
 589       "isPrivate" : false,
 590       "example" : "",
 591       "deprecated" : "",
 592       "since" : "",
 593       "see" : "",
 594       "exceptions" : "",
 595       "requires" : "",
 596       "params" : [
 597         {
 598           "name" : "object",
 599           "type" : "Object",
 600           "desc" : "The object with the events defined",
 601           "isOptional" : false
 602         }
 603       ],
 604       "returns" : []
 605     },
 606     {
 607       "name" : "releaseCapture",
 608       "type" : "function",
 609       "desc" : "Removes <b>all</b> added captures from the Observable.",
 610       "sig" : "(o)",
 611       "static" : true,
 612       "memberOf" : "Roo.util.Observable",
 613       "isStatic" : true,
 614       "isConstructor" : false,
 615       "isPrivate" : false,
 616       "example" : "",
 617       "deprecated" : "",
 618       "since" : "",
 619       "see" : "",
 620       "exceptions" : "",
 621       "requires" : "",
 622       "params" : [
 623         {
 624           "name" : "o",
 625           "type" : "Observable",
 626           "desc" : "The Observable to release",
 627           "isOptional" : false
 628         }
 629       ],
 630       "returns" : []
 631     },
 632     {
 633       "name" : "removeListener",
 634       "type" : "function",
 635       "desc" : "Removes a listener",
 636       "sig" : "(eventName, handler, scope)",
 637       "static" : false,
 638       "memberOf" : "Roo.util.Observable",
 639       "isStatic" : false,
 640       "isConstructor" : false,
 641       "isPrivate" : false,
 642       "example" : "",
 643       "deprecated" : "",
 644       "since" : "",
 645       "see" : "",
 646       "exceptions" : "",
 647       "requires" : "",
 648       "params" : [
 649         {
 650           "name" : "eventName",
 651           "type" : "String",
 652           "desc" : "The type of event to listen for",
 653           "isOptional" : false
 654         },
 655         {
 656           "name" : "handler",
 657           "type" : "Function",
 658           "desc" : "The handler to remove",
 659           "isOptional" : false
 660         },
 661         {
 662           "name" : "scope",
 663           "type" : "Object",
 664           "desc" : "(optional) The scope (this object) for the handler",
 665           "isOptional" : false
 666         }
 667       ],
 668       "returns" : []
 669     },
 670     {
 671       "name" : "fireEvent",
 672       "type" : "function",
 673       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 674       "sig" : "(eventName, args)",
 675       "static" : false,
 676       "memberOf" : "Roo.util.Observable",
 677       "isStatic" : false,
 678       "isConstructor" : false,
 679       "isPrivate" : false,
 680       "example" : "",
 681       "deprecated" : "",
 682       "since" : "",
 683       "see" : "",
 684       "exceptions" : "",
 685       "requires" : "",
 686       "params" : [
 687         {
 688           "name" : "eventName",
 689           "type" : "String",
 690           "desc" : "",
 691           "isOptional" : false
 692         },
 693         {
 694           "name" : "args",
 695           "type" : "Object...",
 696           "desc" : "Variable number of parameters are passed to handlers",
 697           "isOptional" : false
 698         }
 699       ],
 700       "returns" : [
 701         {
 702           "name" : "",
 703           "type" : "Boolean",
 704           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 705         }
 706       ]
 707     },
 708     {
 709       "name" : "hasListener",
 710       "type" : "function",
 711       "desc" : "Checks to see if this object has any listeners for a specified event",
 712       "sig" : "(eventName)",
 713       "static" : false,
 714       "memberOf" : "Roo.util.Observable",
 715       "isStatic" : false,
 716       "isConstructor" : false,
 717       "isPrivate" : false,
 718       "example" : "",
 719       "deprecated" : "",
 720       "since" : "",
 721       "see" : "",
 722       "exceptions" : "",
 723       "requires" : "",
 724       "params" : [
 725         {
 726           "name" : "eventName",
 727           "type" : "String",
 728           "desc" : "The name of the event to check for",
 729           "isOptional" : false
 730         }
 731       ],
 732       "returns" : [
 733         {
 734           "name" : "",
 735           "type" : "Boolean",
 736           "desc" : "True if the event is being listened for, else false"
 737         }
 738       ]
 739     },
 740     {
 741       "name" : "capture",
 742       "type" : "function",
 743       "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.",
 744       "sig" : "(o, fn, scope)",
 745       "static" : true,
 746       "memberOf" : "Roo.util.Observable",
 747       "isStatic" : true,
 748       "isConstructor" : false,
 749       "isPrivate" : false,
 750       "example" : "",
 751       "deprecated" : "",
 752       "since" : "",
 753       "see" : "",
 754       "exceptions" : "",
 755       "requires" : "",
 756       "params" : [
 757         {
 758           "name" : "o",
 759           "type" : "Observable",
 760           "desc" : "The Observable to capture",
 761           "isOptional" : false
 762         },
 763         {
 764           "name" : "fn",
 765           "type" : "Function",
 766           "desc" : "The function to call",
 767           "isOptional" : false
 768         },
 769         {
 770           "name" : "scope",
 771           "type" : "Object",
 772           "desc" : "(optional) The scope (this object) for the fn",
 773           "isOptional" : false
 774         }
 775       ],
 776       "returns" : []
 777     },
 778     {
 779       "name" : "addListener",
 780       "type" : "function",
 781       "desc" : "Appends an event handler to this component",
 782       "sig" : "(eventName, handler, scope, options)",
 783       "static" : false,
 784       "memberOf" : "Roo.util.Observable",
 785       "isStatic" : false,
 786       "isConstructor" : false,
 787       "isPrivate" : false,
 788       "example" : "",
 789       "deprecated" : "",
 790       "since" : "",
 791       "see" : "",
 792       "exceptions" : "",
 793       "requires" : "",
 794       "params" : [
 795         {
 796           "name" : "eventName",
 797           "type" : "String",
 798           "desc" : "The type of event to listen for",
 799           "isOptional" : false
 800         },
 801         {
 802           "name" : "handler",
 803           "type" : "Function",
 804           "desc" : "The method the event invokes",
 805           "isOptional" : false
 806         },
 807         {
 808           "name" : "scope",
 809           "type" : "Object",
 810           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 811           "isOptional" : false
 812         },
 813         {
 814           "name" : "options",
 815           "type" : "Object",
 816           "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>",
 817           "isOptional" : false
 818         }
 819       ],
 820       "returns" : []
 821     }
 822   ],
 823   "events" : [
 824     {
 825       "name" : "mouseover",
 826       "type" : "function",
 827       "desc" : "Fires when the mouse is hovering over this menu",
 828       "sig" : "function (_self, e, menuItem)\n{\n\n}",
 829       "memberOf" : "",
 830       "example" : "",
 831       "deprecated" : "",
 832       "since" : "",
 833       "see" : "",
 834       "params" : [
 835         {
 836           "name" : "this",
 837           "type" : "Roo.menu.Menu",
 838           "desc" : "",
 839           "isOptional" : false
 840         },
 841         {
 842           "name" : "e",
 843           "type" : "Roo.EventObject",
 844           "desc" : "",
 845           "isOptional" : false
 846         },
 847         {
 848           "name" : "menuItem",
 849           "type" : "Roo.menu.Item",
 850           "desc" : "The menu item that was clicked",
 851           "isOptional" : false
 852         }
 853       ],
 854       "returns" : []
 855     },
 856     {
 857       "name" : "mouseout",
 858       "type" : "function",
 859       "desc" : "Fires when the mouse exits this menu",
 860       "sig" : "function (_self, e, menuItem)\n{\n\n}",
 861       "memberOf" : "",
 862       "example" : "",
 863       "deprecated" : "",
 864       "since" : "",
 865       "see" : "",
 866       "params" : [
 867         {
 868           "name" : "this",
 869           "type" : "Roo.menu.Menu",
 870           "desc" : "",
 871           "isOptional" : false
 872         },
 873         {
 874           "name" : "e",
 875           "type" : "Roo.EventObject",
 876           "desc" : "",
 877           "isOptional" : false
 878         },
 879         {
 880           "name" : "menuItem",
 881           "type" : "Roo.menu.Item",
 882           "desc" : "The menu item that was clicked",
 883           "isOptional" : false
 884         }
 885       ],
 886       "returns" : []
 887     },
 888     {
 889       "name" : "beforehide",
 890       "type" : "function",
 891       "desc" : "Fires before this menu is hidden",
 892       "sig" : "function (_self)\n{\n\n}",
 893       "memberOf" : "",
 894       "example" : "",
 895       "deprecated" : "",
 896       "since" : "",
 897       "see" : "",
 898       "params" : [
 899         {
 900           "name" : "this",
 901           "type" : "Roo.menu.Menu",
 902           "desc" : "",
 903           "isOptional" : false
 904         }
 905       ],
 906       "returns" : []
 907     },
 908     {
 909       "name" : "itemclick",
 910       "type" : "function",
 911       "desc" : "Fires when a menu item contained in this menu is clicked",
 912       "sig" : "function (baseItem, e)\n{\n\n}",
 913       "memberOf" : "",
 914       "example" : "",
 915       "deprecated" : "",
 916       "since" : "",
 917       "see" : "",
 918       "params" : [
 919         {
 920           "name" : "baseItem",
 921           "type" : "Roo.menu.BaseItem",
 922           "desc" : "The BaseItem that was clicked",
 923           "isOptional" : false
 924         },
 925         {
 926           "name" : "e",
 927           "type" : "Roo.EventObject",
 928           "desc" : "",
 929           "isOptional" : false
 930         }
 931       ],
 932       "returns" : []
 933     },
 934     {
 935       "name" : "beforeshow",
 936       "type" : "function",
 937       "desc" : "Fires before this menu is displayed",
 938       "sig" : "function (_self)\n{\n\n}",
 939       "memberOf" : "",
 940       "example" : "",
 941       "deprecated" : "",
 942       "since" : "",
 943       "see" : "",
 944       "params" : [
 945         {
 946           "name" : "this",
 947           "type" : "Roo.menu.Menu",
 948           "desc" : "",
 949           "isOptional" : false
 950         }
 951       ],
 952       "returns" : []
 953     },
 954     {
 955       "name" : "hide",
 956       "type" : "function",
 957       "desc" : "Fires after this menu is hidden",
 958       "sig" : "function (_self)\n{\n\n}",
 959       "memberOf" : "",
 960       "example" : "",
 961       "deprecated" : "",
 962       "since" : "",
 963       "see" : "",
 964       "params" : [
 965         {
 966           "name" : "this",
 967           "type" : "Roo.menu.Menu",
 968           "desc" : "",
 969           "isOptional" : false
 970         }
 971       ],
 972       "returns" : []
 973     },
 974     {
 975       "name" : "click",
 976       "type" : "function",
 977       "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
 978       "sig" : "function (_self, menuItem, e)\n{\n\n}",
 979       "memberOf" : "",
 980       "example" : "",
 981       "deprecated" : "",
 982       "since" : "",
 983       "see" : "",
 984       "params" : [
 985         {
 986           "name" : "this",
 987           "type" : "Roo.menu.Menu",
 988           "desc" : "",
 989           "isOptional" : false
 990         },
 991         {
 992           "name" : "menuItem",
 993           "type" : "Roo.menu.Item",
 994           "desc" : "The menu item that was clicked",
 995           "isOptional" : false
 996         },
 997         {
 998           "name" : "e",
 999           "type" : "Roo.EventObject",
1000           "desc" : "",
1001           "isOptional" : false
1002         }
1003       ],
1004       "returns" : []
1005     },
1006     {
1007       "name" : "show",
1008       "type" : "function",
1009       "desc" : "Fires after this menu is displayed",
1010       "sig" : "function (_self)\n{\n\n}",
1011       "memberOf" : "",
1012       "example" : "",
1013       "deprecated" : "",
1014       "since" : "",
1015       "see" : "",
1016       "params" : [
1017         {
1018           "name" : "this",
1019           "type" : "Roo.menu.Menu",
1020           "desc" : "",
1021           "isOptional" : false
1022         }
1023       ],
1024       "returns" : []
1025     }
1026   ]
1027 }