1 /**
2 * This file Copyright (c) 2014-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.composite;
35
36 import info.magnolia.objectfactory.Components;
37 import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
38 import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
39 import info.magnolia.ui.form.field.transformer.basic.BasicTransformer;
40
41 import java.util.List;
42
43 import javax.inject.Inject;
44
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
47
48 import com.vaadin.v7.data.Item;
49 import com.vaadin.v7.data.util.ObjectProperty;
50 import com.vaadin.v7.data.util.PropertysetItem;
51
52 /**
53 * This delegating {@link info.magnolia.ui.form.field.transformer.Transformer Transformer} is dedicated to the {@link info.magnolia.ui.form.field.CompositeField CompositeField} and {@link info.magnolia.ui.form.field.SwitchableField SwitchableField};
54 * it simply delegates property handling to the configured sub-fields.
55 * <p>
56 * Therefore, sub-fields use their own transformers to store the field value; e.g. with {@link BasicTransformer} properties are named after their respective {@link info.magnolia.ui.form.field.definition.FieldDefinition#getName()}.
57 */
58 public class DelegatingCompositeFieldTransformer extends BasicTransformer<PropertysetItem> {
59 private static final Logger log = LoggerFactory.getLogger(DelegatingCompositeFieldTransformer.class);
60 protected List<String> fieldsName;
61 private PropertysetItem items;
62
63 /**
64 * @deprecated since 5.4.2 - use {@link #DelegatingCompositeFieldTransformer(Item, ConfiguredFieldDefinition, Class, List, I18NAuthoringSupport)} instead.
65 */
66 @Deprecated
67 public DelegatingCompositeFieldTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type, List<String> fieldsName) {
68 this(relatedFormItem, definition, type, fieldsName, Components.getComponent(I18NAuthoringSupport.class));
69 }
70
71 @Inject
72 public DelegatingCompositeFieldTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type, List<String> fieldsName, I18NAuthoringSupport i18NAuthoringSupport) {
73 super(relatedFormItem, definition, type, i18NAuthoringSupport);
74 this.fieldsName = fieldsName;
75 }
76 /**
77 * This transformer's write implementation is empty. We do not need to write to the item as this is delegated to the sub-fields.
78 */
79 @Override
80 public void writeToItem(PropertysetItem newValue) {
81 log.debug("CALL writeToItem");
82 }
83
84 /**
85 * Returns a representation of the child items as a {@link PropertysetItem};
86 * this is merely a map whose keys are the configured names of the sub-fields, and whose values are the child items, wrapped as {@link ObjectProperty ObjectProperties}.
87 */
88 @Override
89 public PropertysetItem readFromItem() {
90 // Only read it once
91 if (items != null) {
92 return items;
93 }
94 items = new PropertysetItem();
95 for (String fieldName : fieldsName) {
96 items.addItemProperty(fieldName, new ObjectProperty<Item>(relatedFormItem));
97 }
98 return items;
99 }
100 }