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

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