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