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