DamUploadFieldDefinition
makes sense only in the context of the Magnolia Assets subapp. Do not use it generically in any other context.DamUploadFieldDefinition
renders a field used by the Magnolia Assets subapp to upload assets to the DAM workspace. It extends
UploadFieldDefinition
as follows:
- The uploaded file is mapped to a media type based on its MIME type.
- Default field labels are overridden by media-type labels such as Upload new image.
- There are actions for editing images in the media editor and for previewing images.
- There is a thumbnail preview.
This DAM upload field definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.dam.app.field.DamUploadFieldDefinition
.
If you work with the Magnolia 5 UI framework, see DAM upload field for Magnolia 5 UI instead.
Use info.magnolia.dam.app.field.factory.DamUploadFieldFactory
for any custom implementation of the field. If no factory class is configured, the default field will be rendered.
Field properties
Field-specific properties
| optional, default is Media editor to be used for editing the asset. Use the |
| optional, default is Regular expression to filter supported files by MIME type. Configuration depends on the value set for the For digital asset management MIME types, see MediaType. |
Common upload field properties
| optional, default is Regular expression to filter allowed files by MIME type. For example, to allow images only, set the value to For more information about the supported pattern, see the |
| optional, default is Maximum file size in bytes. |
The following are label properties. Their values are typically retrieved from a message bundle.
Before upload | |
---|---|
| optional, default is translated Text displayed for the drop zone. |
| optional, default is translated Text displayed on the upload button. |
| optional, default is translated Text displayed when the upload is aborted. |
During upload | |
| optional, default is translated Text showing how many files have been uploaded. |
| optional, default is translated Text showing how many files have been uploaded in relation to the total number of files. |
After upload | |
| optional, default is translated Text displayed on the delete icon. |
| optional, default is translated Text displayed when an error occurs during the upload. |
| optional, default is translated Text displayed for the file format. |
| optional, default is translated Text displayed for the file header. |
| optional, default is translated Text displayed for the file name. |
| optional, default is translated Text displayed for the file size. |
| optional, default is translated Text displayed for the file source. |
| optional, default is translated Text displayed on the upload button. |
| optional, default is translated Text displayed when the file size is greater than |
| optional, default is translated Text displayed when the upload is successful. |
| optional, default is translated Text displayed when the file type is not set in |
| optional, default is translated Text displayed when the upload is interrupted. |
Common simple field properties
| required Name of the field definition item. Derived from the configured node name. Use alphanumeric characters without spaces. |
| required (unless Type of the field definition item. The value must be a fully qualified class name and a subtype of |
| You can use this as a shortcut for See Field types for possible values. |
type | required, default is Model type of the field. Use the fully qualified class name. See PropertyType for possible values. A default type is typically hard-coded in each definition class. You only need to add this property if you want to override the default implementation (for example, with |
| optional Converts values between presentation (UI) and model (stored data). The property must extend com.vaadin.data.Converter. |
| optional, default is translated Message shown when there is an error in the conversion process. The value can be literal or a key of a message bundle. Use alphanumeric characters in literal values. |
| optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters. Applied only when creating a new item, not for already existing items. |
| optional Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle. |
| optional Defines the factory class that initializes and builds the Vaadin form field. The default factory class depends on the particular field. The value must be a fully qualified class name and a subtype of |
| optional Defines the binder class that applies configuration parameters from the field. |
| optional, default is Enables i18n authoring support, which allows editors to write foreign-language or regionally targeted content. A two-letter language identifier ( |
| optional Field label displayed to editors. The value can be literal or a key of a message bundle. If you do not provide the property, Magnolia will fall back to a generated i18n key. If you do not want to have any label, set the property to an empty string such as |
| optional, default is Makes the field uneditable. |
| optional, default is Makes the field required. An asterisk is displayed next to the field label. |
| optional, default is translated Error message shown when |
| optional Additional style information for an editor property definition item applied to the element when the form is rendered. The value can be a CSS class or a list of CSS classes separated by white spaces. |
validators | optional List of field validator definition items. Any value must be a subtype of See Field validators for more information. |