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