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