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

   1 {
   2   "name" : "Roo.bootstrap.NavSimplebar",
   3   "augments" : [
   4     "Roo.bootstrap.Navbar",
   5     "Roo.bootstrap.Component",
   6     "Roo.Component",
   7     "Roo.util.Observable"
   8   ],
   9   "desc" : "Bootstrap Sidebar class",
  10   "isSingleton" : false,
  11   "isStatic" : false,
  12   "isBuiltin" : false,
  13   "memberOf" : "NavSimplebar",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [
  19     {
  20       "name" : "config",
  21       "type" : "Object",
  22       "desc" : "The config object",
  23       "isOptional" : false
  24     }
  25   ],
  26   "returns" : [],
  27   "config" : [
  28     {
  29       "name" : "listeners",
  30       "type" : "Object",
  31       "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>",
  32       "memberOf" : "Roo.util.Observable",
  33       "optvals" : []
  34     },
  35     {
  36       "name" : "container_method",
  37       "type" : "string",
  38       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
  39       "memberOf" : "Roo.bootstrap.Component",
  40       "optvals" : []
  41     },
  42     {
  43       "name" : "tooltip",
  44       "type" : "string",
  45       "desc" : "Text for the tooltip",
  46       "memberOf" : "Roo.bootstrap.Component",
  47       "optvals" : []
  48     },
  49     {
  50       "name" : "visibilityEl",
  51       "type" : "string|object",
  52       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
  53       "memberOf" : "Roo.bootstrap.Component",
  54       "optvals" : [
  55         "el",
  56         "parent"
  57       ]
  58     },
  59     {
  60       "name" : "inverse",
  61       "type" : "Boolean",
  62       "desc" : "is inverted color",
  63       "memberOf" : "Roo.bootstrap.NavSimplebar",
  64       "optvals" : []
  65     },
  66     {
  67       "name" : "align",
  68       "type" : "String",
  69       "desc" : "t) alignment",
  70       "memberOf" : "Roo.bootstrap.NavSimplebar",
  71       "optvals" : [
  72         "left",
  73         "right"
  74       ]
  75     },
  76     {
  77       "name" : "can_build_overlaid",
  78       "type" : "Boolean",
  79       "desc" : "True if element can be rebuild from a HTML page",
  80       "memberOf" : "Roo.bootstrap.Component",
  81       "optvals" : []
  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       "optvals" : [
  89         "display",
  90         "visibility"
  91       ]
  92     },
  93     {
  94       "name" : "tag",
  95       "type" : "String",
  96       "desc" : "v) default is nav",
  97       "memberOf" : "Roo.bootstrap.NavSimplebar",
  98       "optvals" : [
  99         "header",
 100         "footer",
 101         "nav",
 102         "div"
 103       ]
 104     },
 105     {
 106       "name" : "style",
 107       "type" : "String",
 108       "desc" : "any extra css",
 109       "memberOf" : "Roo.bootstrap.Component",
 110       "optvals" : []
 111     },
 112     {
 113       "name" : "allowDomMove",
 114       "type" : "Boolean",
 115       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 116       "memberOf" : "Roo.Component",
 117       "optvals" : []
 118     },
 119     {
 120       "name" : "cls",
 121       "type" : "String",
 122       "desc" : "css class",
 123       "memberOf" : "Roo.bootstrap.Component",
 124       "optvals" : []
 125     },
 126     {
 127       "name" : "arrangement",
 128       "type" : "Boolean",
 129       "desc" : "stacked | justified",
 130       "memberOf" : "Roo.bootstrap.NavSimplebar",
 131       "optvals" : []
 132     },
 133     {
 134       "name" : "loadMask",
 135       "type" : "Boolean",
 136       "desc" : "e) loadMask on the bar",
 137       "memberOf" : "Roo.bootstrap.NavSimplebar",
 138       "optvals" : [
 139         "true",
 140         "false"
 141       ]
 142     },
 143     {
 144       "name" : "xattr",
 145       "type" : "Object",
 146       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 147       "memberOf" : "Roo.bootstrap.Component",
 148       "optvals" : []
 149     },
 150     {
 151       "name" : "actionMode",
 152       "type" : "String",
 153       "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",
 154       "memberOf" : "Roo.Component",
 155       "optvals" : []
 156     },
 157     {
 158       "name" : "main",
 159       "type" : "Boolean",
 160       "desc" : "e) main nav bar? default false",
 161       "memberOf" : "Roo.bootstrap.NavSimplebar",
 162       "optvals" : [
 163         "true",
 164         "false"
 165       ]
 166     },
 167     {
 168       "name" : "dataId",
 169       "type" : "string",
 170       "desc" : "cutomer id",
 171       "memberOf" : "Roo.bootstrap.Component",
 172       "optvals" : []
 173     },
 174     {
 175       "name" : "type",
 176       "type" : "String",
 177       "desc" : "s)",
 178       "memberOf" : "Roo.bootstrap.NavSimplebar",
 179       "optvals" : [
 180         "nav",
 181         "pills",
 182         "tabs"
 183       ]
 184     },
 185     {
 186       "name" : "weight",
 187       "type" : "String",
 188       "desc" : "e) default is light.",
 189       "memberOf" : "Roo.bootstrap.NavSimplebar",
 190       "optvals" : [
 191         "light",
 192         "primary",
 193         "secondary",
 194         "success",
 195         "danger",
 196         "warning",
 197         "info",
 198         "dark",
 199         "white"
 200       ]
 201     },
 202     {
 203       "name" : "name",
 204       "type" : "string",
 205       "desc" : "Specifies name attribute",
 206       "memberOf" : "Roo.bootstrap.Component",
 207       "optvals" : []
 208     },
 209     {
 210       "name" : "disableClass",
 211       "type" : "String",
 212       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 213       "memberOf" : "Roo.Component",
 214       "optvals" : []
 215     }
 216   ],
 217   "methods" : [
 218     {
 219       "name" : "collapse",
 220       "desc" : "Collapse the navbar pulldown",
 221       "isStatic" : false,
 222       "isConstructor" : false,
 223       "isPrivate" : false,
 224       "memberOf" : "Roo.bootstrap.Navbar",
 225       "example" : "",
 226       "deprecated" : "",
 227       "since" : "",
 228       "see" : "",
 229       "params" : [],
 230       "returns" : []
 231     },
 232     {
 233       "name" : "expand",
 234       "desc" : "Expand the navbar pulldown",
 235       "isStatic" : false,
 236       "isConstructor" : false,
 237       "isPrivate" : false,
 238       "memberOf" : "Roo.bootstrap.Navbar",
 239       "example" : "",
 240       "deprecated" : "",
 241       "since" : "",
 242       "see" : "",
 243       "params" : [],
 244       "returns" : []
 245     },
 246     {
 247       "name" : "tooltipEl",
 248       "desc" : "Fetch the element to display the tooltip on.",
 249       "isStatic" : false,
 250       "isConstructor" : false,
 251       "isPrivate" : false,
 252       "memberOf" : "Roo.bootstrap.Component",
 253       "example" : "",
 254       "deprecated" : "",
 255       "since" : "",
 256       "see" : "",
 257       "params" : [],
 258       "returns" : [
 259         {
 260           "name" : "",
 261           "type" : "Roo.Element",
 262           "desc" : "defaults to this.el"
 263         }
 264       ]
 265     },
 266     {
 267       "name" : "hide",
 268       "desc" : "Hide a component - adds 'hidden' class",
 269       "isStatic" : false,
 270       "isConstructor" : false,
 271       "isPrivate" : false,
 272       "memberOf" : "Roo.bootstrap.Component",
 273       "example" : "",
 274       "deprecated" : "",
 275       "since" : "",
 276       "see" : "",
 277       "params" : [],
 278       "returns" : []
 279     },
 280     {
 281       "name" : "show",
 282       "desc" : "Show a component - removes 'hidden' class",
 283       "isStatic" : false,
 284       "isConstructor" : false,
 285       "isPrivate" : false,
 286       "memberOf" : "Roo.bootstrap.Component",
 287       "example" : "",
 288       "deprecated" : "",
 289       "since" : "",
 290       "see" : "",
 291       "params" : [],
 292       "returns" : []
 293     },
 294     {
 295       "name" : "setVisibilityEl",
 296       "desc" : "Set the element that will be used to show or hide",
 297       "isStatic" : false,
 298       "isConstructor" : false,
 299       "isPrivate" : false,
 300       "memberOf" : "Roo.bootstrap.Component",
 301       "example" : "",
 302       "deprecated" : "",
 303       "since" : "",
 304       "see" : "",
 305       "params" : [],
 306       "returns" : []
 307     },
 308     {
 309       "name" : "getVisibilityEl",
 310       "desc" : "Get the element that will be used to show or hide",
 311       "isStatic" : false,
 312       "isConstructor" : false,
 313       "isPrivate" : false,
 314       "memberOf" : "Roo.bootstrap.Component",
 315       "example" : "",
 316       "deprecated" : "",
 317       "since" : "",
 318       "see" : "",
 319       "params" : [],
 320       "returns" : []
 321     },
 322     {
 323       "name" : "initEvents",
 324       "desc" : "Initialize Events for the element",
 325       "isStatic" : false,
 326       "isConstructor" : false,
 327       "isPrivate" : false,
 328       "memberOf" : "Roo.bootstrap.Component",
 329       "example" : "",
 330       "deprecated" : "",
 331       "since" : "",
 332       "see" : "",
 333       "params" : [],
 334       "returns" : []
 335     },
 336     {
 337       "name" : "getChildContainer",
 338       "desc" : "Fetch the element to add children to",
 339       "isStatic" : false,
 340       "isConstructor" : false,
 341       "isPrivate" : false,
 342       "memberOf" : "Roo.bootstrap.Component",
 343       "example" : "",
 344       "deprecated" : "",
 345       "since" : "",
 346       "see" : "",
 347       "params" : [],
 348       "returns" : [
 349         {
 350           "name" : "",
 351           "type" : "Roo.Element",
 352           "desc" : "defaults to this.el"
 353         }
 354       ]
 355     },
 356     {
 357       "name" : "getId",
 358       "desc" : "Returns the id of this component.",
 359       "isStatic" : false,
 360       "isConstructor" : false,
 361       "isPrivate" : false,
 362       "memberOf" : "Roo.Component",
 363       "example" : "",
 364       "deprecated" : "",
 365       "since" : "",
 366       "see" : "",
 367       "params" : [],
 368       "returns" : [
 369         {
 370           "name" : "",
 371           "type" : "String",
 372           "desc" : ""
 373         }
 374       ]
 375     },
 376     {
 377       "name" : "render",
 378       "desc" : "If this is a lazy rendering component, render it to its container element.",
 379       "isStatic" : false,
 380       "isConstructor" : false,
 381       "isPrivate" : false,
 382       "memberOf" : "Roo.Component",
 383       "example" : "",
 384       "deprecated" : "",
 385       "since" : "",
 386       "see" : "",
 387       "params" : [
 388         {
 389           "name" : "container",
 390           "type" : "String/HTMLElement/Element",
 391           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 392           "isOptional" : false
 393         }
 394       ],
 395       "returns" : []
 396     },
 397     {
 398       "name" : "destroy",
 399       "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}.",
 400       "isStatic" : false,
 401       "isConstructor" : false,
 402       "isPrivate" : false,
 403       "memberOf" : "Roo.Component",
 404       "example" : "",
 405       "deprecated" : "",
 406       "since" : "",
 407       "see" : "",
 408       "params" : [],
 409       "returns" : []
 410     },
 411     {
 412       "name" : "isVisible",
 413       "desc" : "Returns true if this component is visible.",
 414       "isStatic" : false,
 415       "isConstructor" : false,
 416       "isPrivate" : false,
 417       "memberOf" : "Roo.Component",
 418       "example" : "",
 419       "deprecated" : "",
 420       "since" : "",
 421       "see" : "",
 422       "params" : [],
 423       "returns" : []
 424     },
 425     {
 426       "name" : "setDisabled",
 427       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 428       "isStatic" : false,
 429       "isConstructor" : false,
 430       "isPrivate" : false,
 431       "memberOf" : "Roo.Component",
 432       "example" : "",
 433       "deprecated" : "",
 434       "since" : "",
 435       "see" : "",
 436       "params" : [
 437         {
 438           "name" : "disabled",
 439           "type" : "Boolean",
 440           "desc" : "",
 441           "isOptional" : false
 442         }
 443       ],
 444       "returns" : []
 445     },
 446     {
 447       "name" : "focus",
 448       "desc" : "Try to focus this component.",
 449       "isStatic" : false,
 450       "isConstructor" : false,
 451       "isPrivate" : false,
 452       "memberOf" : "Roo.Component",
 453       "example" : "",
 454       "deprecated" : "",
 455       "since" : "",
 456       "see" : "",
 457       "params" : [
 458         {
 459           "name" : "selectText",
 460           "type" : "Boolean",
 461           "desc" : "True to also select the text in this component (if applicable)",
 462           "isOptional" : false
 463         }
 464       ],
 465       "returns" : [
 466         {
 467           "name" : "",
 468           "type" : "Roo.Component",
 469           "desc" : "this"
 470         }
 471       ]
 472     },
 473     {
 474       "name" : "enable",
 475       "desc" : "Enable this component.",
 476       "isStatic" : false,
 477       "isConstructor" : false,
 478       "isPrivate" : false,
 479       "memberOf" : "Roo.Component",
 480       "example" : "",
 481       "deprecated" : "",
 482       "since" : "",
 483       "see" : "",
 484       "params" : [],
 485       "returns" : [
 486         {
 487           "name" : "",
 488           "type" : "Roo.Component",
 489           "desc" : "this"
 490         }
 491       ]
 492     },
 493     {
 494       "name" : "setVisible",
 495       "desc" : "Convenience function to hide or show this component by boolean.",
 496       "isStatic" : false,
 497       "isConstructor" : false,
 498       "isPrivate" : false,
 499       "memberOf" : "Roo.Component",
 500       "example" : "",
 501       "deprecated" : "",
 502       "since" : "",
 503       "see" : "",
 504       "params" : [
 505         {
 506           "name" : "visible",
 507           "type" : "Boolean",
 508           "desc" : "True to show, false to hide",
 509           "isOptional" : false
 510         }
 511       ],
 512       "returns" : [
 513         {
 514           "name" : "",
 515           "type" : "Roo.Component",
 516           "desc" : "this"
 517         }
 518       ]
 519     },
 520     {
 521       "name" : "disable",
 522       "desc" : "Disable this component.",
 523       "isStatic" : false,
 524       "isConstructor" : false,
 525       "isPrivate" : false,
 526       "memberOf" : "Roo.Component",
 527       "example" : "",
 528       "deprecated" : "",
 529       "since" : "",
 530       "see" : "",
 531       "params" : [],
 532       "returns" : [
 533         {
 534           "name" : "",
 535           "type" : "Roo.Component",
 536           "desc" : "this"
 537         }
 538       ]
 539     },
 540     {
 541       "name" : "getEl",
 542       "desc" : "Returns the underlying {@link Roo.Element}.",
 543       "isStatic" : false,
 544       "isConstructor" : false,
 545       "isPrivate" : false,
 546       "memberOf" : "Roo.Component",
 547       "example" : "",
 548       "deprecated" : "",
 549       "since" : "",
 550       "see" : "",
 551       "params" : [],
 552       "returns" : [
 553         {
 554           "name" : "",
 555           "type" : "Roo.Element",
 556           "desc" : "The element"
 557         }
 558       ]
 559     },
 560     {
 561       "name" : "purgeListeners",
 562       "desc" : "Removes all listeners for this object",
 563       "isStatic" : false,
 564       "isConstructor" : false,
 565       "isPrivate" : false,
 566       "memberOf" : "Roo.util.Observable",
 567       "example" : "",
 568       "deprecated" : "",
 569       "since" : "",
 570       "see" : "",
 571       "params" : [],
 572       "returns" : []
 573     },
 574     {
 575       "name" : "on",
 576       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 577       "isStatic" : false,
 578       "isConstructor" : false,
 579       "isPrivate" : false,
 580       "memberOf" : "Roo.util.Observable",
 581       "example" : "",
 582       "deprecated" : "",
 583       "since" : "",
 584       "see" : "",
 585       "params" : [
 586         {
 587           "name" : "eventName",
 588           "type" : "String",
 589           "desc" : "The type of event to listen for",
 590           "isOptional" : false
 591         },
 592         {
 593           "name" : "handler",
 594           "type" : "Function",
 595           "desc" : "The method the event invokes",
 596           "isOptional" : false
 597         },
 598         {
 599           "name" : "scope",
 600           "type" : "Object",
 601           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 602           "isOptional" : false
 603         },
 604         {
 605           "name" : "options",
 606           "type" : "Object",
 607           "desc" : "(optional)",
 608           "isOptional" : false
 609         }
 610       ],
 611       "returns" : []
 612     },
 613     {
 614       "name" : "un",
 615       "desc" : "Removes a listener (shorthand for removeListener)",
 616       "isStatic" : false,
 617       "isConstructor" : false,
 618       "isPrivate" : false,
 619       "memberOf" : "Roo.util.Observable",
 620       "example" : "",
 621       "deprecated" : "",
 622       "since" : "",
 623       "see" : "",
 624       "params" : [
 625         {
 626           "name" : "eventName",
 627           "type" : "String",
 628           "desc" : "The type of event to listen for",
 629           "isOptional" : false
 630         },
 631         {
 632           "name" : "handler",
 633           "type" : "Function",
 634           "desc" : "The handler to remove",
 635           "isOptional" : false
 636         },
 637         {
 638           "name" : "scope",
 639           "type" : "Object",
 640           "desc" : "(optional) The scope (this object) for the handler",
 641           "isOptional" : false
 642         }
 643       ],
 644       "returns" : []
 645     },
 646     {
 647       "name" : "addEvents",
 648       "desc" : "Used to define events on this Observable",
 649       "isStatic" : false,
 650       "isConstructor" : false,
 651       "isPrivate" : false,
 652       "memberOf" : "Roo.util.Observable",
 653       "example" : "",
 654       "deprecated" : "",
 655       "since" : "",
 656       "see" : "",
 657       "params" : [
 658         {
 659           "name" : "object",
 660           "type" : "Object",
 661           "desc" : "The object with the events defined",
 662           "isOptional" : false
 663         }
 664       ],
 665       "returns" : []
 666     },
 667     {
 668       "name" : "releaseCapture",
 669       "desc" : "Removes <b>all</b> added captures from the Observable.",
 670       "isStatic" : true,
 671       "isConstructor" : false,
 672       "isPrivate" : false,
 673       "memberOf" : "Roo.util.Observable",
 674       "example" : "",
 675       "deprecated" : "",
 676       "since" : "",
 677       "see" : "",
 678       "params" : [
 679         {
 680           "name" : "o",
 681           "type" : "Observable",
 682           "desc" : "The Observable to release",
 683           "isOptional" : false
 684         }
 685       ],
 686       "returns" : []
 687     },
 688     {
 689       "name" : "removeListener",
 690       "desc" : "Removes a listener",
 691       "isStatic" : false,
 692       "isConstructor" : false,
 693       "isPrivate" : false,
 694       "memberOf" : "Roo.util.Observable",
 695       "example" : "",
 696       "deprecated" : "",
 697       "since" : "",
 698       "see" : "",
 699       "params" : [
 700         {
 701           "name" : "eventName",
 702           "type" : "String",
 703           "desc" : "The type of event to listen for",
 704           "isOptional" : false
 705         },
 706         {
 707           "name" : "handler",
 708           "type" : "Function",
 709           "desc" : "The handler to remove",
 710           "isOptional" : false
 711         },
 712         {
 713           "name" : "scope",
 714           "type" : "Object",
 715           "desc" : "(optional) The scope (this object) for the handler",
 716           "isOptional" : false
 717         }
 718       ],
 719       "returns" : []
 720     },
 721     {
 722       "name" : "fireEvent",
 723       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 724       "isStatic" : false,
 725       "isConstructor" : false,
 726       "isPrivate" : false,
 727       "memberOf" : "Roo.util.Observable",
 728       "example" : "",
 729       "deprecated" : "",
 730       "since" : "",
 731       "see" : "",
 732       "params" : [
 733         {
 734           "name" : "eventName",
 735           "type" : "String",
 736           "desc" : "",
 737           "isOptional" : false
 738         },
 739         {
 740           "name" : "args",
 741           "type" : "Object...",
 742           "desc" : "Variable number of parameters are passed to handlers",
 743           "isOptional" : false
 744         }
 745       ],
 746       "returns" : [
 747         {
 748           "name" : "",
 749           "type" : "Boolean",
 750           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 751         }
 752       ]
 753     },
 754     {
 755       "name" : "hasListener",
 756       "desc" : "Checks to see if this object has any listeners for a specified event",
 757       "isStatic" : false,
 758       "isConstructor" : false,
 759       "isPrivate" : false,
 760       "memberOf" : "Roo.util.Observable",
 761       "example" : "",
 762       "deprecated" : "",
 763       "since" : "",
 764       "see" : "",
 765       "params" : [
 766         {
 767           "name" : "eventName",
 768           "type" : "String",
 769           "desc" : "The name of the event to check for",
 770           "isOptional" : false
 771         }
 772       ],
 773       "returns" : [
 774         {
 775           "name" : "",
 776           "type" : "Boolean",
 777           "desc" : "True if the event is being listened for, else false"
 778         }
 779       ]
 780     },
 781     {
 782       "name" : "capture",
 783       "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.",
 784       "isStatic" : true,
 785       "isConstructor" : false,
 786       "isPrivate" : false,
 787       "memberOf" : "Roo.util.Observable",
 788       "example" : "",
 789       "deprecated" : "",
 790       "since" : "",
 791       "see" : "",
 792       "params" : [
 793         {
 794           "name" : "o",
 795           "type" : "Observable",
 796           "desc" : "The Observable to capture",
 797           "isOptional" : false
 798         },
 799         {
 800           "name" : "fn",
 801           "type" : "Function",
 802           "desc" : "The function to call",
 803           "isOptional" : false
 804         },
 805         {
 806           "name" : "scope",
 807           "type" : "Object",
 808           "desc" : "(optional) The scope (this object) for the fn",
 809           "isOptional" : false
 810         }
 811       ],
 812       "returns" : []
 813     },
 814     {
 815       "name" : "addListener",
 816       "desc" : "Appends an event handler to this component",
 817       "isStatic" : false,
 818       "isConstructor" : false,
 819       "isPrivate" : false,
 820       "memberOf" : "Roo.util.Observable",
 821       "example" : "",
 822       "deprecated" : "",
 823       "since" : "",
 824       "see" : "",
 825       "params" : [
 826         {
 827           "name" : "eventName",
 828           "type" : "String",
 829           "desc" : "The type of event to listen for",
 830           "isOptional" : false
 831         },
 832         {
 833           "name" : "handler",
 834           "type" : "Function",
 835           "desc" : "The method the event invokes",
 836           "isOptional" : false
 837         },
 838         {
 839           "name" : "scope",
 840           "type" : "Object",
 841           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 842           "isOptional" : false
 843         },
 844         {
 845           "name" : "options",
 846           "type" : "Object",
 847           "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>",
 848           "isOptional" : false
 849         }
 850       ],
 851       "returns" : []
 852     }
 853   ],
 854   "events" : [
 855     {
 856       "name" : "beforetoggle",
 857       "desc" : "Fire before toggle the menu",
 858       "memberOf" : "Roo.bootstrap.Navbar",
 859       "example" : "",
 860       "deprecated" : "",
 861       "since" : "",
 862       "see" : "",
 863       "params" : [
 864         {
 865           "name" : "e",
 866           "type" : "Roo.EventObject",
 867           "desc" : "",
 868           "isOptional" : false
 869         }
 870       ],
 871       "returns" : []
 872     },
 873     {
 874       "name" : "childrenrendered",
 875       "desc" : "Fires when the children have been rendered..",
 876       "memberOf" : "Roo.bootstrap.Component",
 877       "example" : "",
 878       "deprecated" : "",
 879       "since" : "",
 880       "see" : "",
 881       "params" : [
 882         {
 883           "name" : "this",
 884           "type" : "Roo.bootstrap.Component",
 885           "desc" : "",
 886           "isOptional" : false
 887         }
 888       ],
 889       "returns" : []
 890     },
 891     {
 892       "name" : "beforerender",
 893       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 894       "memberOf" : "Roo.Component",
 895       "example" : "",
 896       "deprecated" : "",
 897       "since" : "",
 898       "see" : "",
 899       "params" : [
 900         {
 901           "name" : "this",
 902           "type" : "Roo.Component",
 903           "desc" : "",
 904           "isOptional" : false
 905         }
 906       ],
 907       "returns" : []
 908     },
 909     {
 910       "name" : "disable",
 911       "desc" : "Fires after the component is disabled.",
 912       "memberOf" : "Roo.Component",
 913       "example" : "",
 914       "deprecated" : "",
 915       "since" : "",
 916       "see" : "",
 917       "params" : [
 918         {
 919           "name" : "this",
 920           "type" : "Roo.Component",
 921           "desc" : "",
 922           "isOptional" : false
 923         }
 924       ],
 925       "returns" : []
 926     },
 927     {
 928       "name" : "render",
 929       "desc" : "Fires after the component is rendered.",
 930       "memberOf" : "Roo.Component",
 931       "example" : "",
 932       "deprecated" : "",
 933       "since" : "",
 934       "see" : "",
 935       "params" : [
 936         {
 937           "name" : "this",
 938           "type" : "Roo.Component",
 939           "desc" : "",
 940           "isOptional" : false
 941         }
 942       ],
 943       "returns" : []
 944     },
 945     {
 946       "name" : "destroy",
 947       "desc" : "Fires after the component is destroyed.",
 948       "memberOf" : "Roo.Component",
 949       "example" : "",
 950       "deprecated" : "",
 951       "since" : "",
 952       "see" : "",
 953       "params" : [
 954         {
 955           "name" : "this",
 956           "type" : "Roo.Component",
 957           "desc" : "",
 958           "isOptional" : false
 959         }
 960       ],
 961       "returns" : []
 962     },
 963     {
 964       "name" : "hide",
 965       "desc" : "Fires after the component is hidden.",
 966       "memberOf" : "Roo.Component",
 967       "example" : "",
 968       "deprecated" : "",
 969       "since" : "",
 970       "see" : "",
 971       "params" : [
 972         {
 973           "name" : "this",
 974           "type" : "Roo.Component",
 975           "desc" : "",
 976           "isOptional" : false
 977         }
 978       ],
 979       "returns" : []
 980     },
 981     {
 982       "name" : "beforehide",
 983       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
 984       "memberOf" : "Roo.Component",
 985       "example" : "",
 986       "deprecated" : "",
 987       "since" : "",
 988       "see" : "",
 989       "params" : [
 990         {
 991           "name" : "this",
 992           "type" : "Roo.Component",
 993           "desc" : "",
 994           "isOptional" : false
 995         }
 996       ],
 997       "returns" : []
 998     },
 999     {
1000       "name" : "show",
1001       "desc" : "Fires after the component is shown.",
1002       "memberOf" : "Roo.Component",
1003       "example" : "",
1004       "deprecated" : "",
1005       "since" : "",
1006       "see" : "",
1007       "params" : [
1008         {
1009           "name" : "this",
1010           "type" : "Roo.Component",
1011           "desc" : "",
1012           "isOptional" : false
1013         }
1014       ],
1015       "returns" : []
1016     },
1017     {
1018       "name" : "beforeshow",
1019       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1020       "memberOf" : "Roo.Component",
1021       "example" : "",
1022       "deprecated" : "",
1023       "since" : "",
1024       "see" : "",
1025       "params" : [
1026         {
1027           "name" : "this",
1028           "type" : "Roo.Component",
1029           "desc" : "",
1030           "isOptional" : false
1031         }
1032       ],
1033       "returns" : []
1034     },
1035     {
1036       "name" : "enable",
1037       "desc" : "Fires after the component is enabled.",
1038       "memberOf" : "Roo.Component",
1039       "example" : "",
1040       "deprecated" : "",
1041       "since" : "",
1042       "see" : "",
1043       "params" : [
1044         {
1045           "name" : "this",
1046           "type" : "Roo.Component",
1047           "desc" : "",
1048           "isOptional" : false
1049         }
1050       ],
1051       "returns" : []
1052     },
1053     {
1054       "name" : "beforedestroy",
1055       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1056       "memberOf" : "Roo.Component",
1057       "example" : "",
1058       "deprecated" : "",
1059       "since" : "",
1060       "see" : "",
1061       "params" : [
1062         {
1063           "name" : "this",
1064           "type" : "Roo.Component",
1065           "desc" : "",
1066           "isOptional" : false
1067         }
1068       ],
1069       "returns" : []
1070     }
1071   ]
1072 }