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