1 /**
2 * This file Copyright (c) 2020 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.editor;
35
36 import info.magnolia.ui.field.ConfiguredComplexPropertyDefinition;
37 import info.magnolia.ui.field.FieldValidatorDefinition;
38 import info.magnolia.ui.field.UploadField;
39 import info.magnolia.ui.field.UploadFieldDefinition;
40 import info.magnolia.ui.field.ValueBoundProperty;
41 import info.magnolia.ui.field.factory.AbstractFieldFactory;
42 import info.magnolia.ui.field.factory.UploadFieldFactory;
43
44 import java.io.File;
45 import java.util.Collections;
46 import java.util.List;
47
48 import com.vaadin.data.Converter;
49
50 import lombok.Getter;
51 import lombok.Setter;
52
53 /**
54 * Definition for {@link UploadView}.
55 *
56 * @param <T> item type.
57 */
58 @Getter
59 @Setter
60 public class UploadViewDefinition<T> extends ConfiguredComplexPropertyDefinition<T> implements
61 EditorDefinition<T>, ComplexPropertyDefinition<T>, ValueBoundProperty<File> {
62
63 /**
64 * Use this field to plugin any custom implementation of the {@link UploadField}.
65 */
66 private Class<? extends AbstractFieldFactory<File, ? extends UploadFieldDefinition>> factoryClass = UploadFieldFactory.class;
67
68 /**
69 * Makes the field mandatory.
70 */
71 private boolean required;
72
73 /**
74 * Error message text displayed in case of required = true.
75 */
76 private String requiredErrorMessage;
77 private boolean readOnly;
78 private String conversionErrorMessage;
79 private List<FieldValidatorDefinition> validators = Collections.emptyList();
80 private Class<? extends Converter<File, ?>> converterClass;
81 private File defaultValue;
82
83 public UploadViewDefinition() {
84 setImplementationClass((Class) UploadView.class);
85 }
86
87 @Override
88 public EditorDefinition<T> getEditorDefinition() {
89 return this;
90 }
91
92 @Override
93 public Class<File> getType() {
94 return File.class;
95 }
96 }