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