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.contentapp.configuration.column.component;
35  
36  import info.magnolia.ui.contentapp.configuration.column.ColumnEditorDefinition;
37  import info.magnolia.ui.contentapp.configuration.column.ConfiguredColumnDefinition;
38  import info.magnolia.ui.field.FieldDefinition;
39  import info.magnolia.ui.field.factory.FieldFactory;
40  import info.magnolia.ui.framework.ioc.UiContextBoundComponentProvider;
41  
42  import java.util.Optional;
43  
44  import com.vaadin.data.Converter;
45  import com.vaadin.data.HasValue;
46  import com.vaadin.data.Result;
47  import com.vaadin.data.ValueContext;
48  import com.vaadin.data.ValueProvider;
49  import com.vaadin.ui.Component;
50  import com.vaadin.ui.renderers.ComponentRenderer;
51  
52  import lombok.AllArgsConstructor;
53  
54  /**
55   * Defines a column that displays a component.
56   */
57  public class ColumnComponentDefinition<T> extends ConfiguredColumnDefinition<T> {
58  
59      public ColumnComponentDefinition() {
60          setRenderer(ComponentRenderer.class);
61          setValueProvider((Class) ComponentValueProvider.class);
62      }
63  
64      /**
65       * Provides a value for a given column component.
66       *
67       * @param <S>
68       *     source value type.
69       */
70      public static class ComponentValueProvider<S> implements ValueProvider<Object, Component> {
71  
72          private final ColumnComponentDefinition<S> componentDefinition;
73          private final ValueProvider<Object, S> wrapped;
74          private final UiContextBoundComponentProvider componentProvider;
75  
76          public ComponentValueProvider(ColumnComponentDefinition<S> componentDefinition, ValueProvider<Object, S> wrapped, UiContextBoundComponentProvider componentProvider) {
77              this.componentDefinition = componentDefinition;
78              this.wrapped = wrapped;
79              this.componentProvider = componentProvider;
80          }
81  
82          @Override
83          public Component apply(Object item) {
84              return Optional.ofNullable(componentDefinition.getEditor()).map(ColumnEditorDefinition::getField).map((FieldDefinition<S> fieldDefinition) -> {
85                  FieldFactory<S> fieldFactory = componentProvider.inChildContext(fieldDefinition).newInstance(fieldDefinition.getFactoryClass());
86                  HasValue<S> field = fieldFactory.createField();
87                  Component asComponent = (Component) field;
88                  asComponent.setEnabled(false);
89                  S value = wrapped.apply(item);
90                  if (value != null) {
91                      field.setValue(value);
92                  }
93                  return asComponent;
94              }).orElse(null);
95          }
96  
97          /**
98           * Vaadin converter implementation which translates between a pre-set component
99           * and an arbitrary value.
100          */
101         @AllArgsConstructor
102         public static class ComponentConverter implements Converter<Object, Object> {
103 
104             private HasValue value;
105 
106             @Override
107             public Result<Object> convertToModel(Object value, ValueContext context) {
108                 return Result.ok(this.value);
109             }
110 
111             @Override
112             public Object convertToPresentation(Object value, ValueContext context) {
113                 return value;
114             }
115         }
116     }
117 }