1 /**
2 * This file Copyright (c) 2019 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.datasource.enumeration;
35
36 import info.magnolia.i18nsystem.SimpleTranslator;
37 import info.magnolia.ui.field.SelectFieldSupport;
38
39 import javax.inject.Inject;
40
41 import com.vaadin.data.Converter;
42 import com.vaadin.data.provider.DataProvider;
43 import com.vaadin.ui.IconGenerator;
44 import com.vaadin.ui.ItemCaptionGenerator;
45
46 /**
47 * Support for select fields backed by enumeration types.
48 *
49 * @param <T>
50 * enum type
51 */
52 public class EnumSelectFieldSupport<T extends Enum<T>> implements SelectFieldSupport<T> {
53
54 private final EnumDatasourceDefinition datasourceDefinition;
55 private final SimpleTranslator i18n;
56
57 @Inject
58 protected EnumSelectFieldSupport(EnumDatasourceDefinition datasourceDefinition, SimpleTranslator i18n) {
59 this.datasourceDefinition = datasourceDefinition;
60 this.i18n = i18n;
61 }
62
63 @Override
64 public DataProvider<T, ?> getDataProvider() {
65 return new EnumDataProvider(datasourceDefinition);
66 }
67
68 @Override
69 public ItemCaptionGenerator<T> getItemCaptionGenerator() {
70 return this::translateFromFQN;
71 }
72
73 private String translateFromFQN(T t) {
74 final String i18nKey = String.format("%s.%s", t.getClass().getName(), t.name())
75 .replace("$", ".")
76 .toLowerCase();
77 final String translatedText = i18n.translate(i18nKey);
78 return i18nKey.equals(translatedText) ? t.name() : translatedText;
79 }
80
81 @Override
82 public IconGenerator<T> getIconGenerator() {
83 return enumEntry -> null;
84 }
85
86 @Override
87 public Converter<T, String> defaultConverter() {
88 throw new UnsupportedOperationException("Linking to enums is not supported");
89 }
90 }