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

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