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

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