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