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.event.EventBus;
37  import info.magnolia.i18nsystem.SimpleTranslator;
38  import info.magnolia.objectfactory.ComponentProvider;
39  import info.magnolia.objectfactory.Components;
40  import info.magnolia.ui.api.context.UiContext;
41  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
42  import info.magnolia.ui.form.field.definition.BasicUploadFieldDefinition;
43  import info.magnolia.ui.form.field.transformer.Transformer;
44  import info.magnolia.ui.form.field.upload.UploadReceiver;
45  import info.magnolia.ui.form.field.upload.basic.BasicUploadField;
46  import info.magnolia.ui.form.field.upload.basic.ResurfaceBasicUploadField;
47  import info.magnolia.ui.framework.ioc.AdmincentralFlavour;
48  import info.magnolia.ui.imageprovider.ImageProvider;
49  
50  import javax.inject.Inject;
51  
52  import com.vaadin.v7.data.Item;
53  import com.vaadin.v7.ui.Field;
54  
55  /**
56   * Creates and configures a {@link BasicUploadField}.
57   *
58   * @deprecated since 6.2 - use {@link info.magnolia.ui.field.factory.UploadFieldFactory} instead.
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 BasicUploadFieldFactory extends AbstractFieldFactory<BasicUploadFieldDefinition, UploadReceiver> {
64  
65      private final ImageProvider imageProvider;
66      private final UiContext uiContext;
67      private final SimpleTranslator i18n;
68      private final ComponentProvider componentProvider;
69  
70      @Inject
71      public BasicUploadFieldFactory(BasicUploadFieldDefinition definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18NAuthoringSupport, ImageProvider imageProvider, SimpleTranslator i18n, ComponentProvider componentProvider) {
72          super(definition, relatedFieldItem, uiContext, i18NAuthoringSupport);
73          this.imageProvider = imageProvider;
74          this.uiContext = uiContext;
75          this.i18n = i18n;
76          this.componentProvider = componentProvider;
77      }
78  
79      /**
80       * @deprecated since 5.4.5. Use {@link #BasicUploadFieldFactory(BasicUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, SimpleTranslator, ComponentProvider)} instead.
81       */
82      @Deprecated
83      public BasicUploadFieldFactory(BasicUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, UiContext uiContext, SimpleTranslator i18n, ComponentProvider componentProvider, EventBus admincentralEventBus) {
84          this(definition, relatedFieldItem, uiContext, Components.getComponent(I18NAuthoringSupport.class), imageProvider, i18n, componentProvider);
85      }
86  
87      /**
88       * @deprecated since 5.4.3. Use {@link #BasicUploadFieldFactory(BasicUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, SimpleTranslator, ComponentProvider)} instead.
89       */
90      @Deprecated
91      public BasicUploadFieldFactory(BasicUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, UiContext uiContext, SimpleTranslator i18n, ComponentProvider componentProvider) {
92          this(definition, relatedFieldItem, uiContext, Components.getComponent(I18NAuthoringSupport.class), imageProvider, i18n, componentProvider);
93      }
94  
95      @Override
96      protected Field<UploadReceiver> createFieldComponent() {
97          if (AdmincentralFlavour.get().isM5()) {
98              return new BasicUploadField<>(imageProvider, uiContext, definition, i18n);
99          } else {
100             return new ResurfaceBasicUploadField<>(imageProvider, uiContext, definition, i18n);
101         }
102     }
103 
104     /**
105      * Initialize the transformer.
106      */
107     @Override
108     protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass) {
109         return this.componentProvider.newInstance(transformerClass, item, definition, UploadReceiver.class);
110     }
111 }