Enum XFormPropertyEnum

java.lang.Object
java.lang.Enum<XFormPropertyEnum>
de.xima.fc.form.common.XFormPropertyEnum
All Implemented Interfaces:
Serializable, Comparable<XFormPropertyEnum>
public enum XFormPropertyEnum extends Enum<XFormPropertyEnum>
Enum with the built-in properties of a form.
Since:
8.2.0

  • Enum Constant Details

    • FORM_TITLE

      public static final XFormPropertyEnum FORM_TITLE
      The title of the form.

    • FORM_DESCRIPTION

      public static final XFormPropertyEnum FORM_DESCRIPTION
      The description of the form.

    • MAX_BACKUPS

      public static final XFormPropertyEnum MAX_BACKUPS
      Maximum number of backups to keep.

    • DISABLE_SCREENSHOT

      public static final XFormPropertyEnum DISABLE_SCREENSHOT
      When true, disabled the screenshot feature when saving a form. The screenshot is used e.g. as a preview image in the form overview menu. Should be kept enabled in most cases, but can be disabled in case of performance issues.

    • ATTRIBUTE_W3C_MODE

      public static final XFormPropertyEnum ATTRIBUTE_W3C_MODE
      true to use only attributes allowed by the W3C spec, false to use the legacy mode.

    • ELEMENT_CLASS_NAME_MODE

      public static final XFormPropertyEnum ELEMENT_CLASS_NAME_MODE
      true when the name of the element should be added as a CSS style class, false otherwise.

    • LEGACY_USE_OPTION_TEXT_FOR_AUTOCOMPLETE

      public static final XFormPropertyEnum LEGACY_USE_OPTION_TEXT_FOR_AUTOCOMPLETE
      In versions [7.0.0, 7.4.0) of formcycle there was a bug for autocomplete select fields, where the option text instead of the option was used instead of its value when evaluating conditions. This flag enables this legacy behavior.

    • PLACEHOLDER_PREVIEW

      public static final XFormPropertyEnum PLACEHOLDER_PREVIEW
      Whether to replace placeholders in the preview with the actual values.

    • VALIDATE_SUBMIT_ACTION

      public static final XFormPropertyEnum VALIDATE_SUBMIT_ACTION
      true when submit buttons should be validated to ensure only existing buttons are pressed.

    • THEME

      @Deprecated public static final XFormPropertyEnum THEME
      Deprecated.
      Use FORM_THEME instead.
      The CSS theme to apply to the form. Due to backwards compatibility, this is a UUID when accessed via the FormVersion entity, but the theme name when used from the persist.json.

    • FORM_THEME

      public static final XFormPropertyEnum FORM_THEME
      The form theme to apply to the form. This is a serialized representation of FormThemeReference.

    • MODERN_THEME

      @Deprecated public static final XFormPropertyEnum MODERN_THEME
      Deprecated.
      There is no separate option for the modern theme anymore. Use FORM_THEME instead (which may be set to the system theme "modern").
      Whether to apply the modern theme CSS to the form.

    • ERROR_STYLE

      public static final XFormPropertyEnum ERROR_STYLE
      Style class to apply to the form, which controls how validation errors are displayed.

    • PAGE_MAX

      public static final XFormPropertyEnum PAGE_MAX
      Maxmimum width of the form, as a CSS unit with "px".

    • PAGE_MIN

      public static final XFormPropertyEnum PAGE_MIN
      Minimum width of the form, as a CSS unit with "px".

    • PAGE_RESPONSIVE

      public static final XFormPropertyEnum PAGE_RESPONSIVE

    • SEO_AUTHOR

      public static final XFormPropertyEnum SEO_AUTHOR
      The author attribute for search engine optimization.

    • SEO_PUBLISHER

      public static final XFormPropertyEnum SEO_PUBLISHER
      The publisher attribute for search engine optimization.

    • SEO_DESCRIPTION

      public static final XFormPropertyEnum SEO_DESCRIPTION
      The description attribute for search engine optimization.

    • SEO_KEYWORDS

      public static final XFormPropertyEnum SEO_KEYWORDS
      The keywords attribute for search engine optimization.

    • SEO_ROBOTS

      public static final XFormPropertyEnum SEO_ROBOTS
      The robots attribute for search engine optimization.

  • Method Details

    • values

      public static XFormPropertyEnum[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static XFormPropertyEnum valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getDefaultValue

      public Object getDefaultValue()
      Default value of the property.
      Returns:
      Default value.

    • getName

      public String getName()
      Name of the property.
      Returns:
      Name of the property.

    • getType

      public Class<?> getType()
      Type of the property.
      Returns:
      Type of the property.