View Javadoc
1   /**
2    * This file Copyright (c) 2013-2015 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.form.field.factory;
35  
36  import info.magnolia.cms.i18n.I18nContentSupport;
37  import info.magnolia.objectfactory.ComponentProvider;
38  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
39  import info.magnolia.ui.form.field.CompositeField;
40  import info.magnolia.ui.form.field.definition.CompositeFieldDefinition;
41  import info.magnolia.ui.form.field.transformer.Transformer;
42  
43  import java.util.List;
44  
45  import javax.inject.Inject;
46  
47  import com.vaadin.data.Item;
48  import com.vaadin.data.util.PropertysetItem;
49  import com.vaadin.ui.Field;
50  
51  /**
52   * Factory used to initialize a {@link CompositeField}.
53   *
54   * @param <D> the field definition type — has to inherit from {@link CompositeFieldDefinition}.
55   */
56  public class CompositeFieldFactory<D extends CompositeFieldDefinition> extends AbstractFieldFactory<D, PropertysetItem> {
57  
58      private FieldFactoryFactory fieldFactoryFactory;
59      private ComponentProvider componentProvider;
60      private final I18NAuthoringSupport i18nAuthoringSupport;
61  
62      @Inject
63      public CompositeFieldFactory(D definition, Item relatedFieldItem, FieldFactoryFactory fieldFactoryFactory, ComponentProvider componentProvider, I18NAuthoringSupport i18nAuthoringSupport) {
64          super(definition, relatedFieldItem);
65          this.fieldFactoryFactory = fieldFactoryFactory;
66          this.componentProvider = componentProvider;
67          this.i18nAuthoringSupport = i18nAuthoringSupport;
68      }
69  
70      /**
71       * @deprecated since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
72       */
73      @Deprecated
74      public CompositeFieldFactory(D definition, Item relatedFieldItem, FieldFactoryFactory fieldFactoryFactory, I18nContentSupport i18nContentSupport, ComponentProvider componentProvider) {
75          this(definition, relatedFieldItem, fieldFactoryFactory, componentProvider, componentProvider.getComponent(I18NAuthoringSupport.class));
76      }
77  
78      @Override
79      protected Field<PropertysetItem> createFieldComponent() {
80          // FIXME change i18n setting : MGNLUI-1548
81          definition.setI18nBasename(getMessages().getBasename());
82  
83          CompositeField field = new CompositeField(definition, fieldFactoryFactory, componentProvider, item, i18nAuthoringSupport);
84          return field;
85      }
86  
87      /**
88       * Create a new Instance of {@link Transformer}.
89       */
90      @Override
91      protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass) {
92          List<String> propertyNames = definition.getFieldsName();
93          return this.componentProvider.newInstance(transformerClass, item, definition, PropertysetItem.class, propertyNames);
94      }
95  }