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.ComboBoxFieldDefinition;
38  import info.magnolia.ui.field.SelectFieldSupport;
39  
40  import java.util.Optional;
41  import java.util.stream.Stream;
42  
43  import javax.inject.Inject;
44  
45  import com.vaadin.data.provider.AbstractDataProvider;
46  import com.vaadin.data.provider.DataProvider;
47  import com.vaadin.data.provider.Query;
48  import com.vaadin.ui.ComboBox;
49  
50  
51  /**
52   * Creates and initializes a ComboBox selection field based on its field definition.
53   * @param <T> type of select option
54   *
55   */
56  public class ComboBoxFieldFactory<T, D extends ComboBoxFieldDefinition<T>> extends AbstractSelectFieldFactory<D, T> {
57  
58      @Inject
59      public ComboBoxFieldFactory(D definition, ComponentProvider componentProvider, SelectFieldSupport<T> selectFieldSupport) {
60          super(definition, componentProvider, selectFieldSupport);
61      }
62  
63      @Override
64      protected ComboBox<T> createFieldComponent() {
65          final ComboBox<T> select = new ComboBox<>();
66          select.addAttachListener(event -> {
67              if (!select.isEnabled()) {
68                  select.setDataProvider(EmptyDataProvider.getInstance());
69              }
70          });
71          select.setScrollToSelectedItem(getDefinition().isScrollToSelectedItem());
72          select.setEmptySelectionAllowed(getDefinition().isEmptySelectionAllowed());
73          select.setTextInputAllowed(getDefinition().isTextInputAllowed());
74          select.setPopupWidth(getDefinition().getPopWidth());
75          select.setEmptySelectionCaption(getDefinition().getEmptySelectionCaption());
76          select.setPlaceholder(getDefinition().getPlaceholder());
77          select.setPageLength(getDefinition().getPageLength());
78          select.setNewItemProvider(Optional.ofNullable(getDefinition().getNewItemProviderClass())
79                  .map(aClass -> componentProvider.newInstance(aClass))
80                  .orElse(null)
81          );
82          return select;
83      }
84  
85      @Override
86      protected DataProvider<T, String> getDataProvider() {
87          return getDefinition().isReadOnly() ? EmptyDataProvider.getInstance() : super.getDataProvider();
88      }
89  
90      static class EmptyDataProvider<T> extends AbstractDataProvider<T, String> {
91  
92          private static final EmptyDataProvider<?> INSTANCE = new EmptyDataProvider<>();
93  
94          @Override
95          public boolean isInMemory() {
96              return true;
97          }
98  
99          @Override
100         public int size(Query<T, String> query) {
101             return 0;
102         }
103 
104         @Override
105         public Stream<T> fetch(Query<T, String> query) {
106             return Stream.empty();
107         }
108 
109         public static <T> EmptyDataProvider<T> getInstance() {
110             return (EmptyDataProvider<T>) INSTANCE;
111         }
112     }
113 }