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.factory;
35
36 import info.magnolia.objectfactory.ComponentProvider;
37 import info.magnolia.ui.field.FieldDefinition;
38
39 import javax.inject.Inject;
40
41 import org.apache.commons.lang3.StringUtils;
42
43 import com.vaadin.data.HasValue;
44 import com.vaadin.server.Sizeable;
45 import com.vaadin.ui.Component;
46
47
48 /**
49 * Abstract FieldFactory implementations.
50 *
51 * @param <D>
52 * definition type
53 * @param <T>
54 * field value type
55 */
56 public abstract class AbstractFieldFactory<T, D extends FieldDefinition<T>> implements FieldFactory<T> {
57
58 protected final D definition;
59 protected final ComponentProvider componentProvider;
60
61 @Inject
62 public AbstractFieldFactory(D definition, ComponentProvider componentProvider) {
63 this.definition = definition;
64 this.componentProvider = componentProvider;
65 }
66
67 @Override
68 public HasValue<T> createField() {
69 // Create the Vaadin field
70 Component field = createFieldComponent();
71
72 if (StringUtils.isNotBlank(getDefinition().getStyleName())) {
73 field.addStyleName(getDefinition().getStyleName());
74 }
75
76 field.setWidth(100, Sizeable.Unit.PERCENTAGE);
77 field.setCaption(getDefinition().getLabel());
78
79 if (!(field instanceof HasValue)) {
80 throw new IllegalStateException("[" + getClass().getSimpleName() + "] produced something other than a HasValue instance");
81 }
82
83 HasValue<T> hasValue = (HasValue<T>) field;
84 hasValue.setRequiredIndicatorVisible(getDefinition().isRequired());
85 hasValue.setReadOnly(getDefinition().isReadOnly());
86
87 return hasValue;
88 }
89
90 protected abstract Component createFieldComponent();
91
92 protected D getDefinition() {
93 return definition;
94 }
95
96 /**
97 * Field factories may use this method to check whether an @i18nText config property has an actual translation, or is a generated key.
98 * <p>By default, if no translation is found, these properties contain the longest key to provide such a translation.
99 *
100 * @return true if the given string contains dots, does not end with a dot, and does not contain spaces
101 */
102 protected boolean isMessageKey(String key) {
103 return !StringUtils.endsWith(key, ".") && StringUtils.contains(key, ".") && !StringUtils.contains(key, " ");
104 }
105 }