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

   1 {
   2   "name" : "Roo.bootstrap.nav.Group",
   3   "augments" : [
   4     "Roo.bootstrap.Component",
   5     "Roo.Component",
   6     "Roo.util.Observable"
   7   ],
   8   "childClasses" : [],
   9   "desc" : "Bootstrap NavGroup class",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "memberOf" : "Group",
  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" : "align",
  56       "type" : "String",
  57       "desc" : "t)",
  58       "memberOf" : ""
  59     },
  60     {
  61       "name" : "inverse",
  62       "type" : "Boolean",
  63       "desc" : "",
  64       "memberOf" : ""
  65     },
  66     {
  67       "name" : "pilltype",
  68       "type" : "Boolean",
  69       "desc" : "default true (turn to off to disable active toggle)",
  70       "memberOf" : ""
  71     },
  72     {
  73       "name" : "navId",
  74       "type" : "String",
  75       "desc" : "- reference Id for navbar.",
  76       "memberOf" : ""
  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" : ""
 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" : "get",
 148       "type" : "function",
 149       "desc" : "fetch a Navigation Group based on the navigation ID",
 150       "sig" : "(the)",
 151       "static" : true,
 152       "memberOf" : "",
 153       "isStatic" : true,
 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" : "string",
 166           "desc" : "navgroup to add",
 167           "isOptional" : false
 168         }
 169       ],
 170       "returns" : []
 171     },
 172     {
 173       "name" : "addItem",
 174       "type" : "function",
 175       "desc" : "adds a Navigation item",
 176       "sig" : "(the)",
 177       "static" : false,
 178       "memberOf" : "",
 179       "isStatic" : false,
 180       "isConstructor" : false,
 181       "isPrivate" : false,
 182       "example" : "",
 183       "deprecated" : "",
 184       "since" : "",
 185       "see" : "",
 186       "exceptions" : "",
 187       "requires" : "",
 188       "params" : [
 189         {
 190           "name" : "the",
 191           "type" : "Roo.bootstrap.nav.Item",
 192           "desc" : "navitem to add",
 193           "isOptional" : false
 194         }
 195       ],
 196       "returns" : []
 197     },
 198     {
 199       "name" : "register",
 200       "type" : "function",
 201       "desc" : "register a Navigation item",
 202       "sig" : "(the)",
 203       "static" : false,
 204       "memberOf" : "",
 205       "isStatic" : false,
 206       "isConstructor" : false,
 207       "isPrivate" : false,
 208       "example" : "",
 209       "deprecated" : "",
 210       "since" : "",
 211       "see" : "",
 212       "exceptions" : "",
 213       "requires" : "",
 214       "params" : [
 215         {
 216           "name" : "the",
 217           "type" : "Roo.bootstrap.nav.Item",
 218           "desc" : "navitem to add",
 219           "isOptional" : false
 220         }
 221       ],
 222       "returns" : []
 223     },
 224     {
 225       "name" : "getActive",
 226       "type" : "function",
 227       "desc" : "gets the active Navigation item",
 228       "sig" : "()\n{\n\n}",
 229       "static" : false,
 230       "memberOf" : "",
 231       "isStatic" : false,
 232       "isConstructor" : false,
 233       "isPrivate" : false,
 234       "example" : "",
 235       "deprecated" : "",
 236       "since" : "",
 237       "see" : "",
 238       "exceptions" : "",
 239       "requires" : "",
 240       "params" : [],
 241       "returns" : [
 242         {
 243           "name" : "",
 244           "type" : "Roo.bootstrap.nav.Item",
 245           "desc" : "the current navitem"
 246         }
 247       ]
 248     },
 249     {
 250       "name" : "setActiveItem",
 251       "type" : "function",
 252       "desc" : "sets the active Navigation item",
 253       "sig" : "(the)",
 254       "static" : false,
 255       "memberOf" : "",
 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.nav.Item",
 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" : "",
 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" : "register",
 296       "type" : "function",
 297       "desc" : "register a Navigation Group",
 298       "sig" : "(the)",
 299       "static" : true,
 300       "memberOf" : "",
 301       "isStatic" : true,
 302       "isConstructor" : false,
 303       "isPrivate" : false,
 304       "example" : "",
 305       "deprecated" : "",
 306       "since" : "",
 307       "see" : "",
 308       "exceptions" : "",
 309       "requires" : "",
 310       "params" : [
 311         {
 312           "name" : "the",
 313           "type" : "Roo.bootstrap.nav.Group",
 314           "desc" : "navgroup to add",
 315           "isOptional" : false
 316         }
 317       ],
 318       "returns" : []
 319     },
 320     {
 321       "name" : "tooltipEl",
 322       "type" : "function",
 323       "desc" : "Fetch the element to display the tooltip on.",
 324       "sig" : "()\n{\n\n}",
 325       "static" : false,
 326       "memberOf" : "Roo.bootstrap.Component",
 327       "isStatic" : false,
 328       "isConstructor" : false,
 329       "isPrivate" : false,
 330       "example" : "",
 331       "deprecated" : "",
 332       "since" : "",
 333       "see" : "",
 334       "exceptions" : "",
 335       "requires" : "",
 336       "params" : [],
 337       "returns" : [
 338         {
 339           "name" : "",
 340           "type" : "Roo.Element",
 341           "desc" : "defaults to this.el"
 342         }
 343       ]
 344     },
 345     {
 346       "name" : "hide",
 347       "type" : "function",
 348       "desc" : "Hide a component - adds 'hidden' class",
 349       "sig" : "()\n{\n\n}",
 350       "static" : false,
 351       "memberOf" : "Roo.bootstrap.Component",
 352       "isStatic" : false,
 353       "isConstructor" : false,
 354       "isPrivate" : false,
 355       "example" : "",
 356       "deprecated" : "",
 357       "since" : "",
 358       "see" : "",
 359       "exceptions" : "",
 360       "requires" : "",
 361       "params" : [],
 362       "returns" : []
 363     },
 364     {
 365       "name" : "show",
 366       "type" : "function",
 367       "desc" : "Show a component - removes 'hidden' class",
 368       "sig" : "()\n{\n\n}",
 369       "static" : false,
 370       "memberOf" : "Roo.bootstrap.Component",
 371       "isStatic" : false,
 372       "isConstructor" : false,
 373       "isPrivate" : false,
 374       "example" : "",
 375       "deprecated" : "",
 376       "since" : "",
 377       "see" : "",
 378       "exceptions" : "",
 379       "requires" : "",
 380       "params" : [],
 381       "returns" : []
 382     },
 383     {
 384       "name" : "setVisibilityEl",
 385       "type" : "function",
 386       "desc" : "Set the element that will be used to show or hide",
 387       "sig" : "()\n{\n\n}",
 388       "static" : false,
 389       "memberOf" : "Roo.bootstrap.Component",
 390       "isStatic" : false,
 391       "isConstructor" : false,
 392       "isPrivate" : false,
 393       "example" : "",
 394       "deprecated" : "",
 395       "since" : "",
 396       "see" : "",
 397       "exceptions" : "",
 398       "requires" : "",
 399       "params" : [],
 400       "returns" : []
 401     },
 402     {
 403       "name" : "getVisibilityEl",
 404       "type" : "function",
 405       "desc" : "Get the element that will be used to show or hide",
 406       "sig" : "()\n{\n\n}",
 407       "static" : false,
 408       "memberOf" : "Roo.bootstrap.Component",
 409       "isStatic" : false,
 410       "isConstructor" : false,
 411       "isPrivate" : false,
 412       "example" : "",
 413       "deprecated" : "",
 414       "since" : "",
 415       "see" : "",
 416       "exceptions" : "",
 417       "requires" : "",
 418       "params" : [],
 419       "returns" : []
 420     },
 421     {
 422       "name" : "initEvents",
 423       "type" : "function",
 424       "desc" : "Initialize Events for the element",
 425       "sig" : "()\n{\n\n}",
 426       "static" : false,
 427       "memberOf" : "Roo.bootstrap.Component",
 428       "isStatic" : false,
 429       "isConstructor" : false,
 430       "isPrivate" : false,
 431       "example" : "",
 432       "deprecated" : "",
 433       "since" : "",
 434       "see" : "",
 435       "exceptions" : "",
 436       "requires" : "",
 437       "params" : [],
 438       "returns" : []
 439     },
 440     {
 441       "name" : "getChildContainer",
 442       "type" : "function",
 443       "desc" : "Fetch the element to add children to",
 444       "sig" : "()\n{\n\n}",
 445       "static" : false,
 446       "memberOf" : "Roo.bootstrap.Component",
 447       "isStatic" : false,
 448       "isConstructor" : false,
 449       "isPrivate" : false,
 450       "example" : "",
 451       "deprecated" : "",
 452       "since" : "",
 453       "see" : "",
 454       "exceptions" : "",
 455       "requires" : "",
 456       "params" : [],
 457       "returns" : [
 458         {
 459           "name" : "",
 460           "type" : "Roo.Element",
 461           "desc" : "defaults to this.el"
 462         }
 463       ]
 464     },
 465     {
 466       "name" : "getId",
 467       "type" : "function",
 468       "desc" : "Returns the id of this component.",
 469       "sig" : "()\n{\n\n}",
 470       "static" : false,
 471       "memberOf" : "Roo.Component",
 472       "isStatic" : false,
 473       "isConstructor" : false,
 474       "isPrivate" : false,
 475       "example" : "",
 476       "deprecated" : "",
 477       "since" : "",
 478       "see" : "",
 479       "exceptions" : "",
 480       "requires" : "",
 481       "params" : [],
 482       "returns" : [
 483         {
 484           "name" : "",
 485           "type" : "String",
 486           "desc" : ""
 487         }
 488       ]
 489     },
 490     {
 491       "name" : "render",
 492       "type" : "function",
 493       "desc" : "If this is a lazy rendering component, render it to its container element.",
 494       "sig" : "(container)",
 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         {
 508           "name" : "container",
 509           "type" : "String/HTMLElement/Element",
 510           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 511           "isOptional" : false
 512         }
 513       ],
 514       "returns" : []
 515     },
 516     {
 517       "name" : "destroy",
 518       "type" : "function",
 519       "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}.",
 520       "sig" : "()\n{\n\n}",
 521       "static" : false,
 522       "memberOf" : "Roo.Component",
 523       "isStatic" : false,
 524       "isConstructor" : false,
 525       "isPrivate" : false,
 526       "example" : "",
 527       "deprecated" : "",
 528       "since" : "",
 529       "see" : "",
 530       "exceptions" : "",
 531       "requires" : "",
 532       "params" : [],
 533       "returns" : []
 534     },
 535     {
 536       "name" : "isVisible",
 537       "type" : "function",
 538       "desc" : "Returns true if this component is visible.",
 539       "sig" : "()\n{\n\n}",
 540       "static" : false,
 541       "memberOf" : "Roo.Component",
 542       "isStatic" : false,
 543       "isConstructor" : false,
 544       "isPrivate" : false,
 545       "example" : "",
 546       "deprecated" : "",
 547       "since" : "",
 548       "see" : "",
 549       "exceptions" : "",
 550       "requires" : "",
 551       "params" : [],
 552       "returns" : []
 553     },
 554     {
 555       "name" : "setDisabled",
 556       "type" : "function",
 557       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 558       "sig" : "(disabled)",
 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" : "disabled",
 573           "type" : "Boolean",
 574           "desc" : "",
 575           "isOptional" : false
 576         }
 577       ],
 578       "returns" : []
 579     },
 580     {
 581       "name" : "focus",
 582       "type" : "function",
 583       "desc" : "Try to focus this component.",
 584       "sig" : "(selectText)",
 585       "static" : false,
 586       "memberOf" : "Roo.Component",
 587       "isStatic" : false,
 588       "isConstructor" : false,
 589       "isPrivate" : false,
 590       "example" : "",
 591       "deprecated" : "",
 592       "since" : "",
 593       "see" : "",
 594       "exceptions" : "",
 595       "requires" : "",
 596       "params" : [
 597         {
 598           "name" : "selectText",
 599           "type" : "Boolean",
 600           "desc" : "True to also select the text in this component (if applicable)",
 601           "isOptional" : false
 602         }
 603       ],
 604       "returns" : [
 605         {
 606           "name" : "",
 607           "type" : "Roo.Component",
 608           "desc" : "this"
 609         }
 610       ]
 611     },
 612     {
 613       "name" : "enable",
 614       "type" : "function",
 615       "desc" : "Enable this component.",
 616       "sig" : "()\n{\n\n}",
 617       "static" : false,
 618       "memberOf" : "Roo.Component",
 619       "isStatic" : false,
 620       "isConstructor" : false,
 621       "isPrivate" : false,
 622       "example" : "",
 623       "deprecated" : "",
 624       "since" : "",
 625       "see" : "",
 626       "exceptions" : "",
 627       "requires" : "",
 628       "params" : [],
 629       "returns" : [
 630         {
 631           "name" : "",
 632           "type" : "Roo.Component",
 633           "desc" : "this"
 634         }
 635       ]
 636     },
 637     {
 638       "name" : "setVisible",
 639       "type" : "function",
 640       "desc" : "Convenience function to hide or show this component by boolean.",
 641       "sig" : "(visible)",
 642       "static" : false,
 643       "memberOf" : "Roo.Component",
 644       "isStatic" : false,
 645       "isConstructor" : false,
 646       "isPrivate" : false,
 647       "example" : "",
 648       "deprecated" : "",
 649       "since" : "",
 650       "see" : "",
 651       "exceptions" : "",
 652       "requires" : "",
 653       "params" : [
 654         {
 655           "name" : "visible",
 656           "type" : "Boolean",
 657           "desc" : "True to show, false to hide",
 658           "isOptional" : false
 659         }
 660       ],
 661       "returns" : [
 662         {
 663           "name" : "",
 664           "type" : "Roo.Component",
 665           "desc" : "this"
 666         }
 667       ]
 668     },
 669     {
 670       "name" : "disable",
 671       "type" : "function",
 672       "desc" : "Disable this component.",
 673       "sig" : "()\n{\n\n}",
 674       "static" : false,
 675       "memberOf" : "Roo.Component",
 676       "isStatic" : false,
 677       "isConstructor" : false,
 678       "isPrivate" : false,
 679       "example" : "",
 680       "deprecated" : "",
 681       "since" : "",
 682       "see" : "",
 683       "exceptions" : "",
 684       "requires" : "",
 685       "params" : [],
 686       "returns" : [
 687         {
 688           "name" : "",
 689           "type" : "Roo.Component",
 690           "desc" : "this"
 691         }
 692       ]
 693     },
 694     {
 695       "name" : "getEl",
 696       "type" : "function",
 697       "desc" : "Returns the underlying {@link Roo.Element}.",
 698       "sig" : "()\n{\n\n}",
 699       "static" : false,
 700       "memberOf" : "Roo.Component",
 701       "isStatic" : false,
 702       "isConstructor" : false,
 703       "isPrivate" : false,
 704       "example" : "",
 705       "deprecated" : "",
 706       "since" : "",
 707       "see" : "",
 708       "exceptions" : "",
 709       "requires" : "",
 710       "params" : [],
 711       "returns" : [
 712         {
 713           "name" : "",
 714           "type" : "Roo.Element",
 715           "desc" : "The element"
 716         }
 717       ]
 718     },
 719     {
 720       "name" : "purgeListeners",
 721       "type" : "function",
 722       "desc" : "Removes all listeners for this object",
 723       "sig" : "()\n{\n\n}",
 724       "static" : false,
 725       "memberOf" : "Roo.util.Observable",
 726       "isStatic" : false,
 727       "isConstructor" : false,
 728       "isPrivate" : false,
 729       "example" : "",
 730       "deprecated" : "",
 731       "since" : "",
 732       "see" : "",
 733       "exceptions" : "",
 734       "requires" : "",
 735       "params" : [],
 736       "returns" : []
 737     },
 738     {
 739       "name" : "on",
 740       "type" : "function",
 741       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 742       "sig" : "(eventName, handler, scope, options)",
 743       "static" : false,
 744       "memberOf" : "Roo.util.Observable",
 745       "isStatic" : false,
 746       "isConstructor" : false,
 747       "isPrivate" : false,
 748       "example" : "",
 749       "deprecated" : "",
 750       "since" : "",
 751       "see" : "",
 752       "exceptions" : "",
 753       "requires" : "",
 754       "params" : [
 755         {
 756           "name" : "eventName",
 757           "type" : "String",
 758           "desc" : "The type of event to listen for",
 759           "isOptional" : false
 760         },
 761         {
 762           "name" : "handler",
 763           "type" : "Function",
 764           "desc" : "The method the event invokes",
 765           "isOptional" : false
 766         },
 767         {
 768           "name" : "scope",
 769           "type" : "Object",
 770           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 771           "isOptional" : false
 772         },
 773         {
 774           "name" : "options",
 775           "type" : "Object",
 776           "desc" : "(optional)",
 777           "isOptional" : false
 778         }
 779       ],
 780       "returns" : []
 781     },
 782     {
 783       "name" : "un",
 784       "type" : "function",
 785       "desc" : "Removes a listener (shorthand for removeListener)",
 786       "sig" : "(eventName, handler, scope)",
 787       "static" : false,
 788       "memberOf" : "Roo.util.Observable",
 789       "isStatic" : false,
 790       "isConstructor" : false,
 791       "isPrivate" : false,
 792       "example" : "",
 793       "deprecated" : "",
 794       "since" : "",
 795       "see" : "",
 796       "exceptions" : "",
 797       "requires" : "",
 798       "params" : [
 799         {
 800           "name" : "eventName",
 801           "type" : "String",
 802           "desc" : "The type of event to listen for",
 803           "isOptional" : false
 804         },
 805         {
 806           "name" : "handler",
 807           "type" : "Function",
 808           "desc" : "The handler to remove",
 809           "isOptional" : false
 810         },
 811         {
 812           "name" : "scope",
 813           "type" : "Object",
 814           "desc" : "(optional) The scope (this object) for the handler",
 815           "isOptional" : false
 816         }
 817       ],
 818       "returns" : []
 819     },
 820     {
 821       "name" : "addEvents",
 822       "type" : "function",
 823       "desc" : "Used to define events on this Observable",
 824       "sig" : "(object)",
 825       "static" : false,
 826       "memberOf" : "Roo.util.Observable",
 827       "isStatic" : false,
 828       "isConstructor" : false,
 829       "isPrivate" : false,
 830       "example" : "",
 831       "deprecated" : "",
 832       "since" : "",
 833       "see" : "",
 834       "exceptions" : "",
 835       "requires" : "",
 836       "params" : [
 837         {
 838           "name" : "object",
 839           "type" : "Object",
 840           "desc" : "The object with the events defined",
 841           "isOptional" : false
 842         }
 843       ],
 844       "returns" : []
 845     },
 846     {
 847       "name" : "releaseCapture",
 848       "type" : "function",
 849       "desc" : "Removes <b>all</b> added captures from the Observable.",
 850       "sig" : "(o)",
 851       "static" : true,
 852       "memberOf" : "Roo.util.Observable",
 853       "isStatic" : true,
 854       "isConstructor" : false,
 855       "isPrivate" : false,
 856       "example" : "",
 857       "deprecated" : "",
 858       "since" : "",
 859       "see" : "",
 860       "exceptions" : "",
 861       "requires" : "",
 862       "params" : [
 863         {
 864           "name" : "o",
 865           "type" : "Observable",
 866           "desc" : "The Observable to release",
 867           "isOptional" : false
 868         }
 869       ],
 870       "returns" : []
 871     },
 872     {
 873       "name" : "removeListener",
 874       "type" : "function",
 875       "desc" : "Removes a listener",
 876       "sig" : "(eventName, handler, scope)",
 877       "static" : false,
 878       "memberOf" : "Roo.util.Observable",
 879       "isStatic" : false,
 880       "isConstructor" : false,
 881       "isPrivate" : false,
 882       "example" : "",
 883       "deprecated" : "",
 884       "since" : "",
 885       "see" : "",
 886       "exceptions" : "",
 887       "requires" : "",
 888       "params" : [
 889         {
 890           "name" : "eventName",
 891           "type" : "String",
 892           "desc" : "The type of event to listen for",
 893           "isOptional" : false
 894         },
 895         {
 896           "name" : "handler",
 897           "type" : "Function",
 898           "desc" : "The handler to remove",
 899           "isOptional" : false
 900         },
 901         {
 902           "name" : "scope",
 903           "type" : "Object",
 904           "desc" : "(optional) The scope (this object) for the handler",
 905           "isOptional" : false
 906         }
 907       ],
 908       "returns" : []
 909     },
 910     {
 911       "name" : "fireEvent",
 912       "type" : "function",
 913       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 914       "sig" : "(eventName, args)",
 915       "static" : false,
 916       "memberOf" : "Roo.util.Observable",
 917       "isStatic" : false,
 918       "isConstructor" : false,
 919       "isPrivate" : false,
 920       "example" : "",
 921       "deprecated" : "",
 922       "since" : "",
 923       "see" : "",
 924       "exceptions" : "",
 925       "requires" : "",
 926       "params" : [
 927         {
 928           "name" : "eventName",
 929           "type" : "String",
 930           "desc" : "",
 931           "isOptional" : false
 932         },
 933         {
 934           "name" : "args",
 935           "type" : "Object...",
 936           "desc" : "Variable number of parameters are passed to handlers",
 937           "isOptional" : false
 938         }
 939       ],
 940       "returns" : [
 941         {
 942           "name" : "",
 943           "type" : "Boolean",
 944           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 945         }
 946       ]
 947     },
 948     {
 949       "name" : "hasListener",
 950       "type" : "function",
 951       "desc" : "Checks to see if this object has any listeners for a specified event",
 952       "sig" : "(eventName)",
 953       "static" : false,
 954       "memberOf" : "Roo.util.Observable",
 955       "isStatic" : false,
 956       "isConstructor" : false,
 957       "isPrivate" : false,
 958       "example" : "",
 959       "deprecated" : "",
 960       "since" : "",
 961       "see" : "",
 962       "exceptions" : "",
 963       "requires" : "",
 964       "params" : [
 965         {
 966           "name" : "eventName",
 967           "type" : "String",
 968           "desc" : "The name of the event to check for",
 969           "isOptional" : false
 970         }
 971       ],
 972       "returns" : [
 973         {
 974           "name" : "",
 975           "type" : "Boolean",
 976           "desc" : "True if the event is being listened for, else false"
 977         }
 978       ]
 979     },
 980     {
 981       "name" : "capture",
 982       "type" : "function",
 983       "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.",
 984       "sig" : "(o, fn, scope)",
 985       "static" : true,
 986       "memberOf" : "Roo.util.Observable",
 987       "isStatic" : true,
 988       "isConstructor" : false,
 989       "isPrivate" : false,
 990       "example" : "",
 991       "deprecated" : "",
 992       "since" : "",
 993       "see" : "",
 994       "exceptions" : "",
 995       "requires" : "",
 996       "params" : [
 997         {
 998           "name" : "o",
 999           "type" : "Observable",
1000           "desc" : "The Observable to capture",
1001           "isOptional" : false
1002         },
1003         {
1004           "name" : "fn",
1005           "type" : "Function",
1006           "desc" : "The function to call",
1007           "isOptional" : false
1008         },
1009         {
1010           "name" : "scope",
1011           "type" : "Object",
1012           "desc" : "(optional) The scope (this object) for the fn",
1013           "isOptional" : false
1014         }
1015       ],
1016       "returns" : []
1017     },
1018     {
1019       "name" : "addListener",
1020       "type" : "function",
1021       "desc" : "Appends an event handler to this component",
1022       "sig" : "(eventName, handler, scope, options)",
1023       "static" : false,
1024       "memberOf" : "Roo.util.Observable",
1025       "isStatic" : false,
1026       "isConstructor" : false,
1027       "isPrivate" : false,
1028       "example" : "",
1029       "deprecated" : "",
1030       "since" : "",
1031       "see" : "",
1032       "exceptions" : "",
1033       "requires" : "",
1034       "params" : [
1035         {
1036           "name" : "eventName",
1037           "type" : "String",
1038           "desc" : "The type of event to listen for",
1039           "isOptional" : false
1040         },
1041         {
1042           "name" : "handler",
1043           "type" : "Function",
1044           "desc" : "The method the event invokes",
1045           "isOptional" : false
1046         },
1047         {
1048           "name" : "scope",
1049           "type" : "Object",
1050           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1051           "isOptional" : false
1052         },
1053         {
1054           "name" : "options",
1055           "type" : "Object",
1056           "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>",
1057           "isOptional" : false
1058         }
1059       ],
1060       "returns" : []
1061     }
1062   ],
1063   "events" : [
1064     {
1065       "name" : "changed",
1066       "type" : "function",
1067       "desc" : "Fires when the active item changes",
1068       "sig" : "function (_self, selected, prev)\n{\n\n}",
1069       "memberOf" : "",
1070       "example" : "",
1071       "deprecated" : "",
1072       "since" : "",
1073       "see" : "",
1074       "params" : [
1075         {
1076           "name" : "this",
1077           "type" : "Roo.bootstrap.nav.Group",
1078           "desc" : "",
1079           "isOptional" : false
1080         },
1081         {
1082           "name" : "selected",
1083           "type" : "Roo.bootstrap.Navbar.Item",
1084           "desc" : "The item selected",
1085           "isOptional" : false
1086         },
1087         {
1088           "name" : "prev",
1089           "type" : "Roo.bootstrap.Navbar.Item",
1090           "desc" : "The previously selected item",
1091           "isOptional" : false
1092         }
1093       ],
1094       "returns" : []
1095     },
1096     {
1097       "name" : "childrenrendered",
1098       "type" : "function",
1099       "desc" : "Fires when the children have been rendered..",
1100       "sig" : "function (_self)\n{\n\n}",
1101       "memberOf" : "Roo.bootstrap.Component",
1102       "example" : "",
1103       "deprecated" : "",
1104       "since" : "",
1105       "see" : "",
1106       "params" : [
1107         {
1108           "name" : "this",
1109           "type" : "Roo.bootstrap.Component",
1110           "desc" : "",
1111           "isOptional" : false
1112         }
1113       ],
1114       "returns" : []
1115     },
1116     {
1117       "name" : "beforerender",
1118       "type" : "function",
1119       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1120       "sig" : "function (_self)\n{\n\n}",
1121       "memberOf" : "Roo.Component",
1122       "example" : "",
1123       "deprecated" : "",
1124       "since" : "",
1125       "see" : "",
1126       "params" : [
1127         {
1128           "name" : "this",
1129           "type" : "Roo.Component",
1130           "desc" : "",
1131           "isOptional" : false
1132         }
1133       ],
1134       "returns" : []
1135     },
1136     {
1137       "name" : "disable",
1138       "type" : "function",
1139       "desc" : "Fires after the component is disabled.",
1140       "sig" : "function (_self)\n{\n\n}",
1141       "memberOf" : "Roo.Component",
1142       "example" : "",
1143       "deprecated" : "",
1144       "since" : "",
1145       "see" : "",
1146       "params" : [
1147         {
1148           "name" : "this",
1149           "type" : "Roo.Component",
1150           "desc" : "",
1151           "isOptional" : false
1152         }
1153       ],
1154       "returns" : []
1155     },
1156     {
1157       "name" : "render",
1158       "type" : "function",
1159       "desc" : "Fires after the component is rendered.",
1160       "sig" : "function (_self)\n{\n\n}",
1161       "memberOf" : "Roo.Component",
1162       "example" : "",
1163       "deprecated" : "",
1164       "since" : "",
1165       "see" : "",
1166       "params" : [
1167         {
1168           "name" : "this",
1169           "type" : "Roo.Component",
1170           "desc" : "",
1171           "isOptional" : false
1172         }
1173       ],
1174       "returns" : []
1175     },
1176     {
1177       "name" : "destroy",
1178       "type" : "function",
1179       "desc" : "Fires after the component is destroyed.",
1180       "sig" : "function (_self)\n{\n\n}",
1181       "memberOf" : "Roo.Component",
1182       "example" : "",
1183       "deprecated" : "",
1184       "since" : "",
1185       "see" : "",
1186       "params" : [
1187         {
1188           "name" : "this",
1189           "type" : "Roo.Component",
1190           "desc" : "",
1191           "isOptional" : false
1192         }
1193       ],
1194       "returns" : []
1195     },
1196     {
1197       "name" : "hide",
1198       "type" : "function",
1199       "desc" : "Fires after the component is hidden.",
1200       "sig" : "function (_self)\n{\n\n}",
1201       "memberOf" : "Roo.Component",
1202       "example" : "",
1203       "deprecated" : "",
1204       "since" : "",
1205       "see" : "",
1206       "params" : [
1207         {
1208           "name" : "this",
1209           "type" : "Roo.Component",
1210           "desc" : "",
1211           "isOptional" : false
1212         }
1213       ],
1214       "returns" : []
1215     },
1216     {
1217       "name" : "beforehide",
1218       "type" : "function",
1219       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1220       "sig" : "function (_self)\n{\n\n}",
1221       "memberOf" : "Roo.Component",
1222       "example" : "",
1223       "deprecated" : "",
1224       "since" : "",
1225       "see" : "",
1226       "params" : [
1227         {
1228           "name" : "this",
1229           "type" : "Roo.Component",
1230           "desc" : "",
1231           "isOptional" : false
1232         }
1233       ],
1234       "returns" : []
1235     },
1236     {
1237       "name" : "show",
1238       "type" : "function",
1239       "desc" : "Fires after the component is shown.",
1240       "sig" : "function (_self)\n{\n\n}",
1241       "memberOf" : "Roo.Component",
1242       "example" : "",
1243       "deprecated" : "",
1244       "since" : "",
1245       "see" : "",
1246       "params" : [
1247         {
1248           "name" : "this",
1249           "type" : "Roo.Component",
1250           "desc" : "",
1251           "isOptional" : false
1252         }
1253       ],
1254       "returns" : []
1255     },
1256     {
1257       "name" : "beforeshow",
1258       "type" : "function",
1259       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1260       "sig" : "function (_self)\n{\n\n}",
1261       "memberOf" : "Roo.Component",
1262       "example" : "",
1263       "deprecated" : "",
1264       "since" : "",
1265       "see" : "",
1266       "params" : [
1267         {
1268           "name" : "this",
1269           "type" : "Roo.Component",
1270           "desc" : "",
1271           "isOptional" : false
1272         }
1273       ],
1274       "returns" : []
1275     },
1276     {
1277       "name" : "enable",
1278       "type" : "function",
1279       "desc" : "Fires after the component is enabled.",
1280       "sig" : "function (_self)\n{\n\n}",
1281       "memberOf" : "Roo.Component",
1282       "example" : "",
1283       "deprecated" : "",
1284       "since" : "",
1285       "see" : "",
1286       "params" : [
1287         {
1288           "name" : "this",
1289           "type" : "Roo.Component",
1290           "desc" : "",
1291           "isOptional" : false
1292         }
1293       ],
1294       "returns" : []
1295     },
1296     {
1297       "name" : "beforedestroy",
1298       "type" : "function",
1299       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1300       "sig" : "function (_self)\n{\n\n}",
1301       "memberOf" : "Roo.Component",
1302       "example" : "",
1303       "deprecated" : "",
1304       "since" : "",
1305       "see" : "",
1306       "params" : [
1307         {
1308           "name" : "this",
1309           "type" : "Roo.Component",
1310           "desc" : "",
1311           "isOptional" : false
1312         }
1313       ],
1314       "returns" : []
1315     }
1316   ]
1317 }