You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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

Node name

Value

 
form


 
tabs


 
tabUpload


 
fields


 
upload


 
binaryNodeName

jcr:content

 
fieldType

damUpload

 
label

Upload asset

 
editFileName

true

Unable to render {include} The included page could not be found.

Properties:
<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:

<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:

Unable to render {include} The included page could not be found.

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

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))
  • No labels