Package de.xima.fc.form.common.models

Interface IXForm

    • Method Detail

      • getXItems

        Map<String,​XItem> getXItems()
        Returns:
        Map between the ID of each form element to the form element itself.

      • setHiddenInputParameter

        void setHiddenInputParameter​(Map<String,​String> hiddenInputParameter)

      • addHiddenInputParameter

        void addHiddenInputParameter​(String key,
                             String value)

      • getServerValItems

        List<String> getServerValItems()

      • getReadOnlyCondItems

        List<String> getReadOnlyCondItems()

      • getRenderCondItems

        List<String> getRenderCondItems()

      • setServerValItems

        void setServerValItems​(List<String> serverValItems)

      • setReadOnlyCondItems

        void setReadOnlyCondItems​(List<String> readOnlyCondItems)

      • setRenderCondItems

        void setRenderCondItems​(List<String> renderCondItems)

      • getParentIdMap

        default Map<String,​String> getParentIdMap()
        Returns:
        Map from the ID of a form item to the ID of its parent (if any).

      • setParentIdMap

        void setParentIdMap​(Map<String,​String> parentItemMap)
        Parameters:
        parentItemMap - Map from the ID of a form item to the ID of its parent (if any).

      • isShowLogo

        boolean isShowLogo()

      • isResponsive

        default boolean isResponsive()

      • isUseModernTheme

        @Deprecated
default boolean isUseModernTheme()
        Deprecated.
        There is no separate option anymore for the modern theme. Use getFormProperties() and XFormProperties.getFormTheme() (which may be the system theme "modern").
        Returns:
        true to use the modern CSS theme, false to not use it.

      • isPrevReplacement

        default boolean isPrevReplacement()
        Deprecated.
        There is no separate option anymore for the modern theme. Use getFormProperties() and XFormProperties.getFormTheme() (which may be the system theme "modern").
        Returns:
        Whether to replace placeholders with their values in the preview.

      • getVersion

        com.alibaba.fastjson.JSONObject getVersion()

      • getVariables

        com.alibaba.fastjson.JSONArray getVariables()
        Retrieves the list of all variables (hidden input fields) that are present in the form. Each variable is a JSON object with the following properties:
        • aliasname - Alias of the variable, which can be used e.g. in placeholders instead of the name and allows all characters.
        • name - The name of the variable, which is also the name of the hidden input field. It only allows certain characters (digits, letters, underscore)
        • serveronly - Whether the variable exists only on the server.
        • value - The default value of the variable.
        Returns:
        A list of all variables.

      • getMetaData

        String getMetaData()

      • getUserCSS

        String getUserCSS()

      • getUserJS

        String getUserJS()

      • getErrorStyle

        @Deprecated
default String getErrorStyle()
        Deprecated.
        Use getFormProperties().
        Returns:
        Style class to apply to the form, which controls how validation errors are displayed.

      • getFormI18N

        com.alibaba.fastjson.JSONObject getFormI18N()

      • isAttributeW3CMode

        @Deprecated
default boolean isAttributeW3CMode()
        Deprecated.
        Use getFormProperties().
        Returns:
        true to use only attributes allowed by the W3C spec, false to use the legacy mode.

      • isElementClassNameMode

        @Deprecated
default boolean isElementClassNameMode()
        Deprecated.
        Use getFormProperties().
        Returns:
        true when the name of the element should be added as a CSS style class, false otherwise.

      • isValidateSubmitAction

        @Deprecated
default boolean isValidateSubmitAction()
        Deprecated.
        Use getFormProperties().
        Returns:
        true when submit buttons should be validated to ensure only existing buttons are pressed.

      • isLegacyUseOptionTextForAutocomplete

        @Deprecated
default boolean isLegacyUseOptionTextForAutocomplete()
        Deprecated.
        Use getFormProperties().
        Returns:
        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.