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  
42  import javax.inject.Inject;
43  
44  import com.vaadin.ui.ComboBox;
45  
46  
47  /**
48   * Creates and initializes a ComboBox selection field based on its field definition.
49   * @param <T> type of select option
50   *
51   */
52  public class ComboBoxFieldFactory<T, D extends ComboBoxFieldDefinition<T>> extends AbstractSelectFieldFactory<D, T> {
53  
54      @Inject
55      public ComboBoxFieldFactory(D definition, ComponentProvider componentProvider, SelectFieldSupport<T> selectFieldSupport) {
56          super(definition, componentProvider, selectFieldSupport);
57      }
58  
59      @Override
60      protected ComboBox<T> createFieldComponent() {
61          final ComboBox<T> select = new ComboBox<>();
62          select.setScrollToSelectedItem(getDefinition().isScrollToSelectedItem());
63          select.setEmptySelectionAllowed(getDefinition().isEmptySelectionAllowed());
64          select.setTextInputAllowed(getDefinition().isTextInputAllowed());
65          select.setPopupWidth(getDefinition().getPopWidth());
66          select.setEmptySelectionCaption(getDefinition().getEmptySelectionCaption());
67          select.setPlaceholder(getDefinition().getPlaceholder());
68          select.setPageLength(getDefinition().getPageLength());
69          select.setNewItemProvider(Optional.ofNullable(getDefinition().getNewItemProviderClass())
70                  .map(aClass -> componentProvider.newInstance(aClass))
71                  .orElse(null)
72          );
73          return select;
74      }
75  
76  }