DAM upload field

DamUploadFieldDefinition makes only sense 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.

It is possible to configure DamUploadFieldDefinition in dialogs or other apps, but keep in mind that the file will be placed in the workspace for which the field has been configured. For example, if you use the field in a dialog for a component template, that file (when uploaded using the field) will be stored in the website, not the DAM, workspace. It is best practice to keep your assets in the DAM whenever possible and link to them using a link field.

Field properties

Field-specific properties

Property Description

mediaEditorId

optional, default is `ui-mediaeditor:image`

Media editor to be used for editing the asset. Use the <module-name>:<media-editor-id> syntax for configuration.

mediaEditorSupportedMimeTypes

optional, default is `image\\/(?!svg\\+xml).*`

Regular expression to filter supported files by MIME type. Configuration depends on the value set for the mediaEditorId property.

For digital asset management MIME types, see MediaType.

Common upload field properties

Property Description

allowedMimeTypePattern

optional, default is .* (all types)

Regular expression to filter allowed files by MIME type. For example, to allow images only, set the value to image\/.*.

For more information about the supported pattern, see the Pattern class.

maxUploadSize

optional, default is 2^63 (9.2 EB)

Maximum file size in bytes.

The following are label properties. Their values are typically retrieved from a message bundle.

Before upload

Property Description

dropZoneLabel

optional, default is translated field.upload.basic.drop.hint key

Text displayed for the drop zone.

selectNewLabel

optional, default is translated field.upload.basic.select.new key

Text displayed on the upload button.

warningNoteLabel

optional, default is translated field.upload.basic.note.warning key

Text displayed when the upload is aborted.

During upload

Property Description

inProgressLabel

optional, default is translated field.upload.basic.uploading.file key

Text showing how many files have been uploaded.

inProgressRatioLabel

optional, default is translated field.upload.basic.uploaded.file key

Text showing how many files have been uploaded in relation to the total number of files.

After upload

Property Description

deleteLabel

optional, default is translated field.upload.basic.select.delete key

Text displayed on the delete icon.

errorNoteLabel

optional, default is translated field.upload.basic.note.error key

Text displayed when an error occurs during the upload.

fileDetailFormatLabel

optional, default is translated field.upload.basic.file.detail.format key

Text displayed for the file format.

fileDetailHeaderLabel

optional, default is translated field.upload.basic.file.detail.header key

Text displayed for the file header.

fileDetailNameLabel

optional, default is translated field.upload.basic.file.detail.name key

Text displayed for the file name.

fileDetailSizeLabel

optional, default is translated field.upload.basic.file.detail.size key

Text displayed for the file size.

fileDetailSourceLabel

optional, default is translated field.upload.basic.file.detail.source key

Text displayed for the file source.

selectAnotherLabel

optional, default is translated field.upload.basic.select.another key

Text displayed on the upload button.

sizeInterruption

optional, default is translated field.upload.interupted.size key

Text displayed when the file size is greater than maxUploadSize.

successNoteLabel

optional, default is translated field.upload.basic.note.success key

Text displayed when the upload is successful.

typeInterruption

optional, default is translated field.upload.interupted.type key

Text displayed when the file type is not set in allowedMimeTypePattern.

userInterruption

optional, default is translated field.upload.interupted.user key

Text displayed when the upload is interrupted.

Common simple field properties

Property Description

name

required

Name of the field definition item. Derived from the configured node name. Use alphanumeric characters without spaces.

class

required (unless $type is used)

Type of the field definition item. The value must be a fully qualified class name and a subtype of info.magnolia.ui.field.FieldDefinition. See Field types for possible values.

$type

You can use this as a shortcut for class if the definition class is annotated with info.magnolia.ui.field.FieldType. The proper value is defined by the annotation.

Example class annotation
@FieldType("textField")
public class TextFieldDefinition extends ConfiguredFieldDefinition<String> {
...
}

See Field types for possible values.

type

required, default is java.lang.String

Data 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.

Make sure that type has a value matching the type of data you entered (for example, java.lang.Long for long values) and that converterClass is set accordingly.

Example definition
text:
  $type: textField
  type: java.lang.Long
  converterClass: com.vaadin.data.converter.StringToLongConverter

converterClass

optional

Converts values between presentation (UI) and model (stored data). The property must extend com.vaadin.data.Converter. Available classes:

  • info.magnolia.ui.editor.converter.JcrNodeToIdentifierConverter

  • info.magnolia.ui.editor.converter.JcrNodeToPathConverter

  • info.magnolia.ui.editor.converter.JcrNodeToWorkspaceAndIdConverter

  • info.magnolia.ui.editor.converter.JcrPathToIdentifierConverter

conversionErrorMessage

optional, default is translated conversion.message.error key

Message shown when there is an error in the conversion process. The value can be literal or a key of a message bundle.

defaultValue

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.

For defaultValue to work, the populate property in OpenDialogActionDefinition has to be set to false.

description

optional

Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle.

factoryClass

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 info.magnolia.ui.field.FieldFactory.

fieldBinderClass

optional

Defines the binder class that applies configuration parameters from the field.

i18n

optional, default is false

Enables i18n authoring support, which allows editors to write foreign-language or regionally targeted content. A two-letter language identifier (en, de, fr, etc.) is displayed on controls where i18n is set to true.

label

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 label: "" in YAML.

readOnly

optional, default is false

Makes the field uneditable.

required

optional, default is false (not relevant for checkbox field)

Makes the field required. An asterisk is displayed next to the field label.

requiredErrorMessage

optional, default is translated validation.message.required key

Error message shown when required is set to true and the user saves an empty field. The value can be literal or a key of a message bundle.

styleName

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.

The style name will be rendered as an HTML class name, which can be used in a CSS definition. The class name is added to the field by calling the Vaadin method addStyleName.

The referenced class can be defined in:

validators

optional

List of field validator definition items. Any value must be a subtype of info.magnolia.ui.field.FieldValidatorDefinition.

See Field validators for more information.

Feedback