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