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