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

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