View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.form.field.factory;
35  
36  import info.magnolia.cms.i18n.I18nContentSupport;
37  import info.magnolia.objectfactory.ComponentProvider;
38  import info.magnolia.ui.api.context.UiContext;
39  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
40  import info.magnolia.ui.form.field.MultiField;
41  import info.magnolia.ui.form.field.definition.MultiValueFieldDefinition;
42  import info.magnolia.ui.form.field.transformer.Transformer;
43  import info.magnolia.ui.form.field.transformer.multi.DelegatingMultiValueFieldTransformer;
44  
45  import javax.inject.Inject;
46  
47  import com.vaadin.v7.data.Item;
48  import com.vaadin.v7.data.util.PropertysetItem;
49  import com.vaadin.v7.ui.Field;
50  
51  /**
52   * Creates a {@linkplain MultiField multi-value field} based on a {@link MultiValueFieldDefinition}.
53   *
54   * <p>The {@link MultiField} supports adding/removing entries of a sub-field definition.
55   *
56   * @param <D> definition type
57   *
58   * @deprecated since 6.2 - without direct replacement.
59   *
60   * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
61   */
62  @Deprecated
63  public class MultiValueFieldFactory<D extends MultiValueFieldDefinition> extends AbstractFieldFactory<D, PropertysetItem> {
64  
65      private FieldFactoryFactory fieldFactoryFactory;
66      private ComponentProvider componentProvider;
67      private I18NAuthoringSupport i18nAuthoringSupport;
68  
69      @Inject
70      public MultiValueFieldFactory(D definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18nAuthoringSupport, FieldFactoryFactory fieldFactoryFactory, ComponentProvider componentProvider) {
71          super(definition, relatedFieldItem, uiContext, i18nAuthoringSupport);
72          this.fieldFactoryFactory = fieldFactoryFactory;
73          this.componentProvider = componentProvider;
74          this.i18nAuthoringSupport = i18nAuthoringSupport;
75      }
76  
77      /**
78       * @deprecated since 5.4.7 - use {@link #MultiValueFieldFactory(MultiValueFieldDefinition, Item, UiContext, I18NAuthoringSupport, FieldFactoryFactory, ComponentProvider)} instead.
79       */
80      @Deprecated
81      public MultiValueFieldFactory(D definition, Item relatedFieldItem, FieldFactoryFactory fieldFactoryFactory, ComponentProvider componentProvider, I18NAuthoringSupport i18nAuthoringSupport) {
82          this(definition, relatedFieldItem, null, i18nAuthoringSupport, fieldFactoryFactory, componentProvider);
83      }
84  
85      /**
86       * @deprecated since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
87       */
88      @Deprecated
89      public MultiValueFieldFactory(D definition, Item relatedFieldItem, FieldFactoryFactory fieldFactoryFactory, I18nContentSupport i18nContentSupport, ComponentProvider componentProvider) {
90          this(definition, relatedFieldItem, null, componentProvider.getComponent(I18NAuthoringSupport.class), fieldFactoryFactory, componentProvider);
91      }
92  
93      @Override
94      protected Field<PropertysetItem> createFieldComponent() {
95          MultiFieldld/MultiField.html#MultiField">MultiField field = new MultiField(definition, fieldFactoryFactory, componentProvider, item, i18nAuthoringSupport);
96          // Set Caption
97          field.setButtonCaptionAdd(definition.getButtonSelectAddLabel());
98          field.setButtonCaptionRemove(definition.getButtonSelectRemoveLabel());
99          boolean isUnOrderable = DelegatingMultiValueFieldTransformer.class.isAssignableFrom(definition.getTransformerClass());
100         field.setOrderable(!isUnOrderable);
101 
102         return field;
103     }
104 
105     /**
106      * Create a new Instance of {@link Transformer}.
107      */
108     @Override
109     protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass) {
110         Transformer<?> transformer = this.componentProvider.newInstance(transformerClass, item, definition, PropertysetItem.class);
111         transformer.setLocale(getLocale());
112         return transformer;
113     }
114 }