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

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