View Javadoc

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.composite;
35  
36  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
37  
38  import java.util.List;
39  
40  import org.apache.commons.lang3.StringUtils;
41  
42  import com.vaadin.data.Item;
43  import com.vaadin.data.util.PropertysetItem;
44  
45  /**
46   * Default switchable field {@link info.magnolia.ui.form.field.transformer.Transformer} implementation storing and retrieving SwitchableField informations as {@link PropertysetItem}.<br>
47   * Storing strategy: <br>
48   * - property (definition.getName()) : contain the last selected field name <br>
49   * - property (propertyPrefix + first field name): contain the value of the first field <br>
50   * - property (propertyPrefix + second field name): contain the value of the second field <br>
51   * ...<br>
52   */
53  public class SwitchableTransformer extends CompositeTransformer {
54  
55      public SwitchableTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type, List<String> fieldsName) {
56          super(relatedFormItem, definition, type, fieldsName);
57      }
58  
59      @Override
60      public void writeToItem(PropertysetItem newValues) {
61          super.writeToItem(newValues);
62      }
63  
64      @Override
65      public PropertysetItem readFromItem() {
66          return super.readFromItem();
67      }
68  
69      @Override
70      protected String getCompositePropertyName(String propertyName) {
71          if (StringUtils.equals(propertyName, propertyPrefix)) {
72              propertyName = StringUtils.EMPTY;
73          }
74          return super.getCompositePropertyName(propertyName);
75      }
76  }