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