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