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