Date field - 5 UI

Deprecated

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

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

DateFieldDefinition renders a calendar that allows the user to select a date and optionally a time.

class: info.magnolia.ui.form.field.definition.DateFieldDefinition

fieldType: date

Tour app

Date field properties

Simple date field

form:
  tabs:
    - name: tabText
      label: Text
      fields:
        - name: date
          fieldType: date
          time: false
          type: Date
          label: Date
          defaultValue: now

Referencing fields shortcut info - 5 UI

See Referencing fields for further information.

Property Description

<field name>

type

required

Set the type property to Date to ensure that the value is saved as a Calendar object and not a String. The addition of this property is essential.

dateFormat

optional, default is `yyyy-MM-dd`

Format in which the date is displayed to users. See SimpleDateFormat class for allowed patterns.

Examples:

dateFormat: yyyy-MM-dd # 2017-10-31
dateFormat: yyyy-MMMM-dd # 2017-October-31
dateFormat: EEE, MMM d, yyyy # Tue, Oct 31, 2017

defaultValue

optional, default is `now`

Set the default value to a specific date such as "2017-10-31" or use the keyword now which defaults to the current date and time. Current time means time at the host server. Magnolia stores dates and times using server time. The stored time is converted and displayed to users in their preferred time zone.

The default value only applies to new content items, not to existing content items that have been created previously.

Enclose the default value in quotes when using YAML:
defaultValue: "2017-10-31"
defaultValue: "2017-10-31 15:09"

If you define the dateFormat or timeFormat properties then provide the defaultValue using those same formats:

dateFormat: MM/dd/yyyy
timeFormat: h:mm a
defaultValue: "10/31/2017 3:09 PM"

time

optional, default is false

Enables time selection. Renders dropdown boxes at the bottom of the calendar.

timeFormat

optional, default is `HH:mm`

Format in which time is displayed to users. See SimpleDateFormat class for allowed patterns.

Examples:

timeFormat: HH:mm # 15:09
timeFormat: h:mm a # 3:09 PM

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.

Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules