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

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