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