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