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