View Javadoc
1   /**
2    * This file Copyright (c) 2020 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.editor;
35  
36  import info.magnolia.objectfactory.ComponentProvider;
37  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
38  import info.magnolia.ui.field.AlwaysEmptyPrefixNameDecorator;
39  import info.magnolia.ui.field.ConfiguredComplexPropertyDefinition;
40  import info.magnolia.ui.field.EditorPropertyDefinition;
41  import info.magnolia.ui.field.MultiFieldDefinition;
42  
43  import java.util.Collections;
44  import java.util.Locale;
45  import java.util.Optional;
46  
47  import javax.inject.Inject;
48  import javax.jcr.Node;
49  
50  /**
51   * This class modifies {@link info.magnolia.ui.editor.ByIndexedChildNodes} to provide resolve nodes with lexicographically sortable names of length 2,
52   *  * i.e. 00, 01, 00_de, ....
53   *
54   * @deprecated since 6.2.1, use {@link info.magnolia.ui.editor.ByIndexedChildNodes}. This class is for compatibility
55   * use only to compensate compatibility UI {@link MultiValueSubChildrenNodePropertiesTransformer} behaviour.
56   */
57  @Deprecated
58  public class ByLexicographicallyIndexedChildNodes extends ByIndexedChildNodes {
59  
60      private final MultiFieldDefinition<Node> relatedPropertyDefinition;
61  
62      @Inject
63      public ByLexicographicallyIndexedChildNodes(ByLexicographicallyIndexedChildNodes.Definition definition, MultiFieldDefinition<Node> relatedPropertyDefinition, I18NAuthoringSupport<Node> i18NAuthoringSupport, ComponentProvider componentProvider, Locale locale) {
64          super(definition, relatedPropertyDefinition, i18NAuthoringSupport, componentProvider, locale);
65          this.relatedPropertyDefinition = relatedPropertyDefinition;
66      }
67  
68      @Override
69      protected Optional<EditorDefinition<Node>> resolveEntryEditorDefinition(Node item, int index) {
70          EditorPropertyDefinition field = this.relatedPropertyDefinition.getField();
71          if (field instanceof EditorDefinition) {
72              return Optional.of((EditorDefinition<Node>) field);
73          }
74  
75          String indexedName = String.format("%s%02d", field.getName(), index);
76          ConfiguredFormDefinition<Node> wrapper = new ConfiguredFormDefinition<>();
77          wrapper.setName(indexedName);
78          wrapper.setProperties(Collections.singletonList(field));
79  
80          return Optional.of(wrapper);
81      }
82  
83      @Override
84      protected Optional<ConfiguredComplexPropertyDefinition<Node>> resolvePropertyDefinition(Node item, int index) {
85          return resolveEntryEditorDefinition(item, index)
86                  .map(entryEditorDefinition -> {
87                      ConfiguredComplexPropertyDefinition<Node> property = new ConfiguredComplexPropertyDefinition.Wrapper<>(entryEditorDefinition);
88                      ItemProviderDefinition<Node, Node> indexedItemProvider = resolveItemProvider(index);
89                      property.setItemProvider(indexedItemProvider);
90                      return property;
91                  });
92      }
93  
94      private LexicographicallyIndexedChildNodeProvider.Definition resolveItemProvider(int index) {
95          LexicographicallyIndexedChildNodeProvider.Definition indexedItemProvider = new LexicographicallyIndexedChildNodeProvider.Definition();
96  
97          indexedItemProvider.setIndex(index);
98          indexedItemProvider.setNodeName(getEntryPropertyNameBase());
99  
100         return indexedItemProvider;
101     }
102 
103     /**
104      * Definition of {@link ByLexicographicallyIndexedChildNodes}.
105      *
106      * @deprecated since 6.2.1
107      */
108     @Deprecated
109     public static class Definition extends ByIndexedChildNodes.Definition {
110 
111         public Definition() {
112             setPropertyNameDecorator(AlwaysEmptyPrefixNameDecorator.class);
113             setImplementationClass(ByLexicographicallyIndexedChildNodes.class);
114         }
115     }
116 }