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

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