Package de.xima.fc.form.common
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 Summary
Enum Constants Enum Constant Description ATTRIBUTE_W3C_MODE
true
to use only attributes allowed by the W3C spec,false
to use the legacy mode.ELEMENT_CLASS_NAME_MODE
true
when the name of the element should be added as a CSS style class,false
otherwise.ERROR_STYLE
Style class to apply to the form, which controls how validation errors are displayed.FORM_DESCRIPTION
The description of the form.FORM_TITLE
The title of the form.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.MAX_BACKUPS
Maximum number of backups to keep.MODERN_THEME
Whether to apply the modern theme CSS to the form.PAGE_MAX
Maxmimum width of the form, as a CSS unit with "px".PAGE_MIN
Minimum width of the form, as a CSS unit with "px".PAGE_RESPONSIVE
PLACEHOLDER_PREVIEW
Whether to replace placeholders in the preview with the actual values.SEO_AUTHOR
The author attribute for search engine optimization.SEO_COPYRIGHT
The copyright attribute for search engine optimization.SEO_DESCRIPTION
The description attribute for search engine optimization.SEO_KEYWORDS
The keywords attribute for search engine optimization.SEO_PUBLISHER
The publisher attribute for search engine optimization.SEO_ROBOTS
The robots attribute for search engine optimization.THEME
The CSS theme to apply to the form.VALIDATE_SUBMIT_ACTION
true
when submit buttons should be validated to ensure only existing buttons are pressed.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
getDefaultValue()
Default value of the property.String
getName()
Name of the property.Class<?>
getType()
Type of the property.static XFormPropertyEnum
valueOf(String name)
Returns the enum constant of this type with the specified name.static XFormPropertyEnum[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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.
-
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
public static final XFormPropertyEnum THEME
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.
-
MODERN_THEME
public static final XFormPropertyEnum MODERN_THEME
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_COPYRIGHT
public static final XFormPropertyEnum SEO_COPYRIGHT
The copyright 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 Detail
-
values
public static XFormPropertyEnum[] 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 (XFormPropertyEnum c : XFormPropertyEnum.values()) System.out.println(c);
- 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 nameNullPointerException
- 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.
-
-