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