Class FormRenderData

java.lang.Object

de.xima.fc.mdl.form.FormRenderData

All Implemented Interfaces:

Serializable

public class FormRenderData
extends Object
implements Serializable

Class with data for a form render request

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FormRenderData()

Method Summary

Modifier and Type	Method	Description
Map<EFormResourceType, List<IFormResource>>	getClientPluginResourceMap()
List<IFormResource>	getClientPluginResources(EFormResourceType type)
Map<EFormResourceType, List<MandantRessource>>	getClientResourceMap()
List<MandantRessource>	getClientResources(EFormResourceType type)
List<IFormResource>	getCssMandantPluginResources()	Deprecated, for removal: This API element is subject to removal in a future version. use getClientPluginResources(EFormResourceType)
List<MandantRessource>	getCssMandantResources()	Deprecated. use getClientResources(EFormResourceType)
List<ProjektRessource>	getCssProjektResources()	Deprecated, for removal: This API element is subject to removal in a future version. use getProjectResources(EFormResourceType)
List<IFormResource>	getCssSystemPluginResources()	Deprecated, for removal: This API element is subject to removal in a future version. use getSystemPluginResources(EFormResourceType)
IFormDataAdapter	getFormData()
Map<EFormResourceType, List<IFormThemeResource>>	getFormThemResourceMap()	Gets the map with all resources from the form theme that was selected for the currently rendered form.
List<Attachment>	getFormUploadList()
com.alibaba.fastjson.JSONObject	getI18nJson()
List<IFormResource>	getJsMandantPluginResources()	Deprecated, for removal: This API element is subject to removal in a future version. use getClientPluginResources(EFormResourceType)
List<MandantRessource>	getJsMandantResources()	Deprecated, for removal: This API element is subject to removal in a future version. use getClientResources(EFormResourceType)
List<ProjektRessource>	getJsProjektResources()	Deprecated, for removal: This API element is subject to removal in a future version. use getProjectResources(EFormResourceType)
List<IFormResource>	getJsSystemPluginResources()	Deprecated, for removal: This API element is subject to removal in a future version. use getSystemPluginResources(EFormResourceType)
Map<String, IPluginFormPreRenderRetVal>	getPreRenderPluginVals()
Map<EFormResourceType, List<ProjektRessource>>	getProjectResourceMap()
List<ProjektRessource>	getProjectResources(EFormResourceType type)
List<Status>	getProjektStatusList()
Map<EFormResourceType, List<IFormResource>>	getSystemPluginResourceMap()
List<IFormResource>	getSystemPluginResources(EFormResourceType type)
String	getThemeCss()	Deprecated, for removal: This API element is subject to removal in a future version. Themes are more than a single CSS file now.
Set<String>	getThemeCssClasses()	Gets the additional CSS classes that should be added to the form, as indicated by the selected form theme.
boolean	isLegacyUseOptionTextForAutocomplete()
boolean	isValidateSubmitAction()
void	setClientPluginResources(EFormResourceType type, List<IFormResource> resources)
void	setClientResources(EFormResourceType type, List<MandantRessource> resources)
void	setCssMandantPluginResources(List<IFormResource> cssMandantPluginResources)	Deprecated, for removal: This API element is subject to removal in a future version. use setClientPluginResources(EFormResourceType, List)
void	setCssMandantResources(List<MandantRessource> cssMandantResources)	Deprecated, for removal: This API element is subject to removal in a future version. use setClientResources(EFormResourceType, List)
void	setCssProjektResources(List<ProjektRessource> cssProjektResources)	Deprecated, for removal: This API element is subject to removal in a future version. use setProjectResources(EFormResourceType, List)
void	setCssSystemPluginResources(List<IFormResource> cssSystemPluginResources)	Deprecated, for removal: This API element is subject to removal in a future version. use setSystemPluginResources(EFormResourceType, List)
void	setFormData(IFormDataAdapter formData)
void	setFormUploadList(List<Attachment> formUploadList)
void	setI18nJson(com.alibaba.fastjson.JSONObject i18nJson)
void	setJsMandantPluginResources(List<IFormResource> jsMandantPluginResources)	Deprecated, for removal: This API element is subject to removal in a future version. use setClientPluginResources(EFormResourceType, List)
void	setJsMandantResources(List<MandantRessource> jsMandantResources)	Deprecated, for removal: This API element is subject to removal in a future version. use setClientResources(EFormResourceType, List)
void	setJsProjektResources(List<ProjektRessource> jsProjektResources)	Deprecated, for removal: This API element is subject to removal in a future version. use setProjectResources(EFormResourceType, List)
void	setJsSystemPluginResources(List<IFormResource> jsSystemPluginResources)	Deprecated, for removal: This API element is subject to removal in a future version. use setSystemPluginResources(EFormResourceType, List)
void	setLegacyUseOptionTextForAutocomplete(boolean legacyUseOptionTextForAutocomplete)
void	setPreRenderPluginVals(Map<String, IPluginFormPreRenderRetVal> preRenderPluginVals)
void	setProjectResources(EFormResourceType type, List<ProjektRessource> resources)
void	setProjektStatusList(List<Status> projektStatusList)
void	setSystemPluginResources(EFormResourceType type, List<IFormResource> resources)
void	setThemeCss(String themeCss)	Deprecated, for removal: This API element is subject to removal in a future version. Themes are more than a single CSS file now.
void	setThemeCssClasses(Set<String> themeCssClasses)	Sets the additional CSS classes that should be added to the form, as indicated by the selected form theme.
void	setValidateSubmitAction(boolean validateSubmitAction)

Methods inherited from class Object

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

Constructor Details

FormRenderData

public FormRenderData()

Method Details

getProjectResourceMap

public Map<EFormResourceType, List<ProjektRessource>> getProjectResourceMap()

getProjectResources

public List<ProjektRessource> getProjectResources(EFormResourceType type)

setProjectResources

public void setProjectResources(EFormResourceType type,
 List<ProjektRessource> resources)

getClientResourceMap

public Map<EFormResourceType, List<MandantRessource>> getClientResourceMap()

getClientResources

public List<MandantRessource> getClientResources(EFormResourceType type)

setClientResources

public void setClientResources(EFormResourceType type,
 List<MandantRessource> resources)

getClientPluginResourceMap

public Map<EFormResourceType, List<IFormResource>> getClientPluginResourceMap()

getClientPluginResources

public List<IFormResource> getClientPluginResources(EFormResourceType type)

setClientPluginResources

public void setClientPluginResources(EFormResourceType type,
 List<IFormResource> resources)

getFormThemResourceMap

public Map<EFormResourceType, List<IFormThemeResource>> getFormThemResourceMap()

Gets the map with all resources from the form theme that was selected for the currently rendered form.

Returns:

All resources from the currently selected form theme.

getSystemPluginResourceMap

public Map<EFormResourceType, List<IFormResource>> getSystemPluginResourceMap()

getSystemPluginResources

public List<IFormResource> getSystemPluginResources(EFormResourceType type)

setSystemPluginResources

public void setSystemPluginResources(EFormResourceType type,
 List<IFormResource> resources)

getFormUploadList

public List<Attachment> getFormUploadList()

setFormUploadList

public void setFormUploadList(List<Attachment> formUploadList)

getI18nJson

public com.alibaba.fastjson.JSONObject getI18nJson()

setI18nJson

public void setI18nJson(com.alibaba.fastjson.JSONObject i18nJson)

getProjektStatusList

public List<Status> getProjektStatusList()

setProjektStatusList

public void setProjektStatusList(List<Status> projektStatusList)

getThemeCssClasses

public Set<String> getThemeCssClasses()

Gets the additional CSS classes that should be added to the form, as indicated by the selected form theme.

Returns:

The additional CSS classes that should be added to the form.

Since:

8.3.0

setThemeCssClasses

public void setThemeCssClasses(Set<String> themeCssClasses)

Sets the additional CSS classes that should be added to the form, as indicated by the selected form theme.

Parameters:

themeCssClasses - The additional CSS classes that should be added to the form.

Since:

8.3.0

getThemeCss

@Deprecated(forRemoval=true,
            since="8.3.0")
public String getThemeCss()

Deprecated, for removal: This API element is subject to removal in a future version.

Themes are more than a single CSS file now. Use getFormThemResourceMap().

Gets the CSS from the form theme, to be included in the final form.

Returns:

The CSS from the form theme.

setThemeCss

@Deprecated(forRemoval=true,
            since="8.3.0")
public void setThemeCss(String themeCss)

Deprecated, for removal: This API element is subject to removal in a future version.

Themes are more than a single CSS file now. Use getFormThemResourceMap().

Sets the CSS from the form theme, to be included in the final form.

Parameters:

themeCss - The CSS from the form theme.

isValidateSubmitAction

public boolean isValidateSubmitAction()

isLegacyUseOptionTextForAutocomplete

public boolean isLegacyUseOptionTextForAutocomplete()

getPreRenderPluginVals

public Map<String, IPluginFormPreRenderRetVal> getPreRenderPluginVals()

setPreRenderPluginVals

public void setPreRenderPluginVals(Map<String, IPluginFormPreRenderRetVal> preRenderPluginVals)

getFormData

public IFormDataAdapter getFormData()

setFormData

public void setFormData(IFormDataAdapter formData)

getJsMandantResources

@Deprecated(forRemoval=true)
public List<MandantRessource> getJsMandantResources()

Deprecated, for removal: This API element is subject to removal in a future version.

use getClientResources(EFormResourceType)

setJsMandantResources

@Deprecated(forRemoval=true)
public void setJsMandantResources(List<MandantRessource> jsMandantResources)

Deprecated, for removal: This API element is subject to removal in a future version.

use setClientResources(EFormResourceType, List)

getCssMandantResources

@Deprecated
public List<MandantRessource> getCssMandantResources()

Deprecated.

use getClientResources(EFormResourceType)

setCssMandantResources

@Deprecated(forRemoval=true)
public void setCssMandantResources(List<MandantRessource> cssMandantResources)

Deprecated, for removal: This API element is subject to removal in a future version.

use setClientResources(EFormResourceType, List)

getJsProjektResources

@Deprecated(forRemoval=true)
public List<ProjektRessource> getJsProjektResources()

Deprecated, for removal: This API element is subject to removal in a future version.

use getProjectResources(EFormResourceType)

setJsProjektResources

@Deprecated(forRemoval=true)
public void setJsProjektResources(List<ProjektRessource> jsProjektResources)

Deprecated, for removal: This API element is subject to removal in a future version.

use setProjectResources(EFormResourceType, List)

getCssProjektResources

@Deprecated(forRemoval=true)
public List<ProjektRessource> getCssProjektResources()

Deprecated, for removal: This API element is subject to removal in a future version.

use getProjectResources(EFormResourceType)

setCssProjektResources

@Deprecated(forRemoval=true)
public void setCssProjektResources(List<ProjektRessource> cssProjektResources)

Deprecated, for removal: This API element is subject to removal in a future version.

use setProjectResources(EFormResourceType, List)

getJsSystemPluginResources

@Deprecated(forRemoval=true)
public List<IFormResource> getJsSystemPluginResources()

Deprecated, for removal: This API element is subject to removal in a future version.

use getSystemPluginResources(EFormResourceType)

setJsSystemPluginResources

@Deprecated(forRemoval=true)
public void setJsSystemPluginResources(List<IFormResource> jsSystemPluginResources)

Deprecated, for removal: This API element is subject to removal in a future version.

use setSystemPluginResources(EFormResourceType, List)

getCssSystemPluginResources

@Deprecated(forRemoval=true)
public List<IFormResource> getCssSystemPluginResources()

Deprecated, for removal: This API element is subject to removal in a future version.

use getSystemPluginResources(EFormResourceType)

setCssSystemPluginResources

@Deprecated(forRemoval=true)
public void setCssSystemPluginResources(List<IFormResource> cssSystemPluginResources)

Deprecated, for removal: This API element is subject to removal in a future version.

use setSystemPluginResources(EFormResourceType, List)

getJsMandantPluginResources

@Deprecated(forRemoval=true)
public List<IFormResource> getJsMandantPluginResources()

Deprecated, for removal: This API element is subject to removal in a future version.

use getClientPluginResources(EFormResourceType)

setJsMandantPluginResources

@Deprecated(forRemoval=true)
public void setJsMandantPluginResources(List<IFormResource> jsMandantPluginResources)

Deprecated, for removal: This API element is subject to removal in a future version.

use setClientPluginResources(EFormResourceType, List)

getCssMandantPluginResources

@Deprecated(forRemoval=true)
public List<IFormResource> getCssMandantPluginResources()

Deprecated, for removal: This API element is subject to removal in a future version.

use getClientPluginResources(EFormResourceType)

setCssMandantPluginResources

@Deprecated(forRemoval=true)
public void setCssMandantPluginResources(List<IFormResource> cssMandantPluginResources)

Deprecated, for removal: This API element is subject to removal in a future version.

use setClientPluginResources(EFormResourceType, List)

setValidateSubmitAction

public void setValidateSubmitAction(boolean validateSubmitAction)

setLegacyUseOptionTextForAutocomplete

public void setLegacyUseOptionTextForAutocomplete(boolean legacyUseOptionTextForAutocomplete)