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