DAM upload field
This DAM upload field definition makes only sense in the context of the Magnolia Assets subapp. Do not use it generically in any other context. If you work with the Magnolia 5 UI framework, see DAM upload field for Magnolia 5 UI instead. |
info.magnolia.dam.app.field.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.
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.
Use |
Field properties
Field-specific properties
Property | Description | ||
---|---|---|---|
|
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
|
Common upload field properties
Property | Description | ||||
---|---|---|---|---|---|
|
optional, default is all types Comma-separated list of allowed MIME types. Examples include
|
||||
|
optional, default is Maximum file size in bytes.
|
Common simple field properties
Property | Description | ||||
---|---|---|---|---|---|
|
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 Example class annotation
See Field types for possible values. |
||||
|
required, default is 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.
|
||||
|
optional Converts values between the presentation (UI) and model (stored data). The property must extend
|
||||
|
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. |
||||
|
optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
|
||||
|
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. When
|
||||
|
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. 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
|
||||
|
optional List of field validator definition items. Any value must be a subtype of
See Field validators for more information. |