View Javadoc
1   /**
2    * This file Copyright (c) 2019-2021 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.EditorPropertyDefinition;
39  import info.magnolia.ui.field.MultiFieldDefinition;
40  import info.magnolia.ui.framework.layout.SingleFieldLayoutProducer;
41  
42  import java.util.Collections;
43  import java.util.Locale;
44  import java.util.Optional;
45  
46  import javax.inject.Inject;
47  import javax.jcr.Node;
48  
49  /**
50   * Implementation of {@link ByIndexedChildNodes} which uses a pre-configured entry definition
51   * coming from the property definition.
52   */
53  public class MultiFieldEntryResolution extends ByIndexedChildNodes {
54  
55      private final MultiFieldDefinition<Node> relatedPropertyDefinition;
56  
57      @Inject
58      public MultiFieldEntryResolution(Definition definition, MultiFieldDefinition<Node> relatedPropertyDefinition, I18NAuthoringSupport<Node> i18NAuthoringSupport, ComponentProvider componentProvider, Locale locale) {
59          super(definition, relatedPropertyDefinition, i18NAuthoringSupport, componentProvider, locale);
60          this.relatedPropertyDefinition = relatedPropertyDefinition;
61      }
62  
63      protected Optional<EditorDefinition<Node>> resolveEntryEditorDefinition(Node item, int index) {
64          EditorPropertyDefinition field = getRelatedFieldDefinition();
65          if (field instanceof EditorDefinition) {
66              return Optional.of((EditorDefinition<Node>) field);
67          }
68  
69          ConfiguredFormDefinition<Node> wrapper = new ConfiguredFormDefinition<>();
70          wrapper.setName(field.getName());
71          wrapper.setLayout(new SingleFieldLayoutProducer.Definition());
72          wrapper.setProperties(Collections.singletonList(field));
73  
74          return Optional.of(wrapper);
75      }
76  
77      protected EditorPropertyDefinition getRelatedFieldDefinition() {
78          return this.relatedPropertyDefinition.getField();
79      }
80  
81      /**
82       * Definition of {@link MultiFieldEntryResolution}.
83       */
84      public static class Definition extends ByIndexedChildNodes.Definition {
85  
86          public Definition() {
87              setImplementationClass(MultiFieldEntryResolution.class);
88          }
89      }
90  }