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.field.factory;
35  
36  import info.magnolia.objectfactory.ComponentProvider;
37  import info.magnolia.ui.field.FieldDefinition;
38  import info.magnolia.ui.field.FieldFactory;
39  
40  import javax.inject.Inject;
41  
42  import org.apache.commons.lang3.StringUtils;
43  
44  import com.vaadin.data.HasValue;
45  import com.vaadin.server.Sizeable;
46  import com.vaadin.ui.Component;
47  
48  
49  /**
50   * Abstract FieldFactory implementations.
51   *
52   * @param <D>
53   *     definition type
54   * @param <T>
55   *     field value type
56   */
57  public abstract class AbstractFieldFactory<T, D extends FieldDefinition<T>> implements FieldFactory<T> {
58  
59      protected final D definition;
60      protected final ComponentProvider componentProvider;
61  
62      @Inject
63      public AbstractFieldFactory(D definition, ComponentProvider componentProvider) {
64          this.definition = definition;
65          this.componentProvider = componentProvider;
66      }
67  
68      @Override
69      public HasValue<T> createField() {
70          // Create the Vaadin field
71          Component field = createFieldComponent();
72  
73          if (StringUtils.isNotBlank(getDefinition().getStyleName())) {
74              field.addStyleName(getDefinition().getStyleName());
75          }
76  
77          field.setWidth(100, Sizeable.Unit.PERCENTAGE);
78          field.setCaption(getDefinition().getLabel());
79  
80          if (!(field instanceof HasValue)) {
81              throw new IllegalStateException("[" + getClass().getSimpleName() + "] produced something other than a HasValue instance");
82          }
83  
84          HasValue<T> hasValue = (HasValue<T>) field;
85          hasValue.setRequiredIndicatorVisible(getDefinition().isRequired());
86          hasValue.setReadOnly(getDefinition().isReadOnly());
87  
88          return hasValue;
89      }
90  
91      protected abstract Component createFieldComponent();
92  
93      protected D getDefinition() {
94          return definition;
95      }
96  }