View Javadoc
1   /**
2    * This file Copyright (c) 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.multi;
35  
36  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
37  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
38  
39  import java.util.List;
40  
41  import com.vaadin.v7.data.Item;
42  import com.vaadin.v7.data.util.PropertysetItem;
43  
44  /**
45   * This delegating {@link info.magnolia.ui.form.field.transformer.Transformer Transformer} is dedicated to the {@link info.magnolia.ui.form.field.MultiField MultiField};
46   * it considers entries as child nodes and delegates property handling to their respective sub-fields.
47   * <p>
48   * <ul>
49   * <li>rootItem (relatedFormItem)
50   * <ul>
51   * <li>childNode (suffixed by language if i18n is enabled)<br>
52   * <ul>
53   * <li>0 (first entry of the MultiField)<br>
54   * <li>1 (second entry of the MultiField)<br>
55   * <li>...
56   * </ul>
57   * </ul>
58   * </ul>
59   */
60  public class DelegatingMultiValueChildNodeWithLocaleTransformer extends DelegatingMultiValueSubnodeTransformer {
61  
62      public DelegatingMultiValueChildNodeWithLocaleTransformer(Item relatedFormItem, ConfiguredFieldDefinition definition, Class<PropertysetItem> type, I18NAuthoringSupport i18NAuthoringSupport) {
63          super(relatedFormItem, definition, type, i18NAuthoringSupport);
64      }
65  
66      @Override
67      protected String createNewItemName() {
68          int increment = 0;
69          final List<String> childItemNames = getChildItemNames();
70          String name;
71          do {
72              name = String.format("%s%d", subItemBaseName, increment);
73              ++increment;
74          } while (childItemNames.contains(name));
75          return name;
76      }
77  
78      @Override
79      protected String childItemRegexRepresentation() {
80          return incrementRegexRepresentation();
81      }
82  
83      @Override
84      protected String getChildNodeName() {
85          return deriveLocaleAwareName(definition.getName());
86      }
87  }