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.ui.api.ioc.UiContextScoped;
37 import info.magnolia.ui.field.FieldDefinition;
38 import info.magnolia.ui.field.FieldFactory;
39 import info.magnolia.ui.framework.ioc.UiContextBoundComponentProvider;
40
41 import java.util.Optional;
42
43 import javax.inject.Inject;
44
45 import org.slf4j.Logger;
46 import org.slf4j.LoggerFactory;
47
48 import com.vaadin.data.HasValue;
49
50 /**
51 * Produces a Vaadin field based on its definition.
52 */
53 @UiContextScoped
54 public class FormFieldFactory {
55
56 private static final Logger log = LoggerFactory.getLogger(FormFieldFactory.class);
57
58 private final UiContextBoundComponentProvider parentComponentProvider;
59
60 @Inject
61 public FormFieldFactory(UiContextBoundComponentProvider parentComponentProvider) {
62 this.parentComponentProvider = parentComponentProvider;
63 }
64
65 /**
66 * Based on the {@link FieldDefinition}, get the related {@link FieldFactory} initialized with the input parameters.
67 *
68 * @return related {@link FieldFactory} or null in case of exception or if no related factory is defined.
69 */
70 public <TYPE, FIELD extends HasValue<TYPE>> FIELD createField(FieldDefinition<TYPE> definition, Object... parameters) {
71 return (FIELD) createFieldFactory(definition, parameters).createField();
72 }
73
74 public <TYPE> FieldFactory<TYPE> createFieldFactory(FieldDefinition<TYPE> definition, Object... parameters) {
75 Class<? extends FieldFactory<TYPE>> factoryClass = definition.getFactoryClass();
76 if (factoryClass == null) {
77 log.warn("No factory class set for definition class [{}]. Please check your configuration.", definition.getClass().getName());
78 return null;
79 }
80
81 Object[] combinedParameters = new Object[parameters.length + 1];
82 combinedParameters[0] = definition;
83 System.arraycopy(parameters, 0, combinedParameters, 1, parameters.length);
84
85 return parentComponentProvider
86 .inChildContext(Optional.ofNullable(definition.getName()).orElse("no-name"), definition)
87 .newInstance(factoryClass, combinedParameters);
88 }
89 }