1 /**
2 * This file Copyright (c) 2013-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.transformer;
35
36
37 import org.slf4j.Logger;
38 import org.slf4j.LoggerFactory;
39
40 import com.vaadin.v7.data.util.ObjectProperty;
41
42 /**
43 * Basic implementation of an {@link ObjectProperty} .<br>
44 * This base property delegate to the {@link Transformer} the read and write of the value used by the field.<br>
45 *
46 * @param <T>.
47 */
48 public class TransformedProperty<T> extends ObjectProperty<T> {
49
50 private static final Logger log = LoggerFactory.getLogger(TransformedProperty.class);
51
52 private final Transformer<T> transformer;
53
54 /**
55 * Creates a new instance of TransformedProperty with the given transformer.<br>
56 * The super {@link ObjectProperty} is initialized with: <br>
57 * - value = {@link Transformer#readFromItem()} in order to get the Item property value,
58 * - type = {@link Transformer#getType()}, the type of the value.
59 *
60 * @param transformer
61 * the relate Property {@link Transformer}.
62 */
63 public TransformedProperty(Transformer<T> transformer) {
64 super(transformer.readFromItem(), transformer.getType());
65 this.transformer = transformer;
66 }
67
68 @Override
69 public void setValue(T newValue) throws com.vaadin.v7.data.Property.ReadOnlyException {
70 super.setValue(newValue);
71 if (transformer != null) {
72 transformer.writeToItem(newValue);
73 }
74 }
75
76 @Override
77 public boolean isReadOnly() {
78 return super.isReadOnly() || (transformer != null && transformer.isReadOnly());
79 }
80
81 public Transformer<T> getTransformer() {
82 return this.transformer;
83 }
84
85 /**
86 * @return true if the transformer supports I18N.
87 *
88 * @deprecated since 5.4.2 without replacement, {@link TransformedProperty} should not care of i18n on its own.
89 */
90 @Deprecated
91 public boolean hasI18NSupport() {
92 return transformer.hasI18NSupport();
93 }
94
95 /**
96 * In case of i18n change, Reload the Value returned by the Handler.
97 *
98 * @deprecated since 5.4.2 without replacement, {@link TransformedProperty} should not care of i18n on its own.
99 */
100 @Deprecated
101 public void fireI18NValueChange() {
102 log.warn("TransformedProperty.fireI18NValueChange() is deprecated since 5.4.2 without replacement, it has no effect any longer and should never be called.");
103 }
104 }