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