1 /**
2 * This file Copyright (c) 2013-2014 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 com.vaadin.data.util.ObjectProperty;
38
39 /**
40 * Basic implementation of an {@link ObjectProperty} .<br>
41 * This base property delegate to the {@link Transformer} the read and write of the value used by the field.<br>
42 *
43 * @param <T>.
44 */
45 public class TransformedProperty<T> extends ObjectProperty<T> {
46
47 private final Transformer<T> transformer;
48
49 /**
50 * Creates a new instance of TransformedProperty with the given transformer.<br>
51 * The super {@link ObjectProperty} is initialized with: <br>
52 * - value = {@link Transformer#readFromItem()} in order to get the Item property value,
53 * - type = {@link Transformer#getType()}, the type of the value.
54 *
55 * @param transformer
56 * the relate Property {@link Transformer}.
57 */
58 public TransformedProperty(Transformer<T> transformer) {
59 super(transformer.readFromItem(), transformer.getType());
60 this.transformer = transformer;
61 }
62
63 @Override
64 public void setValue(T newValue) throws com.vaadin.data.Property.ReadOnlyException {
65 super.setValue(newValue);
66 if (transformer != null) {
67 transformer.writeToItem(newValue);
68 }
69 }
70
71 @Override
72 public T getValue() {
73 return super.getValue();
74 }
75
76 /**
77 * @return true if the handler support I18N.
78 */
79 public boolean hasI18NSupport() {
80 return transformer.hasI18NSupport();
81 }
82
83 /**
84 * In case of i18n change, Reload the Value returned by the Handler.
85 */
86 public void fireI18NValueChange() {
87 setValue(transformer.readFromItem());
88 super.fireValueChange();
89 }
90
91 public Transformer<T> getTransformer() {
92 return this.transformer;
93 }
94 }