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.LinkField;
38  import info.magnolia.ui.field.LinkFieldDefinition;
39  import info.magnolia.ui.form.ItemPreviewDefinition;
40  import info.magnolia.ui.framework.component.ItemPreviewComponent;
41  import info.magnolia.ui.framework.datasource.components.ItemResolver;
42  import info.magnolia.ui.framework.overlay.ChooserController;
43  import info.magnolia.ui.framework.overlay.ChooserController.ChooseResult;
44  
45  import java.util.Optional;
46  
47  import javax.inject.Inject;
48  
49  import com.vaadin.ui.Component;
50  
51  /**
52   * Creates and initializes a {@link LinkField} field based on a {@link LinkFieldDefinition}.
53   *
54   * @param <D> the type of link field definition.
55   */
56  public class LinkFieldFactory<T, D extends LinkFieldDefinition<T>> extends AbstractFieldFactory<String, D> {
57  
58      private final ChooserController chooserController;
59      private final ItemResolver<T> itemResolver;
60  
61      @Inject
62      public LinkFieldFactory(D definition, ComponentProvider componentProvider, ItemResolver<T> itemResolver, ChooserController chooserController) {
63          super(definition, componentProvider);
64          this.itemResolver = itemResolver;
65  
66          if (definition.getChooser() == null) {
67             throw new IllegalArgumentException("Could not find a chooser dialog definition at LinkField definition " + definition.getName());
68          }
69  
70          this.chooserController = chooserController;
71      }
72  
73      @Override
74      protected Component createFieldComponent() {
75          LinkFieldd.html#LinkField">LinkField linkField = new LinkField();
76  
77          Optional.ofNullable(getDefinition().getPlaceholder()).filter(p -> !isMessageKey(p)).ifPresent(linkField::setPlaceholder);
78  
79          linkField.setButtonCaptionNew(getDefinition().getButtonSelectNewLabel());
80          linkField.setButtonCaptionOther(getDefinition().getButtonSelectOtherLabel());
81          linkField.setEditable(getDefinition().isEditable());
82          linkField.setDisableOnClick(true);
83          linkField.addClickListener(event -> chooserController.openChooser(getDefinition().getChooser(), null)
84                  .whenComplete((ChooseResult<T> result, Throwable err) -> {
85  
86                      linkField.setEnabled(true);
87  
88                      if (err != null) {
89                          throw new RuntimeException(err);
90                      }
91  
92                      result.getChoice()
93                              .map(itemResolver::getPath)
94                              .ifPresent(linkField::setValue);
95                  }));
96  
97          newItemPreviewComponent().ifPresent(itemPreviewComponent -> {
98              linkField.addValueChangeListener(event ->
99                      itemResolver.getItemByPath(event.getValue()).ifPresent(item -> {
100                         itemPreviewComponent.onValueChange(item);
101                         itemPreviewComponent.setVisible(event.getValue() != null);
102                     }));
103             linkField.setContentPreview(itemPreviewComponent);
104         });
105 
106         return linkField;
107     }
108 
109     protected Optional<? extends ItemPreviewComponent<T>> newItemPreviewComponent() {
110         return Optional.ofNullable(getDefinition().getPreview())
111                 .map(ItemPreviewDefinition::getImplementationClass)
112                 .map(clazz -> componentProvider.newInstance(clazz));
113     }
114 
115 }