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'",
 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" : "tooltipEl",
 295       "desc" : "Fetch the element to display the tooltip on.",
 296       "isStatic" : false,
 297       "isConstructor" : false,
 298       "isPrivate" : false,
 299       "memberOf" : "Roo.bootstrap.Component",
 300       "example" : "",
 301       "deprecated" : "",
 302       "since" : "",
 303       "see" : "",
 304       "params" : [
 305       ],
 306       "returns" : [
 307         {
 308           "name" : "",
 309           "type" : "Roo.Element",
 310           "desc" : "defaults to this.el"
 311         }
 312       ]
 313     },
 314     {
 315       "name" : "hide",
 316       "desc" : "Hide a component - adds 'hidden' class",
 317       "isStatic" : false,
 318       "isConstructor" : false,
 319       "isPrivate" : false,
 320       "memberOf" : "Roo.bootstrap.Component",
 321       "example" : "",
 322       "deprecated" : "",
 323       "since" : "",
 324       "see" : "",
 325       "params" : [
 326       ],
 327       "returns" : [
 328       ]
 329     },
 330     {
 331       "name" : "show",
 332       "desc" : "Show a component - removes 'hidden' class",
 333       "isStatic" : false,
 334       "isConstructor" : false,
 335       "isPrivate" : false,
 336       "memberOf" : "Roo.bootstrap.Component",
 337       "example" : "",
 338       "deprecated" : "",
 339       "since" : "",
 340       "see" : "",
 341       "params" : [
 342       ],
 343       "returns" : [
 344       ]
 345     },
 346     {
 347       "name" : "setVisibilityEl",
 348       "desc" : "Set the element that will be used to show or hide",
 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" : "getVisibilityEl",
 364       "desc" : "Get the element that will be used to show or hide",
 365       "isStatic" : false,
 366       "isConstructor" : false,
 367       "isPrivate" : false,
 368       "memberOf" : "Roo.bootstrap.Component",
 369       "example" : "",
 370       "deprecated" : "",
 371       "since" : "",
 372       "see" : "",
 373       "params" : [
 374       ],
 375       "returns" : [
 376       ]
 377     },
 378     {
 379       "name" : "initEvents",
 380       "desc" : "Initialize Events for the element",
 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" : "getChildContainer",
 396       "desc" : "Fetch the element to add children to",
 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           "name" : "",
 410           "type" : "Roo.Element",
 411           "desc" : "defaults to this.el"
 412         }
 413       ]
 414     },
 415     {
 416       "name" : "getId",
 417       "desc" : "Returns the id of this component.",
 418       "isStatic" : false,
 419       "isConstructor" : false,
 420       "isPrivate" : false,
 421       "memberOf" : "Roo.Component",
 422       "example" : "",
 423       "deprecated" : "",
 424       "since" : "",
 425       "see" : "",
 426       "params" : [
 427       ],
 428       "returns" : [
 429         {
 430           "name" : "",
 431           "type" : "String",
 432           "desc" : ""
 433         }
 434       ]
 435     },
 436     {
 437       "name" : "render",
 438       "desc" : "If this is a lazy rendering component, render it to its container element.",
 439       "isStatic" : false,
 440       "isConstructor" : false,
 441       "isPrivate" : false,
 442       "memberOf" : "Roo.Component",
 443       "example" : "",
 444       "deprecated" : "",
 445       "since" : "",
 446       "see" : "",
 447       "params" : [
 448         {
 449           "name" : "container",
 450           "type" : "String/HTMLElement/Element",
 451           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 452           "isOptional" : false
 453         }
 454       ],
 455       "returns" : [
 456       ]
 457     },
 458     {
 459       "name" : "destroy",
 460       "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}.",
 461       "isStatic" : false,
 462       "isConstructor" : false,
 463       "isPrivate" : false,
 464       "memberOf" : "Roo.Component",
 465       "example" : "",
 466       "deprecated" : "",
 467       "since" : "",
 468       "see" : "",
 469       "params" : [
 470       ],
 471       "returns" : [
 472       ]
 473     },
 474     {
 475       "name" : "isVisible",
 476       "desc" : "Returns true if this component is visible.",
 477       "isStatic" : false,
 478       "isConstructor" : false,
 479       "isPrivate" : false,
 480       "memberOf" : "Roo.Component",
 481       "example" : "",
 482       "deprecated" : "",
 483       "since" : "",
 484       "see" : "",
 485       "params" : [
 486       ],
 487       "returns" : [
 488       ]
 489     },
 490     {
 491       "name" : "setDisabled",
 492       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 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           "name" : "disabled",
 504           "type" : "Boolean",
 505           "desc" : "",
 506           "isOptional" : false
 507         }
 508       ],
 509       "returns" : [
 510       ]
 511     },
 512     {
 513       "name" : "focus",
 514       "desc" : "Try to focus this component.",
 515       "isStatic" : false,
 516       "isConstructor" : false,
 517       "isPrivate" : false,
 518       "memberOf" : "Roo.Component",
 519       "example" : "",
 520       "deprecated" : "",
 521       "since" : "",
 522       "see" : "",
 523       "params" : [
 524         {
 525           "name" : "selectText",
 526           "type" : "Boolean",
 527           "desc" : "True to also select the text in this component (if applicable)",
 528           "isOptional" : false
 529         }
 530       ],
 531       "returns" : [
 532         {
 533           "name" : "",
 534           "type" : "Roo.Component",
 535           "desc" : "this"
 536         }
 537       ]
 538     },
 539     {
 540       "name" : "enable",
 541       "desc" : "Enable this component.",
 542       "isStatic" : false,
 543       "isConstructor" : false,
 544       "isPrivate" : false,
 545       "memberOf" : "Roo.Component",
 546       "example" : "",
 547       "deprecated" : "",
 548       "since" : "",
 549       "see" : "",
 550       "params" : [
 551       ],
 552       "returns" : [
 553         {
 554           "name" : "",
 555           "type" : "Roo.Component",
 556           "desc" : "this"
 557         }
 558       ]
 559     },
 560     {
 561       "name" : "setVisible",
 562       "desc" : "Convenience function to hide or show this component by boolean.",
 563       "isStatic" : false,
 564       "isConstructor" : false,
 565       "isPrivate" : false,
 566       "memberOf" : "Roo.Component",
 567       "example" : "",
 568       "deprecated" : "",
 569       "since" : "",
 570       "see" : "",
 571       "params" : [
 572         {
 573           "name" : "visible",
 574           "type" : "Boolean",
 575           "desc" : "True to show, false to hide",
 576           "isOptional" : false
 577         }
 578       ],
 579       "returns" : [
 580         {
 581           "name" : "",
 582           "type" : "Roo.Component",
 583           "desc" : "this"
 584         }
 585       ]
 586     },
 587     {
 588       "name" : "disable",
 589       "desc" : "Disable this component.",
 590       "isStatic" : false,
 591       "isConstructor" : false,
 592       "isPrivate" : false,
 593       "memberOf" : "Roo.Component",
 594       "example" : "",
 595       "deprecated" : "",
 596       "since" : "",
 597       "see" : "",
 598       "params" : [
 599       ],
 600       "returns" : [
 601         {
 602           "name" : "",
 603           "type" : "Roo.Component",
 604           "desc" : "this"
 605         }
 606       ]
 607     },
 608     {
 609       "name" : "getEl",
 610       "desc" : "Returns the underlying {@link Roo.Element}.",
 611       "isStatic" : false,
 612       "isConstructor" : false,
 613       "isPrivate" : false,
 614       "memberOf" : "Roo.Component",
 615       "example" : "",
 616       "deprecated" : "",
 617       "since" : "",
 618       "see" : "",
 619       "params" : [
 620       ],
 621       "returns" : [
 622         {
 623           "name" : "",
 624           "type" : "Roo.Element",
 625           "desc" : "The element"
 626         }
 627       ]
 628     },
 629     {
 630       "name" : "purgeListeners",
 631       "desc" : "Removes all listeners for this object",
 632       "isStatic" : false,
 633       "isConstructor" : false,
 634       "isPrivate" : false,
 635       "memberOf" : "Roo.util.Observable",
 636       "example" : "",
 637       "deprecated" : "",
 638       "since" : "",
 639       "see" : "",
 640       "params" : [
 641       ],
 642       "returns" : [
 643       ]
 644     },
 645     {
 646       "name" : "on",
 647       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 648       "isStatic" : false,
 649       "isConstructor" : false,
 650       "isPrivate" : false,
 651       "memberOf" : "Roo.util.Observable",
 652       "example" : "",
 653       "deprecated" : "",
 654       "since" : "",
 655       "see" : "",
 656       "params" : [
 657         {
 658           "name" : "eventName",
 659           "type" : "String",
 660           "desc" : "The type of event to listen for",
 661           "isOptional" : false
 662         },
 663         {
 664           "name" : "handler",
 665           "type" : "Function",
 666           "desc" : "The method the event invokes",
 667           "isOptional" : false
 668         },
 669         {
 670           "name" : "scope",
 671           "type" : "Object",
 672           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 673           "isOptional" : false
 674         },
 675         {
 676           "name" : "options",
 677           "type" : "Object",
 678           "desc" : "(optional)",
 679           "isOptional" : false
 680         }
 681       ],
 682       "returns" : [
 683       ]
 684     },
 685     {
 686       "name" : "un",
 687       "desc" : "Removes a listener (shorthand for removeListener)",
 688       "isStatic" : false,
 689       "isConstructor" : false,
 690       "isPrivate" : false,
 691       "memberOf" : "Roo.util.Observable",
 692       "example" : "",
 693       "deprecated" : "",
 694       "since" : "",
 695       "see" : "",
 696       "params" : [
 697         {
 698           "name" : "eventName",
 699           "type" : "String",
 700           "desc" : "The type of event to listen for",
 701           "isOptional" : false
 702         },
 703         {
 704           "name" : "handler",
 705           "type" : "Function",
 706           "desc" : "The handler to remove",
 707           "isOptional" : false
 708         },
 709         {
 710           "name" : "scope",
 711           "type" : "Object",
 712           "desc" : "(optional) The scope (this object) for the handler",
 713           "isOptional" : false
 714         }
 715       ],
 716       "returns" : [
 717       ]
 718     },
 719     {
 720       "name" : "addEvents",
 721       "desc" : "Used to define events on this Observable",
 722       "isStatic" : false,
 723       "isConstructor" : false,
 724       "isPrivate" : false,
 725       "memberOf" : "Roo.util.Observable",
 726       "example" : "",
 727       "deprecated" : "",
 728       "since" : "",
 729       "see" : "",
 730       "params" : [
 731         {
 732           "name" : "object",
 733           "type" : "Object",
 734           "desc" : "The object with the events defined",
 735           "isOptional" : false
 736         }
 737       ],
 738       "returns" : [
 739       ]
 740     },
 741     {
 742       "name" : "releaseCapture",
 743       "desc" : "Removes <b>all</b> added captures from the Observable.",
 744       "isStatic" : true,
 745       "isConstructor" : false,
 746       "isPrivate" : false,
 747       "memberOf" : "Roo.util.Observable",
 748       "example" : "",
 749       "deprecated" : "",
 750       "since" : "",
 751       "see" : "",
 752       "params" : [
 753         {
 754           "name" : "o",
 755           "type" : "Observable",
 756           "desc" : "The Observable to release",
 757           "isOptional" : false
 758         }
 759       ],
 760       "returns" : [
 761       ]
 762     },
 763     {
 764       "name" : "removeListener",
 765       "desc" : "Removes a listener",
 766       "isStatic" : false,
 767       "isConstructor" : false,
 768       "isPrivate" : false,
 769       "memberOf" : "Roo.util.Observable",
 770       "example" : "",
 771       "deprecated" : "",
 772       "since" : "",
 773       "see" : "",
 774       "params" : [
 775         {
 776           "name" : "eventName",
 777           "type" : "String",
 778           "desc" : "The type of event to listen for",
 779           "isOptional" : false
 780         },
 781         {
 782           "name" : "handler",
 783           "type" : "Function",
 784           "desc" : "The handler to remove",
 785           "isOptional" : false
 786         },
 787         {
 788           "name" : "scope",
 789           "type" : "Object",
 790           "desc" : "(optional) The scope (this object) for the handler",
 791           "isOptional" : false
 792         }
 793       ],
 794       "returns" : [
 795       ]
 796     },
 797     {
 798       "name" : "fireEvent",
 799       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 800       "isStatic" : false,
 801       "isConstructor" : false,
 802       "isPrivate" : false,
 803       "memberOf" : "Roo.util.Observable",
 804       "example" : "",
 805       "deprecated" : "",
 806       "since" : "",
 807       "see" : "",
 808       "params" : [
 809         {
 810           "name" : "eventName",
 811           "type" : "String",
 812           "desc" : "",
 813           "isOptional" : false
 814         },
 815         {
 816           "name" : "args",
 817           "type" : "Object...",
 818           "desc" : "Variable number of parameters are passed to handlers",
 819           "isOptional" : false
 820         }
 821       ],
 822       "returns" : [
 823         {
 824           "name" : "",
 825           "type" : "Boolean",
 826           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 827         }
 828       ]
 829     },
 830     {
 831       "name" : "hasListener",
 832       "desc" : "Checks to see if this object has any listeners for a specified event",
 833       "isStatic" : false,
 834       "isConstructor" : false,
 835       "isPrivate" : false,
 836       "memberOf" : "Roo.util.Observable",
 837       "example" : "",
 838       "deprecated" : "",
 839       "since" : "",
 840       "see" : "",
 841       "params" : [
 842         {
 843           "name" : "eventName",
 844           "type" : "String",
 845           "desc" : "The name of the event to check for",
 846           "isOptional" : false
 847         }
 848       ],
 849       "returns" : [
 850         {
 851           "name" : "",
 852           "type" : "Boolean",
 853           "desc" : "True if the event is being listened for, else false"
 854         }
 855       ]
 856     },
 857     {
 858       "name" : "capture",
 859       "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.",
 860       "isStatic" : true,
 861       "isConstructor" : false,
 862       "isPrivate" : false,
 863       "memberOf" : "Roo.util.Observable",
 864       "example" : "",
 865       "deprecated" : "",
 866       "since" : "",
 867       "see" : "",
 868       "params" : [
 869         {
 870           "name" : "o",
 871           "type" : "Observable",
 872           "desc" : "The Observable to capture",
 873           "isOptional" : false
 874         },
 875         {
 876           "name" : "fn",
 877           "type" : "Function",
 878           "desc" : "The function to call",
 879           "isOptional" : false
 880         },
 881         {
 882           "name" : "scope",
 883           "type" : "Object",
 884           "desc" : "(optional) The scope (this object) for the fn",
 885           "isOptional" : false
 886         }
 887       ],
 888       "returns" : [
 889       ]
 890     },
 891     {
 892       "name" : "addListener",
 893       "desc" : "Appends an event handler to this component",
 894       "isStatic" : false,
 895       "isConstructor" : false,
 896       "isPrivate" : false,
 897       "memberOf" : "Roo.util.Observable",
 898       "example" : "",
 899       "deprecated" : "",
 900       "since" : "",
 901       "see" : "",
 902       "params" : [
 903         {
 904           "name" : "eventName",
 905           "type" : "String",
 906           "desc" : "The type of event to listen for",
 907           "isOptional" : false
 908         },
 909         {
 910           "name" : "handler",
 911           "type" : "Function",
 912           "desc" : "The method the event invokes",
 913           "isOptional" : false
 914         },
 915         {
 916           "name" : "scope",
 917           "type" : "Object",
 918           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 919           "isOptional" : false
 920         },
 921         {
 922           "name" : "options",
 923           "type" : "Object",
 924           "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>",
 925           "isOptional" : false
 926         }
 927       ],
 928       "returns" : [
 929       ]
 930     }
 931   ],
 932   "events" : [
 933     {
 934       "name" : "beforetoggle",
 935       "desc" : "Fire before toggle the menu",
 936       "memberOf" : "Roo.bootstrap.Navbar",
 937       "example" : "",
 938       "deprecated" : "",
 939       "since" : "",
 940       "see" : "",
 941       "params" : [
 942         {
 943           "name" : "e",
 944           "type" : "Roo.EventObject",
 945           "desc" : "",
 946           "isOptional" : false
 947         }
 948       ],
 949       "returns" : [
 950       ]
 951     },
 952     {
 953       "name" : "childrenrendered",
 954       "desc" : "Fires when the children have been rendered..",
 955       "memberOf" : "Roo.bootstrap.Component",
 956       "example" : "",
 957       "deprecated" : "",
 958       "since" : "",
 959       "see" : "",
 960       "params" : [
 961         {
 962           "name" : "this",
 963           "type" : "Roo.bootstrap.Component",
 964           "desc" : "",
 965           "isOptional" : false
 966         }
 967       ],
 968       "returns" : [
 969       ]
 970     },
 971     {
 972       "name" : "beforerender",
 973       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 974       "memberOf" : "Roo.Component",
 975       "example" : "",
 976       "deprecated" : "",
 977       "since" : "",
 978       "see" : "",
 979       "params" : [
 980         {
 981           "name" : "this",
 982           "type" : "Roo.Component",
 983           "desc" : "",
 984           "isOptional" : false
 985         }
 986       ],
 987       "returns" : [
 988       ]
 989     },
 990     {
 991       "name" : "disable",
 992       "desc" : "Fires after the component is disabled.",
 993       "memberOf" : "Roo.Component",
 994       "example" : "",
 995       "deprecated" : "",
 996       "since" : "",
 997       "see" : "",
 998       "params" : [
 999         {
1000           "name" : "this",
1001           "type" : "Roo.Component",
1002           "desc" : "",
1003           "isOptional" : false
1004         }
1005       ],
1006       "returns" : [
1007       ]
1008     },
1009     {
1010       "name" : "render",
1011       "desc" : "Fires after the component is rendered.",
1012       "memberOf" : "Roo.Component",
1013       "example" : "",
1014       "deprecated" : "",
1015       "since" : "",
1016       "see" : "",
1017       "params" : [
1018         {
1019           "name" : "this",
1020           "type" : "Roo.Component",
1021           "desc" : "",
1022           "isOptional" : false
1023         }
1024       ],
1025       "returns" : [
1026       ]
1027     },
1028     {
1029       "name" : "destroy",
1030       "desc" : "Fires after the component is destroyed.",
1031       "memberOf" : "Roo.Component",
1032       "example" : "",
1033       "deprecated" : "",
1034       "since" : "",
1035       "see" : "",
1036       "params" : [
1037         {
1038           "name" : "this",
1039           "type" : "Roo.Component",
1040           "desc" : "",
1041           "isOptional" : false
1042         }
1043       ],
1044       "returns" : [
1045       ]
1046     },
1047     {
1048       "name" : "hide",
1049       "desc" : "Fires after the component is hidden.",
1050       "memberOf" : "Roo.Component",
1051       "example" : "",
1052       "deprecated" : "",
1053       "since" : "",
1054       "see" : "",
1055       "params" : [
1056         {
1057           "name" : "this",
1058           "type" : "Roo.Component",
1059           "desc" : "",
1060           "isOptional" : false
1061         }
1062       ],
1063       "returns" : [
1064       ]
1065     },
1066     {
1067       "name" : "beforehide",
1068       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1069       "memberOf" : "Roo.Component",
1070       "example" : "",
1071       "deprecated" : "",
1072       "since" : "",
1073       "see" : "",
1074       "params" : [
1075         {
1076           "name" : "this",
1077           "type" : "Roo.Component",
1078           "desc" : "",
1079           "isOptional" : false
1080         }
1081       ],
1082       "returns" : [
1083       ]
1084     },
1085     {
1086       "name" : "show",
1087       "desc" : "Fires after the component is shown.",
1088       "memberOf" : "Roo.Component",
1089       "example" : "",
1090       "deprecated" : "",
1091       "since" : "",
1092       "see" : "",
1093       "params" : [
1094         {
1095           "name" : "this",
1096           "type" : "Roo.Component",
1097           "desc" : "",
1098           "isOptional" : false
1099         }
1100       ],
1101       "returns" : [
1102       ]
1103     },
1104     {
1105       "name" : "beforeshow",
1106       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1107       "memberOf" : "Roo.Component",
1108       "example" : "",
1109       "deprecated" : "",
1110       "since" : "",
1111       "see" : "",
1112       "params" : [
1113         {
1114           "name" : "this",
1115           "type" : "Roo.Component",
1116           "desc" : "",
1117           "isOptional" : false
1118         }
1119       ],
1120       "returns" : [
1121       ]
1122     },
1123     {
1124       "name" : "enable",
1125       "desc" : "Fires after the component is enabled.",
1126       "memberOf" : "Roo.Component",
1127       "example" : "",
1128       "deprecated" : "",
1129       "since" : "",
1130       "see" : "",
1131       "params" : [
1132         {
1133           "name" : "this",
1134           "type" : "Roo.Component",
1135           "desc" : "",
1136           "isOptional" : false
1137         }
1138       ],
1139       "returns" : [
1140       ]
1141     },
1142     {
1143       "name" : "beforedestroy",
1144       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1145       "memberOf" : "Roo.Component",
1146       "example" : "",
1147       "deprecated" : "",
1148       "since" : "",
1149       "see" : "",
1150       "params" : [
1151         {
1152           "name" : "this",
1153           "type" : "Roo.Component",
1154           "desc" : "",
1155           "isOptional" : false
1156         }
1157       ],
1158       "returns" : [
1159       ]
1160     }
1161   ]
1162 }