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