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.dam.app.ui.field.factory;
35  
36  import info.magnolia.cms.core.Path;
37  import info.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinition;
38  import info.magnolia.dam.app.ui.field.upload.AssetUploadReceiver;
39  import info.magnolia.dam.app.ui.field.upload.DamUploadField;
40  import info.magnolia.event.EventBus;
41  import info.magnolia.i18nsystem.SimpleTranslator;
42  import info.magnolia.objectfactory.ComponentProvider;
43  import info.magnolia.objectfactory.Components;
44  import info.magnolia.ui.api.app.SubAppContext;
45  import info.magnolia.ui.api.context.UiContext;
46  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
47  import info.magnolia.ui.form.field.factory.AbstractFieldFactory;
48  import info.magnolia.ui.form.field.transformer.Transformer;
49  import info.magnolia.ui.imageprovider.ImageProvider;
50  import info.magnolia.ui.mediaeditor.MediaEditorPresenterFactory;
51  
52  import java.io.File;
53  
54  import javax.inject.Inject;
55  
56  import com.vaadin.data.Item;
57  import com.vaadin.ui.Field;
58  
59  /**
60   * Creates and configures an {@link DamUploadField}.
61   */
62  public class DamUploadFieldFactory extends AbstractFieldFactory<DamUploadFieldDefinition, AssetUploadReceiver> {
63  
64      private final MediaEditorPresenterFactory mediaEditorFactory;
65      private final UiContext uiContext;
66      private final ImageProvider imageProvider;
67      private final ComponentProvider componentProvider;
68      private final SimpleTranslator i18n;
69  
70      @Inject
71      public DamUploadFieldFactory(DamUploadFieldDefinition definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18NAuthoringSupport, ImageProvider imageProvider, MediaEditorPresenterFactory mediaEditorFactory, ComponentProvider componentProvider, SimpleTranslator i18n) {
72          super(definition, relatedFieldItem, uiContext, i18NAuthoringSupport);
73          this.mediaEditorFactory = mediaEditorFactory;
74          this.uiContext = uiContext;
75          this.imageProvider = imageProvider;
76          this.componentProvider = componentProvider;
77          this.i18n = i18n;
78      }
79  
80      /**
81       * @deprecated since 2.1.4. Use {@link #DamUploadFieldFactory(DamUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, MediaEditorPresenterFactory, ComponentProvider, SimpleTranslator)} instead.
82       */
83      @Deprecated
84      public DamUploadFieldFactory(DamUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, UiContext uiContext, MediaEditorPresenterFactory mediaEditorFactory, ComponentProvider componentProvider, SimpleTranslator i18n, I18NAuthoringSupport i18NAuthoringSupport, EventBus subAppEventBus) {
85          this(definition, relatedFieldItem, uiContext, i18NAuthoringSupport, imageProvider, mediaEditorFactory, componentProvider, i18n);
86      }
87  
88      /**
89       * @deprecated since 2.1.3. Use {@link #DamUploadFieldFactory(DamUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, MediaEditorPresenterFactory, ComponentProvider, SimpleTranslator)} instead.
90       */
91      @Deprecated
92      public DamUploadFieldFactory(DamUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, UiContext uiContext, MediaEditorPresenterFactory mediaEditorFactory, ComponentProvider componentProvider, SimpleTranslator i18n) {
93          this(definition, relatedFieldItem, uiContext, Components.getComponent(I18NAuthoringSupport.class), imageProvider, mediaEditorFactory, componentProvider, i18n);
94      }
95  
96      /**
97       * @deprecated since 2.0.4, should not depend upon subapp components, use {@link #DamUploadFieldFactory(DamUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, MediaEditorPresenterFactory, ComponentProvider, SimpleTranslator)} instead.
98       */
99      @Deprecated
100     public DamUploadFieldFactory(DamUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, SubAppContext subAppContext, MediaEditorPresenterFactory mediaEditorFactory, ComponentProvider componentProvider, SimpleTranslator i18n) {
101         this(definition, relatedFieldItem, subAppContext, Components.getComponent(I18NAuthoringSupport.class), imageProvider, mediaEditorFactory, componentProvider, i18n);
102     }
103 
104     @Override
105     protected Field<AssetUploadReceiver> createFieldComponent() {
106         return new DamUploadField(imageProvider, uiContext, mediaEditorFactory, componentProvider, definition, i18n);
107     }
108 
109     /**
110      * MGNLDAM-286 For test only; we need a partial mock there otherwise Path fails when getting MAGNOLIA_APP_ROOTDIR system property.
111      */
112     File getTempDirectory() {
113         return Path.getTempDirectory();
114     }
115 
116     @Override
117     protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass) {
118         return this.componentProvider.newInstance(transformerClass, item, definition, AssetUploadReceiver.class);
119     }
120 }