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