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

   1 {
   2   "name" : "Roo.bootstrap.DocumentManager",
   3   "augments" : [
   4     "Roo.bootstrap.Component",
   5     "Roo.Component",
   6     "Roo.util.Observable"
   7   ],
   8   "desc" : "Bootstrap DocumentManager class",
   9   "isSingleton" : false,
  10   "isStatic" : false,
  11   "isBuiltin" : false,
  12   "memberOf" : "DocumentManager",
  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   "config" : [
  27     {
  28       "name" : "labelAlign",
  29       "type" : "String",
  30       "desc" : "p) default left",
  31       "memberOf" : "Roo.bootstrap.DocumentManager",
  32       "optvals" : [
  33         "left",
  34         "top"
  35       ]
  36     },
  37     {
  38       "name" : "labellg",
  39       "type" : "Number",
  40       "desc" : "set the width of label (1-12)",
  41       "memberOf" : "Roo.bootstrap.DocumentManager",
  42       "optvals" : []
  43     },
  44     {
  45       "name" : "listeners",
  46       "type" : "Object",
  47       "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>",
  48       "memberOf" : "Roo.util.Observable",
  49       "optvals" : []
  50     },
  51     {
  52       "name" : "labelxs",
  53       "type" : "Number",
  54       "desc" : "set the width of label (1-12)",
  55       "memberOf" : "Roo.bootstrap.DocumentManager",
  56       "optvals" : []
  57     },
  58     {
  59       "name" : "tooltip",
  60       "type" : "string",
  61       "desc" : "Text for the tooltip",
  62       "memberOf" : "Roo.bootstrap.Component",
  63       "optvals" : []
  64     },
  65     {
  66       "name" : "container_method",
  67       "type" : "string",
  68       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
  69       "memberOf" : "Roo.bootstrap.Component",
  70       "optvals" : []
  71     },
  72     {
  73       "name" : "visibilityEl",
  74       "type" : "string|object",
  75       "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
  76       "memberOf" : "Roo.bootstrap.Component",
  77       "optvals" : [
  78         "el",
  79         "parent"
  80       ]
  81     },
  82     {
  83       "name" : "fieldLabel",
  84       "type" : "String",
  85       "desc" : "",
  86       "memberOf" : "Roo.bootstrap.DocumentManager",
  87       "optvals" : []
  88     },
  89     {
  90       "name" : "toolTipName",
  91       "type" : "String",
  92       "desc" : "default 'filename'",
  93       "memberOf" : "Roo.bootstrap.DocumentManager",
  94       "optvals" : []
  95     },
  96     {
  97       "name" : "can_build_overlaid",
  98       "type" : "Boolean",
  99       "desc" : "True if element can be rebuild from a HTML page",
 100       "memberOf" : "Roo.bootstrap.Component",
 101       "optvals" : []
 102     },
 103     {
 104       "name" : "hideMode",
 105       "type" : "String",
 106       "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\".",
 107       "memberOf" : "Roo.Component",
 108       "optvals" : [
 109         "display",
 110         "visibility"
 111       ]
 112     },
 113     {
 114       "name" : "method",
 115       "type" : "String",
 116       "desc" : "default POST",
 117       "memberOf" : "Roo.bootstrap.DocumentManager",
 118       "optvals" : []
 119     },
 120     {
 121       "name" : "style",
 122       "type" : "String",
 123       "desc" : "any extra css",
 124       "memberOf" : "Roo.bootstrap.Component",
 125       "optvals" : []
 126     },
 127     {
 128       "name" : "allowDomMove",
 129       "type" : "Boolean",
 130       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 131       "memberOf" : "Roo.Component",
 132       "optvals" : []
 133     },
 134     {
 135       "name" : "paramName",
 136       "type" : "String",
 137       "desc" : "default 'imageUpload'",
 138       "memberOf" : "Roo.bootstrap.DocumentManager",
 139       "optvals" : []
 140     },
 141     {
 142       "name" : "labelWidth",
 143       "type" : "Number",
 144       "desc" : "default 4",
 145       "memberOf" : "Roo.bootstrap.DocumentManager",
 146       "optvals" : []
 147     },
 148     {
 149       "name" : "cls",
 150       "type" : "String",
 151       "desc" : "css class",
 152       "memberOf" : "Roo.bootstrap.Component",
 153       "optvals" : []
 154     },
 155     {
 156       "name" : "editable",
 157       "type" : "Boolean",
 158       "desc" : "e) allow edit when upload a image default true",
 159       "memberOf" : "Roo.bootstrap.DocumentManager",
 160       "optvals" : [
 161         "true",
 162         "false"
 163       ]
 164     },
 165     {
 166       "name" : "labelsm",
 167       "type" : "Number",
 168       "desc" : "set the width of label (1-12)",
 169       "memberOf" : "Roo.bootstrap.DocumentManager",
 170       "optvals" : []
 171     },
 172     {
 173       "name" : "xattr",
 174       "type" : "Object",
 175       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 176       "memberOf" : "Roo.bootstrap.Component",
 177       "optvals" : []
 178     },
 179     {
 180       "name" : "actionMode",
 181       "type" : "String",
 182       "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",
 183       "memberOf" : "Roo.Component",
 184       "optvals" : []
 185     },
 186     {
 187       "name" : "boxes",
 188       "type" : "Number",
 189       "desc" : "number of boxes, 0 is no limit.. default 0",
 190       "memberOf" : "Roo.bootstrap.DocumentManager",
 191       "optvals" : []
 192     },
 193     {
 194       "name" : "multiple",
 195       "type" : "Boolean",
 196       "desc" : "multiple upload default true",
 197       "memberOf" : "Roo.bootstrap.DocumentManager",
 198       "optvals" : []
 199     },
 200     {
 201       "name" : "thumbSize",
 202       "type" : "Number",
 203       "desc" : "default 300",
 204       "memberOf" : "Roo.bootstrap.DocumentManager",
 205       "optvals" : []
 206     },
 207     {
 208       "name" : "labelmd",
 209       "type" : "Number",
 210       "desc" : "set the width of label (1-12)",
 211       "memberOf" : "Roo.bootstrap.DocumentManager",
 212       "optvals" : []
 213     },
 214     {
 215       "name" : "dataId",
 216       "type" : "string",
 217       "desc" : "cutomer id",
 218       "memberOf" : "Roo.bootstrap.Component",
 219       "optvals" : []
 220     },
 221     {
 222       "name" : "url",
 223       "type" : "String",
 224       "desc" : "action url",
 225       "memberOf" : "Roo.bootstrap.DocumentManager",
 226       "optvals" : []
 227     },
 228     {
 229       "name" : "name",
 230       "type" : "string",
 231       "desc" : "Specifies name attribute",
 232       "memberOf" : "Roo.bootstrap.Component",
 233       "optvals" : []
 234     },
 235     {
 236       "name" : "disableClass",
 237       "type" : "String",
 238       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 239       "memberOf" : "Roo.Component",
 240       "optvals" : []
 241     }
 242   ],
 243   "methods" : [
 244     {
 245       "name" : "tooltipEl",
 246       "desc" : "Fetch the element to display the tooltip on.",
 247       "isStatic" : false,
 248       "isConstructor" : false,
 249       "isPrivate" : false,
 250       "memberOf" : "Roo.bootstrap.Component",
 251       "example" : "",
 252       "deprecated" : "",
 253       "since" : "",
 254       "see" : "",
 255       "params" : [],
 256       "returns" : [
 257         {
 258           "name" : "",
 259           "type" : "Roo.Element",
 260           "desc" : "defaults to this.el"
 261         }
 262       ]
 263     },
 264     {
 265       "name" : "hide",
 266       "desc" : "Hide a component - adds 'hidden' class",
 267       "isStatic" : false,
 268       "isConstructor" : false,
 269       "isPrivate" : false,
 270       "memberOf" : "Roo.bootstrap.Component",
 271       "example" : "",
 272       "deprecated" : "",
 273       "since" : "",
 274       "see" : "",
 275       "params" : [],
 276       "returns" : []
 277     },
 278     {
 279       "name" : "show",
 280       "desc" : "Show a component - removes 'hidden' class",
 281       "isStatic" : false,
 282       "isConstructor" : false,
 283       "isPrivate" : false,
 284       "memberOf" : "Roo.bootstrap.Component",
 285       "example" : "",
 286       "deprecated" : "",
 287       "since" : "",
 288       "see" : "",
 289       "params" : [],
 290       "returns" : []
 291     },
 292     {
 293       "name" : "setVisibilityEl",
 294       "desc" : "Set the element that will be used to show or hide",
 295       "isStatic" : false,
 296       "isConstructor" : false,
 297       "isPrivate" : false,
 298       "memberOf" : "Roo.bootstrap.Component",
 299       "example" : "",
 300       "deprecated" : "",
 301       "since" : "",
 302       "see" : "",
 303       "params" : [],
 304       "returns" : []
 305     },
 306     {
 307       "name" : "getVisibilityEl",
 308       "desc" : "Get the element that will be used to show or hide",
 309       "isStatic" : false,
 310       "isConstructor" : false,
 311       "isPrivate" : false,
 312       "memberOf" : "Roo.bootstrap.Component",
 313       "example" : "",
 314       "deprecated" : "",
 315       "since" : "",
 316       "see" : "",
 317       "params" : [],
 318       "returns" : []
 319     },
 320     {
 321       "name" : "initEvents",
 322       "desc" : "Initialize Events for the element",
 323       "isStatic" : false,
 324       "isConstructor" : false,
 325       "isPrivate" : false,
 326       "memberOf" : "Roo.bootstrap.Component",
 327       "example" : "",
 328       "deprecated" : "",
 329       "since" : "",
 330       "see" : "",
 331       "params" : [],
 332       "returns" : []
 333     },
 334     {
 335       "name" : "getChildContainer",
 336       "desc" : "Fetch the element to add children to",
 337       "isStatic" : false,
 338       "isConstructor" : false,
 339       "isPrivate" : false,
 340       "memberOf" : "Roo.bootstrap.Component",
 341       "example" : "",
 342       "deprecated" : "",
 343       "since" : "",
 344       "see" : "",
 345       "params" : [],
 346       "returns" : [
 347         {
 348           "name" : "",
 349           "type" : "Roo.Element",
 350           "desc" : "defaults to this.el"
 351         }
 352       ]
 353     },
 354     {
 355       "name" : "getId",
 356       "desc" : "Returns the id of this component.",
 357       "isStatic" : false,
 358       "isConstructor" : false,
 359       "isPrivate" : false,
 360       "memberOf" : "Roo.Component",
 361       "example" : "",
 362       "deprecated" : "",
 363       "since" : "",
 364       "see" : "",
 365       "params" : [],
 366       "returns" : [
 367         {
 368           "name" : "",
 369           "type" : "String",
 370           "desc" : ""
 371         }
 372       ]
 373     },
 374     {
 375       "name" : "render",
 376       "desc" : "If this is a lazy rendering component, render it to its container element.",
 377       "isStatic" : false,
 378       "isConstructor" : false,
 379       "isPrivate" : false,
 380       "memberOf" : "Roo.Component",
 381       "example" : "",
 382       "deprecated" : "",
 383       "since" : "",
 384       "see" : "",
 385       "params" : [
 386         {
 387           "name" : "container",
 388           "type" : "String/HTMLElement/Element",
 389           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 390           "isOptional" : false
 391         }
 392       ],
 393       "returns" : []
 394     },
 395     {
 396       "name" : "destroy",
 397       "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}.",
 398       "isStatic" : false,
 399       "isConstructor" : false,
 400       "isPrivate" : false,
 401       "memberOf" : "Roo.Component",
 402       "example" : "",
 403       "deprecated" : "",
 404       "since" : "",
 405       "see" : "",
 406       "params" : [],
 407       "returns" : []
 408     },
 409     {
 410       "name" : "isVisible",
 411       "desc" : "Returns true if this component is visible.",
 412       "isStatic" : false,
 413       "isConstructor" : false,
 414       "isPrivate" : false,
 415       "memberOf" : "Roo.Component",
 416       "example" : "",
 417       "deprecated" : "",
 418       "since" : "",
 419       "see" : "",
 420       "params" : [],
 421       "returns" : []
 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       "name" : "focus",
 446       "desc" : "Try to focus this component.",
 447       "isStatic" : false,
 448       "isConstructor" : false,
 449       "isPrivate" : false,
 450       "memberOf" : "Roo.Component",
 451       "example" : "",
 452       "deprecated" : "",
 453       "since" : "",
 454       "see" : "",
 455       "params" : [
 456         {
 457           "name" : "selectText",
 458           "type" : "Boolean",
 459           "desc" : "True to also select the text in this component (if applicable)",
 460           "isOptional" : false
 461         }
 462       ],
 463       "returns" : [
 464         {
 465           "name" : "",
 466           "type" : "Roo.Component",
 467           "desc" : "this"
 468         }
 469       ]
 470     },
 471     {
 472       "name" : "enable",
 473       "desc" : "Enable this component.",
 474       "isStatic" : false,
 475       "isConstructor" : false,
 476       "isPrivate" : false,
 477       "memberOf" : "Roo.Component",
 478       "example" : "",
 479       "deprecated" : "",
 480       "since" : "",
 481       "see" : "",
 482       "params" : [],
 483       "returns" : [
 484         {
 485           "name" : "",
 486           "type" : "Roo.Component",
 487           "desc" : "this"
 488         }
 489       ]
 490     },
 491     {
 492       "name" : "setVisible",
 493       "desc" : "Convenience function to hide or show this component by boolean.",
 494       "isStatic" : false,
 495       "isConstructor" : false,
 496       "isPrivate" : false,
 497       "memberOf" : "Roo.Component",
 498       "example" : "",
 499       "deprecated" : "",
 500       "since" : "",
 501       "see" : "",
 502       "params" : [
 503         {
 504           "name" : "visible",
 505           "type" : "Boolean",
 506           "desc" : "True to show, false to hide",
 507           "isOptional" : false
 508         }
 509       ],
 510       "returns" : [
 511         {
 512           "name" : "",
 513           "type" : "Roo.Component",
 514           "desc" : "this"
 515         }
 516       ]
 517     },
 518     {
 519       "name" : "disable",
 520       "desc" : "Disable this component.",
 521       "isStatic" : false,
 522       "isConstructor" : false,
 523       "isPrivate" : false,
 524       "memberOf" : "Roo.Component",
 525       "example" : "",
 526       "deprecated" : "",
 527       "since" : "",
 528       "see" : "",
 529       "params" : [],
 530       "returns" : [
 531         {
 532           "name" : "",
 533           "type" : "Roo.Component",
 534           "desc" : "this"
 535         }
 536       ]
 537     },
 538     {
 539       "name" : "getEl",
 540       "desc" : "Returns the underlying {@link Roo.Element}.",
 541       "isStatic" : false,
 542       "isConstructor" : false,
 543       "isPrivate" : false,
 544       "memberOf" : "Roo.Component",
 545       "example" : "",
 546       "deprecated" : "",
 547       "since" : "",
 548       "see" : "",
 549       "params" : [],
 550       "returns" : [
 551         {
 552           "name" : "",
 553           "type" : "Roo.Element",
 554           "desc" : "The element"
 555         }
 556       ]
 557     },
 558     {
 559       "name" : "purgeListeners",
 560       "desc" : "Removes all listeners for this object",
 561       "isStatic" : false,
 562       "isConstructor" : false,
 563       "isPrivate" : false,
 564       "memberOf" : "Roo.util.Observable",
 565       "example" : "",
 566       "deprecated" : "",
 567       "since" : "",
 568       "see" : "",
 569       "params" : [],
 570       "returns" : []
 571     },
 572     {
 573       "name" : "on",
 574       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 575       "isStatic" : false,
 576       "isConstructor" : false,
 577       "isPrivate" : false,
 578       "memberOf" : "Roo.util.Observable",
 579       "example" : "",
 580       "deprecated" : "",
 581       "since" : "",
 582       "see" : "",
 583       "params" : [
 584         {
 585           "name" : "eventName",
 586           "type" : "String",
 587           "desc" : "The type of event to listen for",
 588           "isOptional" : false
 589         },
 590         {
 591           "name" : "handler",
 592           "type" : "Function",
 593           "desc" : "The method the event invokes",
 594           "isOptional" : false
 595         },
 596         {
 597           "name" : "scope",
 598           "type" : "Object",
 599           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 600           "isOptional" : false
 601         },
 602         {
 603           "name" : "options",
 604           "type" : "Object",
 605           "desc" : "(optional)",
 606           "isOptional" : false
 607         }
 608       ],
 609       "returns" : []
 610     },
 611     {
 612       "name" : "un",
 613       "desc" : "Removes a listener (shorthand for removeListener)",
 614       "isStatic" : false,
 615       "isConstructor" : false,
 616       "isPrivate" : false,
 617       "memberOf" : "Roo.util.Observable",
 618       "example" : "",
 619       "deprecated" : "",
 620       "since" : "",
 621       "see" : "",
 622       "params" : [
 623         {
 624           "name" : "eventName",
 625           "type" : "String",
 626           "desc" : "The type of event to listen for",
 627           "isOptional" : false
 628         },
 629         {
 630           "name" : "handler",
 631           "type" : "Function",
 632           "desc" : "The handler to remove",
 633           "isOptional" : false
 634         },
 635         {
 636           "name" : "scope",
 637           "type" : "Object",
 638           "desc" : "(optional) The scope (this object) for the handler",
 639           "isOptional" : false
 640         }
 641       ],
 642       "returns" : []
 643     },
 644     {
 645       "name" : "addEvents",
 646       "desc" : "Used to define events on this Observable",
 647       "isStatic" : false,
 648       "isConstructor" : false,
 649       "isPrivate" : false,
 650       "memberOf" : "Roo.util.Observable",
 651       "example" : "",
 652       "deprecated" : "",
 653       "since" : "",
 654       "see" : "",
 655       "params" : [
 656         {
 657           "name" : "object",
 658           "type" : "Object",
 659           "desc" : "The object with the events defined",
 660           "isOptional" : false
 661         }
 662       ],
 663       "returns" : []
 664     },
 665     {
 666       "name" : "releaseCapture",
 667       "desc" : "Removes <b>all</b> added captures from the Observable.",
 668       "isStatic" : true,
 669       "isConstructor" : false,
 670       "isPrivate" : false,
 671       "memberOf" : "Roo.util.Observable",
 672       "example" : "",
 673       "deprecated" : "",
 674       "since" : "",
 675       "see" : "",
 676       "params" : [
 677         {
 678           "name" : "o",
 679           "type" : "Observable",
 680           "desc" : "The Observable to release",
 681           "isOptional" : false
 682         }
 683       ],
 684       "returns" : []
 685     },
 686     {
 687       "name" : "removeListener",
 688       "desc" : "Removes a listener",
 689       "isStatic" : false,
 690       "isConstructor" : false,
 691       "isPrivate" : false,
 692       "memberOf" : "Roo.util.Observable",
 693       "example" : "",
 694       "deprecated" : "",
 695       "since" : "",
 696       "see" : "",
 697       "params" : [
 698         {
 699           "name" : "eventName",
 700           "type" : "String",
 701           "desc" : "The type of event to listen for",
 702           "isOptional" : false
 703         },
 704         {
 705           "name" : "handler",
 706           "type" : "Function",
 707           "desc" : "The handler to remove",
 708           "isOptional" : false
 709         },
 710         {
 711           "name" : "scope",
 712           "type" : "Object",
 713           "desc" : "(optional) The scope (this object) for the handler",
 714           "isOptional" : false
 715         }
 716       ],
 717       "returns" : []
 718     },
 719     {
 720       "name" : "fireEvent",
 721       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 722       "isStatic" : false,
 723       "isConstructor" : false,
 724       "isPrivate" : false,
 725       "memberOf" : "Roo.util.Observable",
 726       "example" : "",
 727       "deprecated" : "",
 728       "since" : "",
 729       "see" : "",
 730       "params" : [
 731         {
 732           "name" : "eventName",
 733           "type" : "String",
 734           "desc" : "",
 735           "isOptional" : false
 736         },
 737         {
 738           "name" : "args",
 739           "type" : "Object...",
 740           "desc" : "Variable number of parameters are passed to handlers",
 741           "isOptional" : false
 742         }
 743       ],
 744       "returns" : [
 745         {
 746           "name" : "",
 747           "type" : "Boolean",
 748           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 749         }
 750       ]
 751     },
 752     {
 753       "name" : "hasListener",
 754       "desc" : "Checks to see if this object has any listeners for a specified event",
 755       "isStatic" : false,
 756       "isConstructor" : false,
 757       "isPrivate" : false,
 758       "memberOf" : "Roo.util.Observable",
 759       "example" : "",
 760       "deprecated" : "",
 761       "since" : "",
 762       "see" : "",
 763       "params" : [
 764         {
 765           "name" : "eventName",
 766           "type" : "String",
 767           "desc" : "The name of the event to check for",
 768           "isOptional" : false
 769         }
 770       ],
 771       "returns" : [
 772         {
 773           "name" : "",
 774           "type" : "Boolean",
 775           "desc" : "True if the event is being listened for, else false"
 776         }
 777       ]
 778     },
 779     {
 780       "name" : "capture",
 781       "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.",
 782       "isStatic" : true,
 783       "isConstructor" : false,
 784       "isPrivate" : false,
 785       "memberOf" : "Roo.util.Observable",
 786       "example" : "",
 787       "deprecated" : "",
 788       "since" : "",
 789       "see" : "",
 790       "params" : [
 791         {
 792           "name" : "o",
 793           "type" : "Observable",
 794           "desc" : "The Observable to capture",
 795           "isOptional" : false
 796         },
 797         {
 798           "name" : "fn",
 799           "type" : "Function",
 800           "desc" : "The function to call",
 801           "isOptional" : false
 802         },
 803         {
 804           "name" : "scope",
 805           "type" : "Object",
 806           "desc" : "(optional) The scope (this object) for the fn",
 807           "isOptional" : false
 808         }
 809       ],
 810       "returns" : []
 811     },
 812     {
 813       "name" : "addListener",
 814       "desc" : "Appends an event handler to this component",
 815       "isStatic" : false,
 816       "isConstructor" : false,
 817       "isPrivate" : false,
 818       "memberOf" : "Roo.util.Observable",
 819       "example" : "",
 820       "deprecated" : "",
 821       "since" : "",
 822       "see" : "",
 823       "params" : [
 824         {
 825           "name" : "eventName",
 826           "type" : "String",
 827           "desc" : "The type of event to listen for",
 828           "isOptional" : false
 829         },
 830         {
 831           "name" : "handler",
 832           "type" : "Function",
 833           "desc" : "The method the event invokes",
 834           "isOptional" : false
 835         },
 836         {
 837           "name" : "scope",
 838           "type" : "Object",
 839           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 840           "isOptional" : false
 841         },
 842         {
 843           "name" : "options",
 844           "type" : "Object",
 845           "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>",
 846           "isOptional" : false
 847         }
 848       ],
 849       "returns" : []
 850     }
 851   ],
 852   "events" : [
 853     {
 854       "name" : "refresh",
 855       "desc" : "Fire after refresh the file",
 856       "memberOf" : "Roo.bootstrap.DocumentManager",
 857       "example" : "",
 858       "deprecated" : "",
 859       "since" : "",
 860       "see" : "",
 861       "params" : [
 862         {
 863           "name" : "this",
 864           "type" : "Roo.bootstrap.DocumentManager",
 865           "desc" : "",
 866           "isOptional" : false
 867         }
 868       ],
 869       "returns" : []
 870     },
 871     {
 872       "name" : "afterupload",
 873       "desc" : "Fire when xhr load exception",
 874       "memberOf" : "Roo.bootstrap.DocumentManager",
 875       "example" : "",
 876       "deprecated" : "",
 877       "since" : "",
 878       "see" : "",
 879       "params" : [
 880         {
 881           "name" : "this",
 882           "type" : "Roo.bootstrap.DocumentManager",
 883           "desc" : "",
 884           "isOptional" : false
 885         },
 886         {
 887           "name" : "xhr",
 888           "type" : "XMLHttpRequest",
 889           "desc" : "",
 890           "isOptional" : false
 891         }
 892       ],
 893       "returns" : []
 894     },
 895     {
 896       "name" : "beforeselectfile",
 897       "desc" : "Fire before select file",
 898       "memberOf" : "Roo.bootstrap.DocumentManager",
 899       "example" : "",
 900       "deprecated" : "",
 901       "since" : "",
 902       "see" : "",
 903       "params" : [
 904         {
 905           "name" : "this",
 906           "type" : "Roo.bootstrap.DocumentManager",
 907           "desc" : "",
 908           "isOptional" : false
 909         }
 910       ],
 911       "returns" : []
 912     },
 913     {
 914       "name" : "remove",
 915       "desc" : "Fire when remove the file",
 916       "memberOf" : "Roo.bootstrap.DocumentManager",
 917       "example" : "",
 918       "deprecated" : "",
 919       "since" : "",
 920       "see" : "",
 921       "params" : [
 922         {
 923           "name" : "this",
 924           "type" : "Roo.bootstrap.DocumentManager",
 925           "desc" : "",
 926           "isOptional" : false
 927         },
 928         {
 929           "name" : "file",
 930           "type" : "Object",
 931           "desc" : "",
 932           "isOptional" : false
 933         }
 934       ],
 935       "returns" : []
 936     },
 937     {
 938       "name" : "process",
 939       "desc" : "Fire before process file",
 940       "memberOf" : "Roo.bootstrap.DocumentManager",
 941       "example" : "",
 942       "deprecated" : "",
 943       "since" : "",
 944       "see" : "",
 945       "params" : [
 946         {
 947           "name" : "this",
 948           "type" : "Roo.bootstrap.DocumentManager",
 949           "desc" : "",
 950           "isOptional" : false
 951         },
 952         {
 953           "name" : "file",
 954           "type" : "Object",
 955           "desc" : "",
 956           "isOptional" : false
 957         }
 958       ],
 959       "returns" : []
 960     },
 961     {
 962       "name" : "inspect",
 963       "desc" : "inspect selected file",
 964       "memberOf" : "Roo.bootstrap.DocumentManager",
 965       "example" : "",
 966       "deprecated" : "",
 967       "since" : "",
 968       "see" : "",
 969       "params" : [
 970         {
 971           "name" : "this",
 972           "type" : "Roo.bootstrap.DocumentManager",
 973           "desc" : "",
 974           "isOptional" : false
 975         },
 976         {
 977           "name" : "file",
 978           "type" : "File",
 979           "desc" : "",
 980           "isOptional" : false
 981         }
 982       ],
 983       "returns" : []
 984     },
 985     {
 986       "name" : "initial",
 987       "desc" : "Fire when initial the DocumentManager",
 988       "memberOf" : "Roo.bootstrap.DocumentManager",
 989       "example" : "",
 990       "deprecated" : "",
 991       "since" : "",
 992       "see" : "",
 993       "params" : [
 994         {
 995           "name" : "this",
 996           "type" : "Roo.bootstrap.DocumentManager",
 997           "desc" : "",
 998           "isOptional" : false
 999         }
1000       ],
1001       "returns" : []
1002     },
1003     {
1004       "name" : "exception",
1005       "desc" : "Fire when xhr load exception",
1006       "memberOf" : "Roo.bootstrap.DocumentManager",
1007       "example" : "",
1008       "deprecated" : "",
1009       "since" : "",
1010       "see" : "",
1011       "params" : [
1012         {
1013           "name" : "this",
1014           "type" : "Roo.bootstrap.DocumentManager",
1015           "desc" : "",
1016           "isOptional" : false
1017         },
1018         {
1019           "name" : "xhr",
1020           "type" : "XMLHttpRequest",
1021           "desc" : "",
1022           "isOptional" : false
1023         }
1024       ],
1025       "returns" : []
1026     },
1027     {
1028       "name" : "prepare",
1029       "desc" : "prepare the form data",
1030       "memberOf" : "Roo.bootstrap.DocumentManager",
1031       "example" : "",
1032       "deprecated" : "",
1033       "since" : "",
1034       "see" : "",
1035       "params" : [
1036         {
1037           "name" : "this",
1038           "type" : "Roo.bootstrap.DocumentManager",
1039           "desc" : "",
1040           "isOptional" : false
1041         },
1042         {
1043           "name" : "formData",
1044           "type" : "Object",
1045           "desc" : "",
1046           "isOptional" : false
1047         }
1048       ],
1049       "returns" : []
1050     },
1051     {
1052       "name" : "click",
1053       "desc" : "Fire after click the image",
1054       "memberOf" : "Roo.bootstrap.DocumentManager",
1055       "example" : "",
1056       "deprecated" : "",
1057       "since" : "",
1058       "see" : "",
1059       "params" : [
1060         {
1061           "name" : "this",
1062           "type" : "Roo.bootstrap.DocumentManager",
1063           "desc" : "",
1064           "isOptional" : false
1065         },
1066         {
1067           "name" : "file",
1068           "type" : "Object",
1069           "desc" : "",
1070           "isOptional" : false
1071         }
1072       ],
1073       "returns" : []
1074     },
1075     {
1076       "name" : "edit",
1077       "desc" : "Fire when upload a image and editable set to true",
1078       "memberOf" : "Roo.bootstrap.DocumentManager",
1079       "example" : "",
1080       "deprecated" : "",
1081       "since" : "",
1082       "see" : "",
1083       "params" : [
1084         {
1085           "name" : "this",
1086           "type" : "Roo.bootstrap.DocumentManager",
1087           "desc" : "",
1088           "isOptional" : false
1089         },
1090         {
1091           "name" : "file",
1092           "type" : "Object",
1093           "desc" : "",
1094           "isOptional" : false
1095         }
1096       ],
1097       "returns" : []
1098     },
1099     {
1100       "name" : "previewrendered",
1101       "desc" : "Fire when preview rendered",
1102       "memberOf" : "Roo.bootstrap.DocumentManager",
1103       "example" : "",
1104       "deprecated" : "",
1105       "since" : "",
1106       "see" : "",
1107       "params" : [
1108         {
1109           "name" : "this",
1110           "type" : "Roo.bootstrap.DocumentManager",
1111           "desc" : "",
1112           "isOptional" : false
1113         },
1114         {
1115           "name" : "file",
1116           "type" : "Object",
1117           "desc" : "",
1118           "isOptional" : false
1119         }
1120       ],
1121       "returns" : []
1122     },
1123     {
1124       "name" : "childrenrendered",
1125       "desc" : "Fires when the children have been rendered..",
1126       "memberOf" : "Roo.bootstrap.Component",
1127       "example" : "",
1128       "deprecated" : "",
1129       "since" : "",
1130       "see" : "",
1131       "params" : [
1132         {
1133           "name" : "this",
1134           "type" : "Roo.bootstrap.Component",
1135           "desc" : "",
1136           "isOptional" : false
1137         }
1138       ],
1139       "returns" : []
1140     },
1141     {
1142       "name" : "beforerender",
1143       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1144       "memberOf" : "Roo.Component",
1145       "example" : "",
1146       "deprecated" : "",
1147       "since" : "",
1148       "see" : "",
1149       "params" : [
1150         {
1151           "name" : "this",
1152           "type" : "Roo.Component",
1153           "desc" : "",
1154           "isOptional" : false
1155         }
1156       ],
1157       "returns" : []
1158     },
1159     {
1160       "name" : "disable",
1161       "desc" : "Fires after the component is disabled.",
1162       "memberOf" : "Roo.Component",
1163       "example" : "",
1164       "deprecated" : "",
1165       "since" : "",
1166       "see" : "",
1167       "params" : [
1168         {
1169           "name" : "this",
1170           "type" : "Roo.Component",
1171           "desc" : "",
1172           "isOptional" : false
1173         }
1174       ],
1175       "returns" : []
1176     },
1177     {
1178       "name" : "render",
1179       "desc" : "Fires after the component is rendered.",
1180       "memberOf" : "Roo.Component",
1181       "example" : "",
1182       "deprecated" : "",
1183       "since" : "",
1184       "see" : "",
1185       "params" : [
1186         {
1187           "name" : "this",
1188           "type" : "Roo.Component",
1189           "desc" : "",
1190           "isOptional" : false
1191         }
1192       ],
1193       "returns" : []
1194     },
1195     {
1196       "name" : "destroy",
1197       "desc" : "Fires after the component is destroyed.",
1198       "memberOf" : "Roo.Component",
1199       "example" : "",
1200       "deprecated" : "",
1201       "since" : "",
1202       "see" : "",
1203       "params" : [
1204         {
1205           "name" : "this",
1206           "type" : "Roo.Component",
1207           "desc" : "",
1208           "isOptional" : false
1209         }
1210       ],
1211       "returns" : []
1212     },
1213     {
1214       "name" : "hide",
1215       "desc" : "Fires after the component is hidden.",
1216       "memberOf" : "Roo.Component",
1217       "example" : "",
1218       "deprecated" : "",
1219       "since" : "",
1220       "see" : "",
1221       "params" : [
1222         {
1223           "name" : "this",
1224           "type" : "Roo.Component",
1225           "desc" : "",
1226           "isOptional" : false
1227         }
1228       ],
1229       "returns" : []
1230     },
1231     {
1232       "name" : "beforehide",
1233       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1234       "memberOf" : "Roo.Component",
1235       "example" : "",
1236       "deprecated" : "",
1237       "since" : "",
1238       "see" : "",
1239       "params" : [
1240         {
1241           "name" : "this",
1242           "type" : "Roo.Component",
1243           "desc" : "",
1244           "isOptional" : false
1245         }
1246       ],
1247       "returns" : []
1248     },
1249     {
1250       "name" : "show",
1251       "desc" : "Fires after the component is shown.",
1252       "memberOf" : "Roo.Component",
1253       "example" : "",
1254       "deprecated" : "",
1255       "since" : "",
1256       "see" : "",
1257       "params" : [
1258         {
1259           "name" : "this",
1260           "type" : "Roo.Component",
1261           "desc" : "",
1262           "isOptional" : false
1263         }
1264       ],
1265       "returns" : []
1266     },
1267     {
1268       "name" : "beforeshow",
1269       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1270       "memberOf" : "Roo.Component",
1271       "example" : "",
1272       "deprecated" : "",
1273       "since" : "",
1274       "see" : "",
1275       "params" : [
1276         {
1277           "name" : "this",
1278           "type" : "Roo.Component",
1279           "desc" : "",
1280           "isOptional" : false
1281         }
1282       ],
1283       "returns" : []
1284     },
1285     {
1286       "name" : "enable",
1287       "desc" : "Fires after the component is enabled.",
1288       "memberOf" : "Roo.Component",
1289       "example" : "",
1290       "deprecated" : "",
1291       "since" : "",
1292       "see" : "",
1293       "params" : [
1294         {
1295           "name" : "this",
1296           "type" : "Roo.Component",
1297           "desc" : "",
1298           "isOptional" : false
1299         }
1300       ],
1301       "returns" : []
1302     },
1303     {
1304       "name" : "beforedestroy",
1305       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1306       "memberOf" : "Roo.Component",
1307       "example" : "",
1308       "deprecated" : "",
1309       "since" : "",
1310       "see" : "",
1311       "params" : [
1312         {
1313           "name" : "this",
1314           "type" : "Roo.Component",
1315           "desc" : "",
1316           "isOptional" : false
1317         }
1318       ],
1319       "returns" : []
1320     }
1321   ]
1322 }