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