View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.field;
35  
36  import info.magnolia.annotation.deprecation.MgnlDeprecated;
37  import info.magnolia.ui.field.factory.UploadFieldFactory;
38  
39  import java.io.File;
40  
41  import lombok.Getter;
42  import lombok.Setter;
43  
44  /**
45   * Field definition for a the basic upload field.
46   */
47  @FieldType("uploadField")
48  @Setter
49  @Getter
50  @MgnlDeprecated(since = "6.2.4.", description = "Use https://documentation.magnolia-cms.com/display/DOCS62/Link+field instead. See https://documentation.magnolia-cms.com/display/DOCS62/Upload+field for more info.")
51  public class UploadFieldDefinition extends ConfiguredFieldDefinition<File> {
52  
53      public UploadFieldDefinition() {
54          setType(File.class);
55          setFactoryClass(UploadFieldFactory.class);
56      }
57  
58      // Define the maximum file size in bite.
59      private long maxUploadSize = Long.MAX_VALUE;
60      // Define allowed uploadMimeType
61      private String allowedMimeTypePattern = ".*";
62  
63      // Define the Labels
64      private String selectNewLabel = "field.upload.basic.select.new";
65      private String selectAnotherLabel = "field.upload.basic.select.another";
66      private String deleteLabel = "field.upload.basic.select.delete";
67      private String dropZoneLabel = "field.upload.basic.drop.hint";
68      private String inProgressLabel = "field.upload.basic.uploading.file";
69      private String inProgressRatioLabel = "field.upload.basic.uploaded.file";
70      private String fileDetailHeaderLabel = "field.upload.basic.file.detail.header";
71      private String fileDetailNameLabel = "field.upload.basic.file.detail.name";
72      private String fileDetailSizeLabel = "field.upload.basic.file.detail.size";
73      private String fileDetailFormatLabel = "field.upload.basic.file.detail.format";
74      private String fileDetailSourceLabel = "field.upload.basic.file.detail.source";
75      private String successNoteLabel = "field.upload.basic.note.success";
76      private String warningNoteLabel = "field.upload.basic.note.warning";
77      private String errorNoteLabel = "field.upload.basic.note.error";
78      private String sizeInterruption = "field.upload.interupted.size";
79      private String typeInterruption = "field.upload.interupted.type";
80      private String userInterruption = "field.upload.interupted.user";
81  
82      public String getAllowedMimeTypePattern() {
83          return allowedMimeTypePattern;
84      }
85  }