Package de.xima.fc.form.common

Enum ERequiredFieldDisplay

  • All Implemented Interfaces:
    Serializable, Comparable<ERequiredFieldDisplay>
    public enum ERequiredFieldDisplay
extends Enum<ERequiredFieldDisplay>
    Controls which form fields are marked in the form to indicate whether a value must be entered. Required fields are marked with a star next to their label, optional fields with a text such as "optional".
    Since:
    8.6.0

    • Enum Constant Detail

      • REQUIRED

        public static final ERequiredFieldDisplay REQUIRED
        Only required fields are marked. This is the default and corresponds to the behavior of previous versions.

    • Method Detail

      • values

        public static ERequiredFieldDisplay[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ERequiredFieldDisplay c : ERequiredFieldDisplay.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ERequiredFieldDisplay 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

      • getValue

        public String getValue()
        Gets the value as stored in the form properties.
        Returns:
        The value as stored in the form properties, never null.

      • isMarkRequired

        public boolean isMarkRequired()
        Whether required fields should be marked.
        Returns:
        true if required fields should be marked, false otherwise.

      • isMarkOptional

        public boolean isMarkOptional()
        Whether optional fields should be marked.
        Returns:
        true if optional fields should be marked, false otherwise.

      • fromValue

        public static ERequiredFieldDisplay fromValue​(String value)
        Parses the value as stored in the form properties.
        Parameters:
        value - Value to parse, may be null.
        Returns:
        The parsed value, or REQUIRED if the value is null or unknown. Never null.