Interface FormField

  • All Known Implementing Classes:
    FormFieldImpl, FormPropertyAdapter

    public interface FormField

    Represents an individual field in a form.

    Author:
    Michael Siebers, Daniel Meyer
    • Method Detail

      • getId

        java.lang.String getId()
        Returns:
        the Id of a form property. Must be unique for a given form. The id is used for mapping the form field to a process variable.
      • getLabel

        java.lang.String getLabel()
        Returns:
        the human-readable display name of a form property.
      • getType

        FormType getType()
        Returns:
        the type of this form field.
      • getTypeName

        java.lang.String getTypeName()
        Returns:
        the name of the type of this form field
      • getDefaultValue

        @Deprecated
        java.lang.Object getDefaultValue()
        Deprecated.
        Returns:
        the default value for this form field.
      • getValue

        TypedValue getValue()
        Returns:
        the value for this form field
      • getProperties

        java.util.Map<java.lang.String,​java.lang.String> getProperties()
        Returns:
        a Map of additional properties. This map may be used for adding additional configuration to a form field. An example may be layout hints such as the size of the rendered form field or information about an icon to prepend or append to the rendered form field.
      • isBusinessKey

        boolean isBusinessKey()
        Returns:
        true if field is defined as businessKey, false otherwise