Class XFormProperties

    • Constructor Detail

      • XFormProperties

        public XFormProperties()
    • Method Detail

      • getErrorStyle

        public final String getErrorStyle()
      • setErrorStyle

        public final void setErrorStyle​(String errorStyle)
      • getFormDescription

        public final String getFormDescription()
      • setFormDescription

        public final void setFormDescription​(String formDescription)
      • getFormTheme

        public final FormThemeReference getFormTheme()
        Gets the form theme to use for styling the form. A form theme may come from different sources, such as a system theme, a client theme, or a theme provided by a plugin.
        Returns:
        formTheme The form theme to use.
      • setFormTheme

        public final void setFormTheme​(FormThemeReference formTheme)
        Sets the form theme to use for styling the form. A form theme may come from different sources, such as a system theme, a client theme, or a theme provided by a plugin.
        Parameters:
        formTheme - The form theme to use.
      • getFormTitle

        public final String getFormTitle()
      • setFormTitle

        public final void setFormTitle​(String formTitle)
      • getMaxBackups

        public final int getMaxBackups()
      • setMaxBackups

        public final void setMaxBackups​(int maxBackups)
      • getPageMax

        public final String getPageMax()
      • setPageMax

        public final void setPageMax​(String pageMax)
      • getPageMin

        public final String getPageMin()
      • setPageMin

        public final void setPageMin​(String pageMin)
      • getPageResponsive

        public final String getPageResponsive()
      • setPageResponsive

        public final void setPageResponsive​(String pageResponsive)
      • getSeoAuthor

        public final String getSeoAuthor()
      • setSeoAuthor

        public final void setSeoAuthor​(String seoAuthor)
      • getSeoCopyright

        public final String getSeoCopyright()
      • setSeoCopyright

        public final void setSeoCopyright​(String seoCopyright)
      • getSeoDescription

        public final String getSeoDescription()
      • setSeoDescription

        public final void setSeoDescription​(String seoDescription)
      • getSeoKeywords

        public final String getSeoKeywords()
      • setSeoKeywords

        public final void setSeoKeywords​(String seoKeywords)
      • getSeoPublisher

        public final String getSeoPublisher()
      • setSeoPublisher

        public final void setSeoPublisher​(String seoPublisher)
      • getSeoRobots

        public final String getSeoRobots()
      • setSeoRobots

        public final void setSeoRobots​(String seoRobots)
      • getTheme

        @Deprecated
        public final UUID getTheme()
        Deprecated.
        Use getFormTheme() instead.
        Gets the theme of the form, i.e. the CSS to apply to the form. The value is the UUID of a de.xima.fc.entities.Textbaustein.
        Returns:
        The UUID of the theme.
      • setTheme

        @Deprecated
        public final void setTheme​(UUID theme)
        Deprecated.
        Use getFormTheme() instead.
        Sets the theme of the form, i.e. the CSS to apply to the form. The value is the UUID of a de.xima.fc.entities.Textbaustein.
        Parameters:
        theme - The UUID of the theme.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • isAttributeW3CMode

        public final boolean isAttributeW3CMode()
      • setAttributeW3CMode

        public final void setAttributeW3CMode​(boolean attributeW3CMode)
      • isElementClassNameMode

        public final boolean isElementClassNameMode()
      • setElementClassNameMode

        public final void setElementClassNameMode​(boolean elementClassNameMode)
      • isLegacyUseOptionTextForAutocomplete

        public final boolean isLegacyUseOptionTextForAutocomplete()
      • setLegacyUseOptionTextForAutocomplete

        public final void setLegacyUseOptionTextForAutocomplete​(boolean legacyUseOptionTextForAutocomplete)
      • isModernTheme

        @Deprecated
        public final boolean isModernTheme()
        Deprecated.
        Use getFormTheme() instead (which can be the system theme "modern")
        Gets whether the form uses the modern theme.
        Returns:
        Whether the form uses the modern theme.
      • setModernTheme

        @Deprecated
        public final void setModernTheme​(boolean modernTheme)
        Deprecated.
        Use getFormTheme() instead (which can be the system theme "modern")
        Sets whether the form uses the modern theme.
        Parameters:
        modernTheme - Whether the form uses the modern theme.
      • isPlaceholderPreview

        public final boolean isPlaceholderPreview()
      • setPlaceholderPreview

        public final void setPlaceholderPreview​(boolean placeholderPreview)
      • isValidateSubmitAction

        public final boolean isValidateSubmitAction()
      • setValidateSubmitAction

        public final void setValidateSubmitAction​(boolean validateSubmitAction)
      • removeProperty

        public final void removeProperty​(String key)
      • setProperty

        public final void setProperty​(String key,
                                      Object value)
      • toJson

        public final com.alibaba.fastjson.JSONObject toJson()
      • onPropertyAdded

        protected void onPropertyAdded​(String key,
                                       Object value)
        Called after a property was newly added.
        Parameters:
        key - The key of the added property.
        value - The value of the property.
      • onPropertyModified

        protected void onPropertyModified​(String key,
                                          Object value)
        Called after an existing property was modified.
        Parameters:
        key - The key of the modified property.
        value - The new value of the property.
      • onPropertyRemoved

        protected void onPropertyRemoved​(String key)
        Called after an existing property was removed.
        Parameters:
        key - The key of the removed property.
      • fromJson

        public static XFormProperties fromJson​(com.alibaba.fastjson.JSONObject json)