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

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