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

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