1 /**
2 * This file Copyright (c) 2011-2018 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.field;
35
36 import java.util.ArrayList;
37 import java.util.List;
38
39 import com.vaadin.data.Converter;
40
41 import lombok.Getter;
42 import lombok.Setter;
43
44 /**
45 * Describes a field in a dialog.
46 * @param <T> item type.
47 */
48 @Getter
49 @Setter
50 public class ConfiguredFieldDefinition<T> implements FieldDefinition<T> {
51
52 private String name;
53
54 private String label;
55
56 private boolean i18n = false;
57
58 private String description;
59
60 /**
61 * By default returns either a String or a Set (of String) depending on whether the definition is for a single or a multi select field.
62 * Should the field type be explicitly set, it will prevail over the default.
63 */
64 private Class<?> type = String.class;
65
66 private boolean required = false; // Not relevant for checkbox
67
68 private String requiredErrorMessage = "validation.message.required";
69
70 private String conversionErrorMessage = "conversion.message.error";
71
72 private boolean readOnly = false;
73
74 private T defaultValue;
75
76 private String styleName;
77
78 private List<FieldValidatorDefinition> validators = new ArrayList<>();
79
80 private Class<? extends Converter<T, ?>> converterClass;
81
82 private Class<? extends FieldFactory<T>> factoryClass;
83
84 private Class<? extends FieldBinder<T>> fieldBinderClass = (Class) FieldBinder.Default.class;
85 }