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.composite;
35
36 import info.magnolia.annotation.deprecation.MgnlDeprecated;
37
38 import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
39 import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
40
41 import java.util.Collection;
42 import java.util.List;
43
44 import org.apache.commons.lang3.StringUtils;
45
46 import com.vaadin.v7.data.Item;
47 import com.vaadin.v7.data.util.PropertysetItem;
48
49 /**
50 * Default switchable field {@link info.magnolia.ui.form.field.transformer.Transformer} implementation storing and retrieving SwitchableField informations as {@link PropertysetItem}.<br>
51 * Storing strategy: <br>
52 * - property (definition.getName()) : contain the last selected field name <br>
53 * - property (propertyPrefix + first field name): contain the value of the first field <br>
54 * - property (propertyPrefix + second field name): contain the value of the second field <br>
55 * ...<br>
56 * @deprecated since 6.2.3. Use new framework and {@link info.magnolia.ui.field.WithPropertyNameDecorator.PropertyNameDecorator} instead.
57 */
58 @Deprecated
59 @MgnlDeprecated(since = "6.2.3.", description = "Use new framework and PropertyNameDecorator instead.")
60 public class SwitchableTransformer extends CompositeTransformer {
61
62 /**
63 * @deprecated since 5.4.2 - use {@link #SwitchableTransformer(Item, ConfiguredFieldDefinition, Class, List, I18NAuthoringSupport)} instead.
64 */
65 @Deprecated
66 public SwitchableTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type, List<String> fieldsName) {
67 super(relatedFormItem, definition, type, fieldsName);
68 }
69
70 public SwitchableTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type, List<String> fieldsName, I18NAuthoringSupport i18NAuthoringSupport) {
71 super(relatedFormItem, definition, type, fieldsName, i18NAuthoringSupport);
72 }
73
74 @Override
75 public void writeToItem(PropertysetItem newValues) {
76 // Alter newsValues to clear all data that not belong to selections
77 String currentSelection = (String) newValues.getItemProperty(propertyPrefix).getValue();
78
79 // Get iterator.
80 Collection<String> propertyNames = (Collection<String>) newValues.getItemPropertyIds();
81 for (String propertyName : propertyNames) {
82
83 String compositePropertyName = getCompositePropertyName(propertyName);
84 if (!propertyName.equals(currentSelection) && !propertyName.equals(propertyPrefix)) {
85 relatedFormItem.removeItemProperty(compositePropertyName);
86 } else {
87 if (newValues.getItemProperty(propertyName) != null) {
88 relatedFormItem.addItemProperty(compositePropertyName, newValues.getItemProperty(propertyName));
89 }
90 }
91 }
92 }
93
94 @Override
95 public PropertysetItem readFromItem() {
96 return super.readFromItem();
97 }
98
99 @Override
100 protected String getCompositePropertyName(String propertyName) {
101 if (StringUtils.equals(propertyName, propertyPrefix)) {
102 propertyName = StringUtils.EMPTY;
103 }
104 return super.getCompositePropertyName(propertyName);
105 }
106 }