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