Package de.xima.fc.form.common

Enum EHelpTextDisplay

    • Enum Constant Detail

      • POPOVER

        public static final EHelpTextDisplay POPOVER
        A help icon is shown next to the form element, the help text is shown as a popover when the user hovers over or focuses the icon. This is the default and corresponds to the behavior of previous versions.

      • ABOVE

        public static final EHelpTextDisplay ABOVE
        The help text is always shown above the form element. Note that the exact position depends on the position of the label. For example, when the label is configured to be shown above the form element, the help text will be shown between the label and the form element.

      • BELOW

        public static final EHelpTextDisplay BELOW
        The help text is always shown below the form element. Note that the exact position depends on the position of the label. For example, when the label is configured to be shown below the form element, the help text will be shown between the form element and the label.

    • Method Detail

      • values

        public static EHelpTextDisplay[] 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 (EHelpTextDisplay c : EHelpTextDisplay.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static EHelpTextDisplay 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 or the element properties.
        Returns:
        The value as stored in the properties, never null.

      • isInline

        public boolean isInline()
        Whether the help text is always shown in the form, i.e. above or below the form element.
        Returns:
        true if the help text is shown inline, false if it is shown as a popover.

      • fromValue

        public static EHelpTextDisplay 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 POPOVER if the value is null or unknown. Never null.

      • fromValue

        public static EHelpTextDisplay fromValue​(String value,
                                         EHelpTextDisplay defaultDisplay)
        Parses the value as stored in the properties of a form element, where an empty value means that the form's default applies.
        Parameters:
        value - Value to parse, may be null.
        defaultDisplay - Display to return when the value is null, empty or unknown, must not be null.
        Returns:
        The parsed value, or the given default if the value is null, empty or unknown. Never null.