View Javadoc
1   /**
2    * This file Copyright (c) 2010-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;
35  
36  import info.magnolia.i18nsystem.I18nText;
37  import info.magnolia.ui.field.factory.ComboBoxFieldFactory;
38  import info.magnolia.ui.datasource.DatasourceDefinition;
39  
40  import com.vaadin.ui.ComboBox;
41  
42  import lombok.Getter;
43  import lombok.Setter;
44  
45  /**
46   * ComboBox definition class, a single select component.
47   * @param <T> item type.
48   *
49   */
50  @Getter
51  @Setter
52  @FieldType("comboBoxField")
53  public class ComboBoxFieldDefinition<T> extends AbstractSelectFieldDefinition<T, DatasourceDefinition> {
54  
55      private boolean textInputAllowed;
56  
57      private int pageLength = 0;
58  
59      private String emptySelectionCaption;
60  
61      private boolean emptySelectionAllowed;
62  
63      private boolean scrollToSelectedItem;
64  
65      private String popWidth;
66  
67      private String placeholder;
68  
69      private Class<? extends ComboBox.NewItemProvider<T>> newItemProviderClass;
70  
71      public ComboBoxFieldDefinition() {
72          setFactoryClass((Class)ComboBoxFieldFactory.class);
73      }
74  
75      @I18nText
76      public String getPlaceholder() {
77          return placeholder;
78      }
79  
80      @I18nText
81      public String getEmptySelectionCaption() {
82          return emptySelectionCaption;
83      }
84  }