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