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