1 /**
2 * This file Copyright (c) 2012-2014 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.form.field.definition;
35
36 import info.magnolia.i18nsystem.I18nable;
37 import info.magnolia.ui.form.field.transformer.Transformer;
38 import info.magnolia.ui.form.validator.definition.FieldValidatorDefinition;
39 import info.magnolia.i18nsystem.I18nText;
40
41 import java.util.List;
42
43 import com.vaadin.data.util.converter.Converter;
44
45 /**
46 * Defines a field within a dialog.
47 *
48 * @see FieldDefinition
49 * @see FieldValidatorDefinition
50 */
51 @I18nable(keyGenerator = FieldDefinitionKeyGenerator.class)
52 public interface FieldDefinition {
53
54 /**
55 * Determines the name of the data property where the value entered by the user is stored.
56 */
57 String getName();
58
59 /**
60 * Makes the field mandatory.
61 */
62 boolean isRequired();
63
64 /**
65 * Error message text displayed in case of required = true.
66 */
67 @I18nText
68 String getRequiredErrorMessage();
69
70 /**
71 * The type of this field when stored in a JCR repository expressed as a JCR property type name.
72 *
73 * @see javax.jcr.PropertyType
74 */
75 String getType();
76
77 /**
78 * Text displayed as field label.
79 */
80 @I18nText
81 String getLabel();
82
83 /**
84 * Message bundle for localized field labels.
85 */
86 String getI18nBasename();
87
88 /**
89 * Description displayed to the user when clicking on the Info Button.
90 */
91 @I18nText
92 String getDescription();
93
94 /**
95 * Pre-filled value displayed in the field. The value can be overwritten by the user.
96 */
97 String getDefaultValue();
98
99 /**
100 * Determines if a Field Property can be changed.
101 */
102 boolean isReadOnly();
103
104 /**
105 * Enables i18n authoring support.
106 * This allows authors to write foreign language or regionally targeted content.
107 * A two-letter language identifier (en, ge, fr etc.) is displayed on controls
108 * where i18n is set to true.
109 */
110 boolean isI18n();
111
112 /**
113 * Define a specific Field styleName. This style definition will be added to the Field Style by calling
114 * AbstractComponent.addStyleName.
115 */
116 String getStyleName();
117
118 List<FieldValidatorDefinition> getValidators();
119
120 Class<? extends Transformer<?>> getTransformerClass();
121
122 Class<? extends Converter<?, ?>> getConverterClass();
123 }