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

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