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

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