View Javadoc
1   /**
2    * This file Copyright (c) 2013-2017 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.imageprovider.ImageProvider;
47  
48  import javax.inject.Inject;
49  
50  import com.vaadin.data.Item;
51  import com.vaadin.ui.Field;
52  
53  /**
54   * Creates and configures a {@link BasicUploadField}.
55   */
56  public class BasicUploadFieldFactory extends AbstractFieldFactory<BasicUploadFieldDefinition, UploadReceiver> {
57  
58      private final ImageProvider imageProvider;
59      private final UiContext uiContext;
60      private final SimpleTranslator i18n;
61      private final ComponentProvider componentProvider;
62  
63      @Inject
64      public BasicUploadFieldFactory(BasicUploadFieldDefinition definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18NAuthoringSupport, ImageProvider imageProvider, SimpleTranslator i18n, ComponentProvider componentProvider) {
65          super(definition, relatedFieldItem, uiContext, i18NAuthoringSupport);
66          this.imageProvider = imageProvider;
67          this.uiContext = uiContext;
68          this.i18n = i18n;
69          this.componentProvider = componentProvider;
70      }
71  
72      /**
73       * @deprecated since 5.4.5. Use {@link #BasicUploadFieldFactory(BasicUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, SimpleTranslator, ComponentProvider)} instead.
74       */
75      @Deprecated
76      public BasicUploadFieldFactory(BasicUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, UiContext uiContext, SimpleTranslator i18n, ComponentProvider componentProvider, EventBus admincentralEventBus) {
77          this(definition, relatedFieldItem, uiContext, Components.getComponent(I18NAuthoringSupport.class), imageProvider, i18n, componentProvider);
78      }
79  
80      /**
81       * @deprecated since 5.4.3. Use {@link #BasicUploadFieldFactory(BasicUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, SimpleTranslator, ComponentProvider)} instead.
82       */
83      @Deprecated
84      public BasicUploadFieldFactory(BasicUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, UiContext uiContext, SimpleTranslator i18n, ComponentProvider componentProvider) {
85          this(definition, relatedFieldItem, uiContext, Components.getComponent(I18NAuthoringSupport.class), imageProvider, i18n, componentProvider);
86      }
87  
88      @Override
89      protected Field<UploadReceiver> createFieldComponent() {
90          return new BasicUploadField<>(imageProvider, uiContext, definition, i18n);
91      }
92  
93      /**
94       * Initialize the transformer.
95       */
96      @Override
97      protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass) {
98          return this.componentProvider.newInstance(transformerClass, item, definition, UploadReceiver.class);
99      }
100 }