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.optionlist;
35  
36  import info.magnolia.ui.field.FieldDefinition;
37  import info.magnolia.ui.field.SelectFieldSupport;
38  
39  import java.util.Optional;
40  
41  import javax.inject.Inject;
42  
43  import org.apache.commons.lang3.StringUtils;
44  
45  import com.vaadin.data.Converter;
46  import com.vaadin.data.provider.DataProvider;
47  import com.vaadin.server.ExternalResource;
48  import com.vaadin.ui.IconGenerator;
49  import com.vaadin.ui.ItemCaptionGenerator;
50  
51  /**
52   * {@link SelectFieldSupport} implementation based on {@link OptionListDefinition}.
53   */
54  public class OptionSelectFieldSupport implements SelectFieldSupport<Option> {
55  
56      private final FieldDefinition fieldDefinition;
57      private final OptionListDefinition optionListDefinition;
58  
59      @Inject
60      public OptionSelectFieldSupport(FieldDefinition fieldDefinition, OptionListDefinition optionListDefinition) {
61          this.fieldDefinition = fieldDefinition;
62          this.optionListDefinition = optionListDefinition;
63      }
64  
65      @Override
66      public DataProvider<Option, ?> getDataProvider() {
67          return new OptionListProvider(optionListDefinition);
68      }
69  
70      @Override
71      public ItemCaptionGenerator<Option> getItemCaptionGenerator() {
72          return option -> StringUtils.defaultIfBlank(option.getLabel(), option.getName());
73      }
74  
75      @Override
76      public IconGenerator<Option> getIconGenerator() {
77          return optionDef -> Optional.ofNullable(optionDef.getIconSrc()).map(ExternalResource::new).orElse(null);
78      }
79  
80      @Override
81      public Converter<Option, String> defaultConverter() {
82          return new OptionToModelTypeConverter<>(fieldDefinition, optionListDefinition);
83      }
84  }