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