git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.Menu.json

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