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

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