1 /**
2 * This file Copyright (c) 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 info.magnolia.ui.form.FormDefinition;
37 import info.magnolia.ui.framework.databinding.validator.FieldValidatorDefinition;
38 import info.magnolia.i18nsystem.I18nText;
39
40 import java.util.List;
41
42 import com.vaadin.data.Converter;
43
44 /**
45 * Defines a field within a form.
46 * @param <T> item type.
47 *
48 * @see FormDefinition
49 * @see FieldValidatorDefinition
50 *
51 */
52 public interface FieldDefinition<T> extends EditorPropertyDefinition {
53
54 /**
55 * Makes the field mandatory.
56 */
57 boolean isRequired();
58
59 /**
60 * Error message text displayed in case of required = true.
61 */
62 @I18nText
63 String getRequiredErrorMessage();
64
65 /**
66 * The type of this field, i.e. the model type. This needs to be the fully qualified Java class name representing
67 * the type, e.g. java.lang.Long or my.custom.Foo
68 **/
69 Class<T> getType();
70
71 /**
72 * Pre-filled value displayed in the field. The value can be overwritten by the user.
73 */
74 T getDefaultValue();
75
76 /**
77 * Determines if a Field Property can be changed.
78 */
79 boolean isReadOnly();
80
81 List<FieldValidatorDefinition> getValidators();
82
83 /**
84 * Converts the model type returned by {@link #getType()} into a presentation type, in case the two differ.
85 * For instance, a text field will likely use String but the model may be a Long. The converter will then handle
86 * the conversion between those two types.
87 *
88 * @see #getType
89 * @see Converter
90 */
91 Class<? extends Converter<?, T>> getConverterClass();
92
93 /**
94 * Message text displayed in case of conversion error.
95 */
96 @I18nText
97 String getConversionErrorMessage();
98
99 /**
100 * Enables i18n authoring support.
101 * This allows authors to write foreign language or regionally targeted content.
102 * A two-letter language identifier (en, de, fr etc.) is displayed on controls
103 * where i18n is set to true.
104 */
105 boolean isI18n();
106
107 }