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