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

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