Class XForm

java.lang.Object

de.xima.fc.form.common.models.XForm

All Implemented Interfaces:

IXForm, Serializable, Cloneable

public class XForm
extends Object
implements IXForm, Cloneable

Diese Klasse kapselt das Formular-Persist, ermöglicht es dieses mit Werten zu befüllen, zu validieren und entsprechend zu rendern.

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
XForm()	Creates an empty form with no form elements.
XForm(com.alibaba.fastjson.JSONObject persist)	Creates a new XForm from the given JSON persist object.

Method Summary

Modifier and Type	Method	Description
void	addHiddenInputParameter(String key, String value)
XForm	clone()
String	getErrorStyle()	Deprecated.
com.alibaba.fastjson.JSONObject	getFormI18N()
XFormProperties	getFormProperties()
Map<String,String>	getHiddenInputParameter()
String	getMaxSize()	Deprecated.
String	getMetaData()
String	getMinSize()	Deprecated.
Map<String,String>	getParentIdMap()
LinkedHashMap<String,String>	getParentItemMap()	Deprecated.
List<String>	getReadOnlyCondItems()
List<String>	getRenderCondItems()
String	getResponseSize()	Deprecated.
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()
boolean	isAttributeW3CMode()	Deprecated.
boolean	isElementClassNameMode()	Deprecated.
boolean	isLegacyUseOptionTextForAutocomplete()	Deprecated.
boolean	isPrevReplacement()	Deprecated.
boolean	isResponsive()	Deprecated.
boolean	isShowLogo()
boolean	isUseModernTheme()	Deprecated.
boolean	isValidateSubmitAction()	Deprecated.
void	setHiddenInputParameter(Map<String,String> hiddenInputParameter)
void	setParentIdMap(Map<String,String> parentItemMap)
void	setParentItemMap(LinkedHashMap<String,String> parentItemMap)	Deprecated.
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)

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XForm

public XForm()

Creates an empty form with no form elements.

XForm

public XForm(com.alibaba.fastjson.JSONObject persist)
      throws com.alibaba.fastjson.JSONException

Creates a new XForm from the given JSON persist object.

Parameters:

persist - The JSON object representing the form persist.

Throws:

com.alibaba.fastjson.JSONException - When the persist JSON contains an invalid data structure.

Method Details

setXItems

public void setXItems(LinkedHashMap<String,XItem> xItems)

Specified by:

setXItems in interface IXForm

getXItems

public Map<String,XItem> getXItems()

Specified by:

getXItems in interface IXForm

Returns:

Map between the ID of each form element to the form element itself.

getHiddenInputParameter

public Map<String,String> getHiddenInputParameter()

Specified by:

getHiddenInputParameter in interface IXForm

setHiddenInputParameter

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

Specified by:

setHiddenInputParameter in interface IXForm

addHiddenInputParameter

public void addHiddenInputParameter(String key,
 String value)

Specified by:

addHiddenInputParameter in interface IXForm

getServerValItems

public List<String> getServerValItems()

Specified by:

getServerValItems in interface IXForm

getReadOnlyCondItems

public List<String> getReadOnlyCondItems()

Specified by:

getReadOnlyCondItems in interface IXForm

getRenderCondItems

public List<String> getRenderCondItems()

Specified by:

getRenderCondItems in interface IXForm

setServerValItems

public void setServerValItems(List<String> serverValItems)

Specified by:

setServerValItems in interface IXForm

setReadOnlyCondItems

public void setReadOnlyCondItems(List<String> readOnlyCondItems)

Specified by:

setReadOnlyCondItems in interface IXForm

setRenderCondItems

public void setRenderCondItems(List<String> renderCondItems)

Specified by:

setRenderCondItems in interface IXForm

getParentItemMap

@Deprecated
public LinkedHashMap<String,String> getParentItemMap()

Deprecated.

Specified by:

getParentItemMap in interface IXForm

Returns:

Map from the ID of a form item to the ID of its parent (if any).

getParentIdMap

public Map<String,String> getParentIdMap()

Specified by:

getParentIdMap in interface IXForm

Returns:

Map from the ID of a form item to the ID of its parent (if any).

setParentIdMap

public void setParentIdMap(Map<String,String> parentItemMap)

Specified by:

setParentIdMap in interface IXForm

Parameters:

parentItemMap - Map from the ID of a form item to the ID of its parent (if any).

setParentItemMap

@Deprecated
public void setParentItemMap(LinkedHashMap<String,String> parentItemMap)

Deprecated.

Specified by:

setParentItemMap in interface IXForm

Parameters:

parentItemMap - Map from the ID of a form item to the ID of its parent (if any).

isShowLogo

public boolean isShowLogo()

Specified by:

isShowLogo in interface IXForm

getVersion

public com.alibaba.fastjson.JSONObject getVersion()

Specified by:

getVersion in interface IXForm

getVariables

public com.alibaba.fastjson.JSONArray getVariables()

Description copied from interface: IXForm

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.

Specified by:

getVariables in interface IXForm

Returns:

A list of all variables.

getMetaData

public String getMetaData()

Specified by:

getMetaData in interface IXForm

getUserCSS

public String getUserCSS()

Specified by:

getUserCSS in interface IXForm

getUserJS

public String getUserJS()

Specified by:

getUserJS in interface IXForm

clone

public XForm clone()
            throws CloneNotSupportedException

Specified by:

clone in interface IXForm

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getFormI18N

public com.alibaba.fastjson.JSONObject getFormI18N()

Specified by:

getFormI18N in interface IXForm

getFormProperties

public XFormProperties getFormProperties()

Specified by:

getFormProperties in interface IXForm

getxItems

@Deprecated
public Map<String,XItem> getxItems()

Deprecated.

use getXItems()

Specified by:

getxItems in interface IXForm

Returns:

Map between the ID of each form element to the form element itself.

setxItems

@Deprecated
public void setxItems(LinkedHashMap<String,XItem> xItems)

Deprecated.

use setXItems(LinkedHashMap)

Specified by:

setxItems in interface IXForm

isResponsive

@Deprecated
public boolean isResponsive()

Deprecated.

Specified by:

isResponsive in interface IXForm

isUseModernTheme

@Deprecated
public boolean isUseModernTheme()

Deprecated.

Specified by:

isUseModernTheme in interface IXForm

Returns:

true to use the modern CSS theme, false to not use it.

isPrevReplacement

@Deprecated
public boolean isPrevReplacement()

Deprecated.

Specified by:

isPrevReplacement in interface IXForm

Returns:

Whether to replace placeholders with their values in the preview.

getMaxSize

@Deprecated
public String getMaxSize()

Deprecated.

Specified by:

getMaxSize in interface IXForm

Returns:

Maximum width of the form, as a CSS unit with "px".

getMinSize

@Deprecated
public String getMinSize()

Deprecated.

Specified by:

getMinSize in interface IXForm

Returns:

Minimum width of the form, as a CSS unit with "px".

getResponseSize

@Deprecated
public String getResponseSize()

Deprecated.

Specified by:

getResponseSize in interface IXForm

Returns:

Responsive width of the form, as a CSS unit with "px".

getErrorStyle

@Deprecated
public String getErrorStyle()

Deprecated.

Specified by:

getErrorStyle in interface IXForm

Returns:

Style class to apply to the form, which controls how validation errors are displayed.

isAttributeW3CMode

@Deprecated
public boolean isAttributeW3CMode()

Deprecated.

Specified by:

isAttributeW3CMode in interface IXForm

Returns:

true to use only attributes allowed by the W3C spec, false to use the legacy mode.

isElementClassNameMode

@Deprecated
public boolean isElementClassNameMode()

Deprecated.

Specified by:

isElementClassNameMode in interface IXForm

Returns:

true when the name of the element should be added as a CSS style class, false otherwise.

isValidateSubmitAction

@Deprecated
public boolean isValidateSubmitAction()

Deprecated.

Specified by:

isValidateSubmitAction in interface IXForm

Returns:

true when submit buttons should be validated to ensure only existing buttons are pressed.

isLegacyUseOptionTextForAutocomplete

@Deprecated
public boolean isLegacyUseOptionTextForAutocomplete()

Deprecated.

Specified by:

isLegacyUseOptionTextForAutocomplete in interface IXForm

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.