Class XFormRenderConfig

java.lang.Object

de.xima.fc.form.common.models.XFormRenderConfig

All Implemented Interfaces:

IXFormRenderConfig, Serializable

Direct Known Subclasses:

XFormConfig

public class XFormRenderConfig
extends Object
implements IXFormRenderConfig

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
XFormRenderConfig()	Creates a new form render config with no data yet.

Method Summary

Modifier and Type	Method	Description
void	addCustomFormNode(com.hp.gagawa.java.Node customNode)
void	addValidationError(String itemId, String error)	Adds a server validation message for the given form element.
IFD2AppointmentProvider	getAppointmentProvider()
String	getAttachmentDeleteURL()
String	getAttachmentDownloadURL()
String	getBaseIncludeUrl()
String	getBotFieldAutocomplete()
String	getBotFieldName()
XButtonDescriptor	getButtonDescriptor()
long	getClientId()
LinkedHashMap<String,String>	getCssIncludes()
List<com.hp.gagawa.java.Node>	getCustomFormNodes()
IFD2DataSourceProvider	getDataSourceProvider()
String	getFormAction()
com.alibaba.fastjson.JSONObject	getFormI18n()
com.alibaba.fastjson.JSONObject	getI18N()
String	getI18NValue(String key)
LinkedHashMap<String,String>	getJsIncludes()
String	getLang()
IFD2LanguageProvider	getLanguageProvider()	Getter für languageProvider
IFD2LicenseDataProvider	getLicenseDataProvider()
IFD2MetaDataProvider	getMetaDataProvider()
long	getProjektID()
IFD2RenderCallbackProvider	getRenderCallbackProvider()
IFD2ReplacerProvider	getReplacerProvider()
IFD2StatusProvider	getStatusProvider()
IFD2TemplateProvider	getTemplateProvider()
String	getThemeCss()	Gets the CSS content from the selected form theme.
Set<String>	getThemeCssClasses()	Gets the additional CSS classes that should be added to the form, as defined by the selected form theme.
String	getTitle()
IFD2UserGroupProvider	getUserGroupProvider()
Map<String, List<String>>	getValidationErrors()
List<String>	getValidationErrors(String itemId)
IFD2VRulesProvider	getVRulesProvider()
XFormProperties	getXFormProperties()
IFD2XItemProvider	getXItemProvider()
XItemConditionsWrapper	getxItemRenderConditions()
boolean	isDesignerPreview()
boolean	isForceBranding()
boolean	isForceFullyInline()
boolean	isForceInline()
boolean	isFormOnly()
boolean	isHideRequiredHint()
boolean	isIgnoreRenderConditions()
boolean	isLegacyUseOptionTextForAutocomplete()
boolean	isPreview()
boolean	isPublish()
boolean	isSkipPlaceholder()
boolean	isUsebs()
boolean	isUsecss()
boolean	isUsejq()
boolean	isUseui()
boolean	isValidateSubmitAction()
void	setAppointmentProvider(IFD2AppointmentProvider appoinmentProvider)
void	setAttachmentDeleteURL(String attachmentDeleteURL)
void	setAttachmentDownloadURL(String attachmentDownloadURL)
void	setBaseIncludeUrl(String baseIncludeUrl)
void	setBotFieldAutocomplete(String botFieldAutocomplete)
void	setBotFieldName(String botFieldName)
void	setButtonDescriptor(XButtonDescriptor buttonDescriptor)
void	setClientId(long clientId)
void	setCssIncludes(LinkedHashMap<String,String> cssIncludes)
void	setCustomFormNodes(List<com.hp.gagawa.java.Node> customFormNodes)
void	setDataSourceProvider(IFD2DataSourceProvider dataSourceProvider)	Setter des dataSourceProvider
void	setDesignerPreview(boolean designerPreview)
void	setForceBranding(boolean forceBranding)
void	setForceFullyInline(boolean forceFullyInline)
void	setForceInline(boolean forceInline)
void	setFormAction(String formAction)
void	setFormI18n(com.alibaba.fastjson.JSONObject formI18n)
void	setFormOnly(boolean formOnly)
void	setHideRequiredHint(boolean isHideRequiredHint)
void	setIgnoreRenderConditions(boolean ignoreRenderConditions)
void	setJsIncludes(LinkedHashMap<String,String> jsIncludes)
void	setLang(String lang)
void	setLanguageProvider(IFD2LanguageProvider languageProvider)	Setter des languageProvider
void	setLegacyUseOptionTextForAutocomplete(boolean legacyUseOptionTextForAutocomplete)
void	setLicenseDataProvider(IFD2LicenseDataProvider licenseDataProvider)
void	setMetaDataProvider(IFD2MetaDataProvider metaDataProvider)
void	setPreview(boolean isPreview)
void	setProjektID(long projektID)
void	setPublish(boolean isPublish)
void	setRenderCallbackProvider(IFD2RenderCallbackProvider renderCallbackProvider)
void	setReplacerProvider(IFD2ReplacerProvider replacerProvider)
void	setSkipPlaceholder(boolean skipPlaceholder)
void	setStatusProvider(IFD2StatusProvider statusProvider)
void	setTemplateProvider(IFD2TemplateProvider templateProvider)
void	setThemeCss(String themeCss)	Sets the CSS content from the selected form theme
void	setThemeCssClasses(Set<String> themeCssClasses)	Sets the additional CSS classes that should be added to the form, as defined by the selected form theme.
void	setTitle(String title)
void	setUsebs(boolean usebs)
void	setUsecss(boolean usecss)
void	setUsejq(boolean usejq)
void	setUserGroupProvider(IFD2UserGroupProvider userGroupProvider)
void	setUseui(boolean useui)
void	setValidateSubmitAction(boolean validateSubmitAction)
void	setValidationErrors(Map<String, List<String>> validationErrors)
void	setVRulesProvider(IFD2VRulesProvider vrulesProvider)
void	setXFormProperties(XFormProperties xFormProperties)
void	setXItemProvider(IFD2XItemProvider xItemProvider)
void	setXItemRenderConditions(XItemConditionsWrapper xItemRenderConditions)

Methods inherited from class Object

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

Methods inherited from interface IXFormRenderConfig

addValidationError, addXFormRessource, getXFormProperty, getXFormPropertyI18n, getXFormPropertyI18n, isDemoAccount, setDemoAccount

Constructor Details

XFormRenderConfig

public XFormRenderConfig()

Creates a new form render config with no data yet.

Method Details

getFormAction

public String getFormAction()

Specified by:

getFormAction in interface IXFormRenderConfig

setFormAction

public void setFormAction(String formAction)

Specified by:

setFormAction in interface IXFormRenderConfig

getBaseIncludeUrl

public String getBaseIncludeUrl()

Specified by:

getBaseIncludeUrl in interface IXFormRenderConfig

setBaseIncludeUrl

public void setBaseIncludeUrl(String baseIncludeUrl)

Specified by:

setBaseIncludeUrl in interface IXFormRenderConfig

isFormOnly

public boolean isFormOnly()

Specified by:

isFormOnly in interface IXFormRenderConfig

setFormOnly

public void setFormOnly(boolean formOnly)

Specified by:

setFormOnly in interface IXFormRenderConfig

getTitle

public String getTitle()

Specified by:

getTitle in interface IXFormRenderConfig

setTitle

public void setTitle(String title)

Specified by:

setTitle in interface IXFormRenderConfig

isSkipPlaceholder

public boolean isSkipPlaceholder()

Specified by:

isSkipPlaceholder in interface IXFormRenderConfig

setSkipPlaceholder

public void setSkipPlaceholder(boolean skipPlaceholder)

Specified by:

setSkipPlaceholder in interface IXFormRenderConfig

isPreview

public boolean isPreview()

Specified by:

isPreview in interface IXFormRenderConfig

setPreview

public void setPreview(boolean isPreview)

Specified by:

setPreview in interface IXFormRenderConfig

getLang

public String getLang()

Specified by:

getLang in interface IXFormRenderConfig

setLang

public void setLang(String lang)

Specified by:

setLang in interface IXFormRenderConfig

getBotFieldName

public String getBotFieldName()

Specified by:

getBotFieldName in interface IXFormRenderConfig

Returns:

The name of the invisible bot field used as a honey trap to detect bots. When a form is submitted where this field has a value, the form submission is rejected.

setBotFieldName

public void setBotFieldName(String botFieldName)

Specified by:

setBotFieldName in interface IXFormRenderConfig

Parameters:

botFieldName - The name of the invisible bot field used as a honey trap to detect bots. When a form is submitted where this field has a value, the form submission is rejected.

getBotFieldAutocomplete

public String getBotFieldAutocomplete()

Specified by:

getBotFieldAutocomplete in interface IXFormRenderConfig

Returns:

The value for the autocomplete attribute of the invisible bot field. When null, empty, or blank, the autocomplete property is not set on the bot field.

setBotFieldAutocomplete

public void setBotFieldAutocomplete(String botFieldAutocomplete)

Specified by:

setBotFieldAutocomplete in interface IXFormRenderConfig

Parameters:

botFieldAutocomplete - The value for the autocomplete attribute of the invisible bot field. When null, empty, or blank, the autocomplete property is not set on the bot field.

getxItemRenderConditions

public XItemConditionsWrapper getxItemRenderConditions()

Specified by:

getxItemRenderConditions in interface IXFormRenderConfig

setXItemRenderConditions

public void setXItemRenderConditions(XItemConditionsWrapper xItemRenderConditions)

Specified by:

setXItemRenderConditions in interface IXFormRenderConfig

getDataSourceProvider

public IFD2DataSourceProvider getDataSourceProvider()

Specified by:

getDataSourceProvider in interface IXFormRenderConfig

setDataSourceProvider

public void setDataSourceProvider(IFD2DataSourceProvider dataSourceProvider)

Description copied from interface: IXFormRenderConfig

Setter des dataSourceProvider

Specified by:

setDataSourceProvider in interface IXFormRenderConfig

Parameters:

dataSourceProvider - IFD2DataSourceProvider der zu setzende dataSourceProvider

setLanguageProvider

public void setLanguageProvider(IFD2LanguageProvider languageProvider)

Description copied from interface: IXFormRenderConfig

Setter des languageProvider

Specified by:

setLanguageProvider in interface IXFormRenderConfig

Parameters:

languageProvider - IFD2LanguageProvider der zu setzende languageProvider

getLanguageProvider

public IFD2LanguageProvider getLanguageProvider()

Description copied from interface: IXFormRenderConfig

Getter für languageProvider

Specified by:

getLanguageProvider in interface IXFormRenderConfig

Returns:

IFD2LanguageProvider des languageProvider

getLicenseDataProvider

public IFD2LicenseDataProvider getLicenseDataProvider()

Specified by:

getLicenseDataProvider in interface IXFormRenderConfig

setLicenseDataProvider

public void setLicenseDataProvider(IFD2LicenseDataProvider licenseDataProvider)

Specified by:

setLicenseDataProvider in interface IXFormRenderConfig

getI18N

public com.alibaba.fastjson.JSONObject getI18N()

Specified by:

getI18N in interface IXFormRenderConfig

getI18NValue

public String getI18NValue(String key)

Specified by:

getI18NValue in interface IXFormRenderConfig

isUsejq

public boolean isUsejq()

Specified by:

isUsejq in interface IXFormRenderConfig

setUsejq

public void setUsejq(boolean usejq)

Specified by:

setUsejq in interface IXFormRenderConfig

isUseui

public boolean isUseui()

Specified by:

isUseui in interface IXFormRenderConfig

setUseui

public void setUseui(boolean useui)

Specified by:

setUseui in interface IXFormRenderConfig

isUsebs

public boolean isUsebs()

Specified by:

isUsebs in interface IXFormRenderConfig

setUsebs

public void setUsebs(boolean usebs)

Specified by:

setUsebs in interface IXFormRenderConfig

isUsecss

public boolean isUsecss()

Specified by:

isUsecss in interface IXFormRenderConfig

setUsecss

public void setUsecss(boolean usecss)

Specified by:

setUsecss in interface IXFormRenderConfig

isForceInline

public boolean isForceInline()

Specified by:

isForceInline in interface IXFormRenderConfig

setForceInline

public void setForceInline(boolean forceInline)

Specified by:

setForceInline in interface IXFormRenderConfig

isForceFullyInline

public boolean isForceFullyInline()

Specified by:

isForceFullyInline in interface IXFormRenderConfig

setForceFullyInline

public void setForceFullyInline(boolean forceFullyInline)

Specified by:

setForceFullyInline in interface IXFormRenderConfig

getMetaDataProvider

public IFD2MetaDataProvider getMetaDataProvider()

Specified by:

getMetaDataProvider in interface IXFormRenderConfig

setMetaDataProvider

public void setMetaDataProvider(IFD2MetaDataProvider metaDataProvider)

Specified by:

setMetaDataProvider in interface IXFormRenderConfig

getReplacerProvider

public IFD2ReplacerProvider getReplacerProvider()

Specified by:

getReplacerProvider in interface IXFormRenderConfig

setReplacerProvider

public void setReplacerProvider(IFD2ReplacerProvider replacerProvider)

Specified by:

setReplacerProvider in interface IXFormRenderConfig

getStatusProvider

public IFD2StatusProvider getStatusProvider()

Specified by:

getStatusProvider in interface IXFormRenderConfig

setStatusProvider

public void setStatusProvider(IFD2StatusProvider statusProvider)

Specified by:

setStatusProvider in interface IXFormRenderConfig

getUserGroupProvider

public IFD2UserGroupProvider getUserGroupProvider()

Specified by:

getUserGroupProvider in interface IXFormRenderConfig

setUserGroupProvider

public void setUserGroupProvider(IFD2UserGroupProvider userGroupProvider)

Specified by:

setUserGroupProvider in interface IXFormRenderConfig

getVRulesProvider

public IFD2VRulesProvider getVRulesProvider()

Specified by:

getVRulesProvider in interface IXFormRenderConfig

setVRulesProvider

public void setVRulesProvider(IFD2VRulesProvider vrulesProvider)

Specified by:

setVRulesProvider in interface IXFormRenderConfig

getAttachmentDownloadURL

public String getAttachmentDownloadURL()

Specified by:

getAttachmentDownloadURL in interface IXFormRenderConfig

setAttachmentDownloadURL

public void setAttachmentDownloadURL(String attachmentDownloadURL)

Specified by:

setAttachmentDownloadURL in interface IXFormRenderConfig

getAppointmentProvider

public IFD2AppointmentProvider getAppointmentProvider()

Specified by:

getAppointmentProvider in interface IXFormRenderConfig

Returns:

The current provider for accessing appointments and appointment templates.

setAppointmentProvider

public void setAppointmentProvider(IFD2AppointmentProvider appoinmentProvider)

Specified by:

setAppointmentProvider in interface IXFormRenderConfig

Parameters:

appoinmentProvider - The provider to use for accessing appointments and appointment templates.

getTemplateProvider

public IFD2TemplateProvider getTemplateProvider()

Specified by:

getTemplateProvider in interface IXFormRenderConfig

setTemplateProvider

public void setTemplateProvider(IFD2TemplateProvider templateProvider)

Specified by:

setTemplateProvider in interface IXFormRenderConfig

getAttachmentDeleteURL

public String getAttachmentDeleteURL()

Specified by:

getAttachmentDeleteURL in interface IXFormRenderConfig

setAttachmentDeleteURL

public void setAttachmentDeleteURL(String attachmentDeleteURL)

Specified by:

setAttachmentDeleteURL in interface IXFormRenderConfig

getProjektID

public long getProjektID()

Specified by:

getProjektID in interface IXFormRenderConfig

setProjektID

public void setProjektID(long projektID)

Specified by:

setProjektID in interface IXFormRenderConfig

getCustomFormNodes

public List<com.hp.gagawa.java.Node> getCustomFormNodes()

Specified by:

getCustomFormNodes in interface IXFormRenderConfig

setCustomFormNodes

public void setCustomFormNodes(List<com.hp.gagawa.java.Node> customFormNodes)

Specified by:

setCustomFormNodes in interface IXFormRenderConfig

addCustomFormNode

public void addCustomFormNode(com.hp.gagawa.java.Node customNode)

Specified by:

addCustomFormNode in interface IXFormRenderConfig

getJsIncludes

public LinkedHashMap<String,String> getJsIncludes()

Specified by:

getJsIncludes in interface IXFormRenderConfig

setJsIncludes

public void setJsIncludes(LinkedHashMap<String,String> jsIncludes)

Specified by:

setJsIncludes in interface IXFormRenderConfig

getClientId

public long getClientId()

Specified by:

getClientId in interface IXFormRenderConfig

Returns:

ID of the client that owns the form to be rendered.

setClientId

public void setClientId(long clientId)

Specified by:

setClientId in interface IXFormRenderConfig

Parameters:

clientId - ID of the client that owns the form to be rendered.

getCssIncludes

public LinkedHashMap<String,String> getCssIncludes()

Specified by:

getCssIncludes in interface IXFormRenderConfig

setCssIncludes

public void setCssIncludes(LinkedHashMap<String,String> cssIncludes)

Specified by:

setCssIncludes in interface IXFormRenderConfig

addValidationError

public void addValidationError(String itemId,
 String error)

Description copied from interface: IXFormRenderConfig

Adds a server validation message for the given form element. This message is redisplayed in the form in the browser.

Specified by:

addValidationError in interface IXFormRenderConfig

Parameters:

itemId - Full ID of a form element, e.g. xi-tf-1 (non-repeated) or xi-tf-1_c_99 (repeated element).

error - Error message to add.

getValidationErrors

public Map<String, List<String>> getValidationErrors()

Specified by:

getValidationErrors in interface IXFormRenderConfig

setValidationErrors

public void setValidationErrors(Map<String, List<String>> validationErrors)

Specified by:

setValidationErrors in interface IXFormRenderConfig

getValidationErrors

public List<String> getValidationErrors(String itemId)

Specified by:

getValidationErrors in interface IXFormRenderConfig

getThemeCssClasses

public Set<String> getThemeCssClasses()

Description copied from interface: IXFormRenderConfig

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

Specified by:

getThemeCssClasses in interface IXFormRenderConfig

Returns:

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

setThemeCssClasses

public void setThemeCssClasses(Set<String> themeCssClasses)

Description copied from interface: IXFormRenderConfig

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

Specified by:

setThemeCssClasses in interface IXFormRenderConfig

Parameters:

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

getThemeCss

public String getThemeCss()

Description copied from interface: IXFormRenderConfig

Gets the CSS content from the selected form theme.

Specified by:

getThemeCss in interface IXFormRenderConfig

Returns:

The CSS content from the selected form theme

setThemeCss

public void setThemeCss(String themeCss)

Description copied from interface: IXFormRenderConfig

Sets the CSS content from the selected form theme

Specified by:

setThemeCss in interface IXFormRenderConfig

Parameters:

themeCss - The CSS content from the selected form theme

getRenderCallbackProvider

public IFD2RenderCallbackProvider getRenderCallbackProvider()

Specified by:

getRenderCallbackProvider in interface IXFormRenderConfig

Returns:

The configured render callback provider.

setRenderCallbackProvider

public void setRenderCallbackProvider(IFD2RenderCallbackProvider renderCallbackProvider)

Specified by:

setRenderCallbackProvider in interface IXFormRenderConfig

Parameters:

renderCallbackProvider - The new render callback provider to use.

getXItemProvider

public IFD2XItemProvider getXItemProvider()

Specified by:

getXItemProvider in interface IXFormRenderConfig

setXItemProvider

public void setXItemProvider(IFD2XItemProvider xItemProvider)

Specified by:

setXItemProvider in interface IXFormRenderConfig

isPublish

public boolean isPublish()

Specified by:

isPublish in interface IXFormRenderConfig

setPublish

public void setPublish(boolean isPublish)

Specified by:

setPublish in interface IXFormRenderConfig

isIgnoreRenderConditions

public boolean isIgnoreRenderConditions()

Specified by:

isIgnoreRenderConditions in interface IXFormRenderConfig

setIgnoreRenderConditions

public void setIgnoreRenderConditions(boolean ignoreRenderConditions)

Specified by:

setIgnoreRenderConditions in interface IXFormRenderConfig

isDesignerPreview

public boolean isDesignerPreview()

Specified by:

isDesignerPreview in interface IXFormRenderConfig

setDesignerPreview

public void setDesignerPreview(boolean designerPreview)

Specified by:

setDesignerPreview in interface IXFormRenderConfig

isValidateSubmitAction

public boolean isValidateSubmitAction()

Specified by:

isValidateSubmitAction in interface IXFormRenderConfig

Returns:

true if the transmitted submit button name used to submit the form needs to be validated (whether such a button really existed), or false otherwise.

setValidateSubmitAction

public void setValidateSubmitAction(boolean validateSubmitAction)

Specified by:

setValidateSubmitAction in interface IXFormRenderConfig

Parameters:

validateSubmitAction - true if the transmitted submit button name used to submit the form needs to be validated (whether such a button really existed), or false otherwise.

isLegacyUseOptionTextForAutocomplete

public boolean isLegacyUseOptionTextForAutocomplete()

Specified by:

isLegacyUseOptionTextForAutocomplete in interface IXFormRenderConfig

Returns:

true to use the legacy behavior where the option text of autocomplete elements was used when evaluating conditions.

setLegacyUseOptionTextForAutocomplete

public void setLegacyUseOptionTextForAutocomplete(boolean legacyUseOptionTextForAutocomplete)

Specified by:

setLegacyUseOptionTextForAutocomplete in interface IXFormRenderConfig

Parameters:

legacyUseOptionTextForAutocomplete - true to use the legacy behavior where the option text of autocomplete elements was used when evaluating conditions.

setForceBranding

public void setForceBranding(boolean forceBranding)

Specified by:

setForceBranding in interface IXFormRenderConfig

isForceBranding

public boolean isForceBranding()

Specified by:

isForceBranding in interface IXFormRenderConfig

isHideRequiredHint

public boolean isHideRequiredHint()

Specified by:

isHideRequiredHint in interface IXFormRenderConfig

setHideRequiredHint

public void setHideRequiredHint(boolean isHideRequiredHint)

Specified by:

setHideRequiredHint in interface IXFormRenderConfig

getButtonDescriptor

public XButtonDescriptor getButtonDescriptor()

Specified by:

getButtonDescriptor in interface IXFormRenderConfig

setButtonDescriptor

public void setButtonDescriptor(XButtonDescriptor buttonDescriptor)

Specified by:

setButtonDescriptor in interface IXFormRenderConfig

getXFormProperties

public XFormProperties getXFormProperties()

Specified by:

getXFormProperties in interface IXFormRenderConfig

setXFormProperties

public void setXFormProperties(XFormProperties xFormProperties)

Specified by:

setXFormProperties in interface IXFormRenderConfig

getFormI18n

public com.alibaba.fastjson.JSONObject getFormI18n()

Specified by:

getFormI18n in interface IXFormRenderConfig

setFormI18n

public void setFormI18n(com.alibaba.fastjson.JSONObject formI18n)

Specified by:

setFormI18n in interface IXFormRenderConfig