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

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