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