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