All Superinterfaces:

Serializable

All Known Implementing Classes:

XForm
```
public interface IXForm
extends Serializable
```
Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addHiddenInputParameter(String key, String value)`
`IXForm`	`clone()`
`default String`	`getErrorStyle()`	Deprecated. Use `getFormProperties()`.
`com.alibaba.fastjson.JSONObject`	`getFormI18N()`
`XFormProperties`	`getFormProperties()`
`Map<String,String>`	`getHiddenInputParameter()`
`default String`	`getMaxSize()`	Deprecated. Use `getFormProperties()`.
`String`	`getMetaData()`
`default String`	`getMinSize()`	Deprecated. Use `getFormProperties()`.
`default Map<String,String>`	`getParentIdMap()`
`LinkedHashMap<String,String>`	`getParentItemMap()`	Deprecated. Use `getParentIdMap()`
`List<String>`	`getReadOnlyCondItems()`
`List<String>`	`getRenderCondItems()`
`default String`	`getResponseSize()`	Deprecated. Use `getFormProperties()`.
`List<String>`	`getServerValItems()`
`String`	`getUserCSS()`
`String`	`getUserJS()`
`com.alibaba.fastjson.JSONArray`	`getVariables()`	Retrieves the list of all variables (hidden input fields) that are present in the form.
`com.alibaba.fastjson.JSONObject`	`getVersion()`
`Map<String,XItem>`	`getxItems()`	Deprecated. use `getXItems()`
`Map<String,XItem>`	`getXItems()`
`default boolean`	`isAttributeW3CMode()`	Deprecated. Use `getFormProperties()`.
`default boolean`	`isElementClassNameMode()`	Deprecated. Use `getFormProperties()`.
`default boolean`	`isLegacyUseOptionTextForAutocomplete()`	Deprecated. Use `getFormProperties()`.
`default boolean`	`isPrevReplacement()`	Deprecated. Use `getFormProperties()`.
`default boolean`	`isResponsive()`
`boolean`	`isShowLogo()`
`default boolean`	`isUseModernTheme()`	Deprecated. Use `getFormProperties()`.
`default boolean`	`isValidateSubmitAction()`	Deprecated. Use `getFormProperties()`.
`void`	`setHiddenInputParameter(Map<String,String> hiddenInputParameter)`
`void`	`setParentIdMap(Map<String,String> parentItemMap)`
`void`	`setParentItemMap(LinkedHashMap<String,String> parentItemMap)`	Deprecated. Use `setParentIdMap(Map)`
`void`	`setReadOnlyCondItems(List<String> readOnlyCondItems)`
`void`	`setRenderCondItems(List<String> renderCondItems)`
`void`	`setServerValItems(List<String> serverValItems)`
`void`	`setxItems(LinkedHashMap<String,XItem> xItems)`	Deprecated. use `setXItems(LinkedHashMap)`
`void`	`setXItems(LinkedHashMap<String,XItem> xItems)`

- Method Detail
  - getXItems
```
Map<String,XItem> getXItems()
```
    Returns:
    
    Map between the ID of each form element to the form element itself.
  - getHiddenInputParameter
```
Map<String,String> getHiddenInputParameter()
```
  - setHiddenInputParameter
```
void setHiddenInputParameter(Map<String,String> hiddenInputParameter)
```
  - addHiddenInputParameter
```
void addHiddenInputParameter(String key,
                             String value)
```
  - setXItems
```
void setXItems(LinkedHashMap<String,XItem> xItems)
```
  - 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)
```
  - getParentItemMap
```
@Deprecated
LinkedHashMap<String,String> getParentItemMap()
```
    Deprecated.
    Use getParentIdMap()
    
    Returns:
    
    Map from the ID of a form item to the ID of its parent (if any).
  - 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).
  - setParentItemMap
```
@Deprecated
void setParentItemMap(LinkedHashMap<String,String> parentItemMap)
```
    Deprecated.
    Use setParentIdMap(Map)
    
    Parameters:
    
    parentItemMap - Map from the ID of a form item to the ID of its parent (if any).
  - clone
```
IXForm clone()
      throws CloneNotSupportedException
```
    Throws:
    
    CloneNotSupportedException
  - isShowLogo
```
boolean isShowLogo()
```
  - isResponsive
```
default boolean isResponsive()
```
  - isUseModernTheme
```
@Deprecated
default boolean isUseModernTheme()
```
    Deprecated.
    Use getFormProperties().
    
    Returns:
    
    true to use the modern CSS theme, false to not use it.
  - isPrevReplacement
```
default boolean isPrevReplacement()
```
    Deprecated.
    Use getFormProperties().
    
    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.
  - getMaxSize
```
@Deprecated
default String getMaxSize()
```
    Deprecated.
    Use getFormProperties().
    
    Returns:
    
    Maximum width of the form, as a CSS unit with "px".
  - getMinSize
```
@Deprecated
default String getMinSize()
```
    Deprecated.
    Use getFormProperties().
    
    Returns:
    
    Minimum width of the form, as a CSS unit with "px".
  - getResponseSize
```
@Deprecated
default String getResponseSize()
```
    Deprecated.
    Use getFormProperties().
    
    Returns:
    
    Responsive width of the form, as a CSS unit with "px".
  - 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()
```
  - setxItems
```
@Deprecated
void setxItems(LinkedHashMap<String,XItem> xItems)
```
    Deprecated.
    use setXItems(LinkedHashMap)
  - getxItems
```
@Deprecated
Map<String,XItem> getxItems()
```
    Deprecated.
    use getXItems()
    
    Returns:
    
    Map between the ID of each form element to the form element itself.
  - 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.
  - getFormProperties
```
XFormProperties getFormProperties()
```

Interface IXForm

Method Summary

Method Detail

getXItems

getHiddenInputParameter

setHiddenInputParameter

addHiddenInputParameter

setXItems

getServerValItems

getReadOnlyCondItems

getRenderCondItems

setServerValItems

setReadOnlyCondItems

setRenderCondItems

getParentItemMap

getParentIdMap

setParentIdMap

setParentItemMap

clone

isShowLogo

isResponsive

isUseModernTheme

isPrevReplacement

getVersion

getVariables

getMaxSize

getMinSize

getResponseSize

getMetaData

getUserCSS

getUserJS

getErrorStyle

getFormI18N

setxItems

getxItems

isAttributeW3CMode

isElementClassNameMode

isValidateSubmitAction

isLegacyUseOptionTextForAutocomplete

getFormProperties