View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.framework.layout;
35  
36  import static java.util.stream.Collectors.toList;
37  
38  import info.magnolia.objectfactory.ComponentProvider;
39  import info.magnolia.objectfactory.Components;
40  import info.magnolia.ui.field.EditorPropertyDefinition;
41  import info.magnolia.ui.field.NamedFieldDefinition;
42  
43  import java.util.Collections;
44  import java.util.Map;
45  
46  import javax.inject.Inject;
47  
48  import com.vaadin.ui.Component;
49  
50  /**
51   * Does not require any explicit layout definition in config,
52   * simply takes the property list and creates a single-tab-layout out of them.
53   */
54  public class SingleTabLayoutProducer implements FieldLayoutProducer<SingleTabLayoutProducer.Definition> {
55  
56      private TabbedLayoutProducer delegate;
57  
58      @Inject
59      public SingleTabLayoutProducer(ComponentProvider componentProvider) {
60          this.delegate = componentProvider.newInstance(TabbedLayoutProducer.class);
61      }
62  
63      /**
64       * @deprecated since 6.2.1. Use {@link #SingleTabLayoutProducer(info.magnolia.objectfactory.ComponentProvider)} instead.
65       */
66      @Deprecated
67      public SingleTabLayoutProducer() {
68          this(Components.getComponentProvider());
69      }
70  
71      @Override
72      public Component createLayout(Definition definition, Map<EditorPropertyDefinition, Component> mappings) {
73          ConfiguredTabDefinitionguredTabDefinition.html#ConfiguredTabDefinition">ConfiguredTabDefinition tab = new ConfiguredTabDefinition();
74          tab.setName("");
75          tab.setFields(mappings.keySet().stream()
76                  .map(def -> (NamedFieldDefinition) def::getName)
77                  .collect(toList()));
78  
79          TabbedLayoutDefinitionhtml#TabbedLayoutDefinition">TabbedLayoutDefinition tabbedLayoutDefinition = new TabbedLayoutDefinition();
80          tabbedLayoutDefinition.setTabs(Collections.singletonList(tab));
81  
82          return delegate.createLayout(tabbedLayoutDefinition, mappings);
83      }
84  
85      public static class Definition extends ConfiguredFieldLayoutDefinition<SingleTabLayoutProducer> {
86  
87          public Definition() {
88              setImplementationClass(SingleTabLayoutProducer.class);
89          }
90      }
91  }