DAM upload field - 5 UI

Deprecated

This DAM upload field definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.

For the updated implementation, see DAM upload field for Magnolia 6 UI instead.

DamUploadFieldDefinition renders a field that is used by the Assets app for uploading assets to the DAM workspace. It extends the basic upload field 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.
Actions for editing images in the media editor.
Actions for previewing images.
Thumbnail preview.

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.

class: info.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinition

fieldType: damUpload

DAM upload field properties

Simple DAM upload field definition:

form:
  tabs:
    - name: tabUpload
      label: Upload
      fields:
        - name: upload
          fieldType: damUpload
          label: Upload asset
          binaryNodeName: jcr:content
          editFileName: true

Referencing fields shortcut info - 5 UI

See Referencing fields for further information.

Common upload field properties - 5 UI

Property Description

Property	Description
`<field name>`	required Name of the field.
`allowedMimeTypePattern`	optional, default is `.` (all types)* Regular expression to filter allowed files by their MIME type. For example, to allow only Excel files set the value to `application.(excel\|xls)`. To allow images only, set the value to `image.`. For more information about the supported pattern, see `Pattern`. For digital asset management MIME types see MediaType.
`binaryNodeName`	optional, default is `binaryNodeName` Name of the subnode that will contain the file binary and related information.
`editFileFormat`	optional, default is `false` When set to `true`, the file extension displayed in the Format field is editable.
`editFileName`	optional, default is `false` When set to `true`, the file name displayed in the Name field is editable.
`maxUploadSize`	optional, default is `2^63` (9.2 EB) Maximum file size in bytes. Caption properties. Values are typically retrieved from a message bundle.
`<field name>`	required Name of the field Empty view
`dropZoneCaption`	optional, default is `or <em>drag a file into this area</em> to upload it` Text displayed as label for dropping invitation.
`selectNewCaption`	optional, default is `Select a file to upload…` Text displayed as tooltip on the upload button.
`warningNoteCaption`	optional, default is `You have aborted the upload of your file` Text displayed in the warning note. In progress view
`inProgressCaption`	optional, default is `Uploading file {0}...` Text displayed as title.
`inProgressRatioCaption`	optional, default is `{0} of {1} uploaded` Text displayed as file upload ratio. Completed view
`deleteCaption`	optional, default is `Upload a new File…` Text displayed as tooltip on the delete icon.
`errorNoteCaption`	optional, default is `An Error occurred while uploading your file` Text displayed in the error note.
`fileDetailFormatCaption`	optional, default is `Format` Text displayed as file format label.
`fileDetailHeaderCaption`	optional, default is `File detail` Text displayed as file detail header.
`fileDetailNameCaption`	optional, default is `Name` Text displayed as file name label.
`fileDetailSizeCaption`	optional, default is `Size` Text displayed as file size label.
`fileDetailSourceCaption`	optional, default is `Source` Text displayed as file source label.
`selectAnotherCaption`	optional, default is `Upload a new File…` Text displayed on the upload button.
`sizeInterruption`	optional, default is `A file size limitation` Text displayed in the warning when file size > `maxUploadSize`
`successNoteCaption`	optional, default is `Your file has been uploaded successfully` Text displayed in the success note.
`typeInterruption`	optional, default is `An unsupported upload file type` Text displayed in the warning when file type not in `allowedMimeTypePattern`
`userInterruption`	optional, default is `A user action` Text displayed in the warning when the user interrupts the upload.

<field name>

required

Name of the field.

allowedMimeTypePattern

optional, default is .* (all types)

Regular expression to filter allowed files by their MIME type. For example, to allow only Excel files set the value to application.(excel|xls). To allow images only, set the value to image.. For more information about the supported pattern, see Pattern. For digital asset management MIME types see MediaType.

binaryNodeName

optional, default is binaryNodeName

Name of the subnode that will contain the file binary and related information.

editFileFormat

optional, default is false

When set to true, the file extension displayed in the Format field is editable.

editFileName

optional, default is false

When set to true, the file name displayed in the Name field is editable.

maxUploadSize

optional, default is 2^63 (9.2 EB)

Maximum file size in bytes.

Caption properties. Values are typically retrieved from a message bundle.

<field name>

required

Name of the field

Empty view

dropZoneCaption

optional, default is or <em>drag a file into this area</em> to upload it

Text displayed as label for dropping invitation.

selectNewCaption

optional, default is Select a file to upload…

Text displayed as tooltip on the upload button.

warningNoteCaption

optional, default is You have aborted the upload of your file

Text displayed in the warning note.

In progress view

inProgressCaption

optional, default is Uploading file {0}...

Text displayed as title.

inProgressRatioCaption

optional, default is {0} of {1} uploaded

Text displayed as file upload ratio.

Completed view

deleteCaption

optional, default is Upload a new File…

Text displayed as tooltip on the delete icon.

errorNoteCaption

optional, default is An Error occurred while uploading your file

Text displayed in the error note.

fileDetailFormatCaption

optional, default is Format

Text displayed as file format label.

fileDetailHeaderCaption

optional, default is File detail

Text displayed as file detail header.

fileDetailNameCaption

optional, default is Name

Text displayed as file name label.

fileDetailSizeCaption

optional, default is Size

Text displayed as file size label.

fileDetailSourceCaption

optional, default is Source

Text displayed as file source label.

selectAnotherCaption

optional, default is Upload a new File…

Text displayed on the upload button.

sizeInterruption

optional, default is A file size limitation

Text displayed in the warning when file size > maxUploadSize

successNoteCaption

optional, default is Your file has been uploaded successfully

Text displayed in the success note.

typeInterruption

optional, default is An unsupported upload file type

Text displayed in the warning when file type not in allowedMimeTypePattern

userInterruption

optional, default is A user action

Text displayed in the warning when the user interrupts the upload.

Caption properties specific to the DAM upload field:

Property Description

Property	Description
`<field name>`	required Name of the field.
`editFileCaption`#	optional, default is `Edit image …` Text displayed as a tooltip when you hover over the edit action icon.
`lightboxCaption`#	optional, default is `View in lightbox …` Text displayed as a tooltip when you hover over the preview action icon.

<field name>

required

Name of the field.

editFileCaption#

optional, default is `Edit image …`

Text displayed as a tooltip when you hover over the edit action icon.

lightboxCaption#

optional, default is `View in lightbox …`

Text displayed as a tooltip when you hover over the preview action icon.

Common field properties - 5 UI

Property Description

fieldType`or `class

required

Defines the field type via either a field alias name or a fully-qualified field definition class name. See Field definition: Field types.

To check the correct form of the name, use the Definitions app.

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.

description

optional

Help text displayed when the user clicks the help icon. The value can be literal or retrieved from the message bundle with a key. Use alphanumeric characters in literal values. Not applicable to the static 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.

i18nBasename

optional, default is the message bundle defined in the dialog definition_

Message bundle such as com.example.messages for localized field labels. You can set this property in the parent dialog, form or tab definition. Child fields will inherit the bundle.

label

optional

Field label displayed to editors. The value can be literal such as Product name or retrieved from the message bundle with a key such as products.product.label. Use alphanumeric characters in literal values.

If you do not provide the property, Magnolia will fall back to a generated i18n key and display the key in the UI.

If you do not want a label at all, define the property and set its value to a blank space such as label: " " in YAML.

name

optional, default is the name of the field’s parent node_

Name of the node where the value is saved. The name jcrName is reserved. Use alphanumeric characters.

placeholder

optional

Placeholder text to be displayed when the field is empty. The value is i18n-able.

Applicable to text, link and combobox fields.

readOnly

optional, default is false

Makes the field uneditable. Adding this property has the same effect as creating a static field.

required

optional, default is false

Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values.

requiredErrorMessage

optional, default is This field is required

Error message displayed when required is true and the user saves an empty field. The value can be literal or retrieved from the message bundle with a key such as validation.message.required.

styleName

optional

Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names such as checkbox disabled. 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.

transformerClass

optional

Property transformer classes define how field values are stored in the repository. Each field has a default transformer class. You don’t need to define a class unless you want to override the default. The value is a fully-qualified class name.

Complex field definitions may define a different default transformer in their constructor. See Transforming field values for more.

type

optional, most fields set a default value automatically

JCR property type of the stored value such as String, Boolean, Date or any other supported and defined data type.

When using the basic upload field in a composite field, use DelegatingCompositeFieldTransformer. The other transformer classes do not work.

Feedback

DX Core

DAM upload field - 5 UI

DAM upload field properties

Referencing fields shortcut info - 5 UI

Common upload field properties - 5 UI

Common field properties - 5 UI

Location

Main doc sections