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.config.NamedDefinition;
37 import info.magnolia.ui.editor.i18n.EditorPropertyDefinitionKeyGenerator;
38 import info.magnolia.i18nsystem.I18nText;
39 import info.magnolia.i18nsystem.I18nable;
40
41 /**
42 * Editor property definition. Typically used in forms to perform CRUD operations on data sets.
43 */
44 @I18nable(keyGenerator = EditorPropertyDefinitionKeyGenerator.class)
45 public interface EditorPropertyDefinition extends NamedDefinition {
46
47 /**
48 * Text displayed as field label.
49 */
50 @I18nText
51 String getLabel();
52
53 /**
54 * Description displayed to the user when clicking on the info button.
55 */
56 @I18nText(fallback = "")
57 String getDescription();
58
59 /**
60 * Additional style for a field.
61 */
62 String getStyleName();
63
64 /**
65 * Enables i18n authoring support.
66 * This allows authors to write foreign language or regionally targeted content.
67 * A two-letter language identifier (en, de, fr etc.) is displayed on controls
68 * where i18n is set to true.
69 */
70 boolean isI18n();
71 }