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.datasource.enumeration;
35  
36  import info.magnolia.ui.field.SelectFieldSupport;
37  
38  import javax.inject.Inject;
39  
40  import com.vaadin.data.Converter;
41  import com.vaadin.data.provider.DataProvider;
42  import com.vaadin.ui.IconGenerator;
43  import com.vaadin.ui.ItemCaptionGenerator;
44  
45  /**
46   * Support for select fields backed by enumeration types.
47   *
48   * @param <T>
49   *     enum type
50   */
51  public class EnumSelectFieldSupport<T extends Enum<T>> implements SelectFieldSupport<T> {
52  
53      private final EnumDatasourceDefinition datasourceDefinition;
54  
55      @Inject
56      public EnumSelectFieldSupport(EnumDatasourceDefinition datasourceDefinition) {
57          this.datasourceDefinition = datasourceDefinition;
58      }
59  
60      @Override
61      public DataProvider<T, ?> getDataProvider() {
62          return new EnumDataProvider(datasourceDefinition);
63      }
64  
65      @Override
66      public ItemCaptionGenerator<T> getItemCaptionGenerator() {
67          return Enum::name;
68      }
69  
70      @Override
71      public IconGenerator<T> getIconGenerator() {
72          return enumEntry -> null;
73      }
74  
75      @Override
76      public Converter<T, String> defaultConverter() {
77          throw new UnsupportedOperationException("Linking to enums is not supported");
78      }
79  }