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