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

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