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.framework.databinding.layout;
35  
36  import com.vaadin.ui.FormLayout;
37  import com.vaadin.ui.TabSheet;
38  import com.vaadin.ui.themes.ValoTheme;
39  
40  import java.util.Map;
41  
42  import org.apache.commons.lang3.StringUtils;
43  import org.slf4j.Logger;
44  import org.slf4j.LoggerFactory;
45  
46  import com.vaadin.ui.Component;
47  
48  /**
49   * Produces a tab layout.
50   * @see TabbedLayoutDefinition
51   */
52  public class TabbedLayoutProducer implements LayoutProducer<TabbedLayoutDefinition> {
53      private static final Logger log = LoggerFactory.getLogger(TabbedLayoutProducer.class);
54      @Override
55      public Component createLayout(TabbedLayoutDefinition definition, Map<String, Component> mappings) {
56          TabSheet tabSheetComponent = new TabSheet();
57          tabSheetComponent.addStyleName(ValoTheme.TABSHEET_FRAMED);
58          tabSheetComponent.setSizeFull();
59  
60          if (definition.getTabs().size() == 1) {
61              tabSheetComponent.addStyleName("single-tab");
62          }
63  
64          definition.getTabs().forEach(tabDefinition -> {
65              FormLayout formSection = new FormLayout();
66              formSection.setMargin(true);
67              formSection.setSizeFull();
68              tabDefinition.getFields().forEach(field -> {
69                  final Component fieldComponent = mappings.get(field.getName());
70                  if (fieldComponent != null) {
71                      formSection.addComponent(fieldComponent);
72                      // TODO formSection.setComponentHelpDescription(fieldComponent, fieldComponent.getDescription());
73                  } else {
74                      log.warn(String.format("Could not retrieve component field named %s from mappings", field.getName()));
75                  }
76              });
77              tabSheetComponent.addTab(formSection, StringUtils.defaultIfBlank(tabDefinition.getLabel(), tabDefinition.getName()));
78  
79          });
80          return tabSheetComponent;
81      }
82  }