View Javadoc
1   /**
2    * This file Copyright (c) 2021 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.ui.datasource.ItemResolver;
37  
38  import java.util.Optional;
39  
40  import javax.inject.Inject;
41  
42  import com.vaadin.ui.TextField;
43  
44  
45  /**
46   * A custom field displaying a text field and a button for bringing up a component enabling to choose an item.
47   */
48  public class TextLinkField<T> extends AbstractLinkField<String, T> {
49  
50      static final String READ_ONLY = "linkfield-readonly";
51  
52      private final ItemResolver<T> itemResolver;
53      private final TextField innerComponent;
54  
55      @Inject
56      TextLinkField(ItemResolver<T> itemResolver, TextField innerComponent) {
57          super(innerComponent);
58          this.innerComponent = innerComponent;
59          this.itemResolver = itemResolver;
60      }
61  
62      @Override
63      protected void doSetValue(String value) {
64          super.doSetValue(Optional.ofNullable(value).orElseGet(this::getEmptyValue));
65      }
66  
67      @Override
68      public Optional<T> getSelectedItem() {
69          return getOptionalValue()
70                  .flatMap(itemResolver::getItemById);
71      }
72  
73      @Override
74      public void setSelectedItem(T item) {
75          setValue(itemResolver.getId(item));
76      }
77  
78      @Override
79      public void setReadOnly(boolean readOnly) {
80          super.setReadOnly(readOnly);
81          innerComponent.setReadOnly(readOnly);
82          handleReadOnlyStyle(readOnly);
83      }
84  
85      private void handleReadOnlyStyle(boolean readOnly) {
86          if (readOnly) {
87              innerComponent.addStyleName(READ_ONLY);
88          } else {
89              innerComponent.removeStyleName(READ_ONLY);
90          }
91      }
92  }