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