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

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