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