All Superinterfaces:

Serializable

All Known Implementing Classes:

LanguageFd2Config, XFormConfig, XFormRenderConfig, XFormRenderConfigWithCurrentData
```
public interface IXFormRenderConfig
extends Serializable
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addCustomFormNode(com.hp.gagawa.java.Node customNode)`
`default void`	`addValidationError(String baseId, Integer repetitionId, String error)`	Adds a server validation message for the given form element.
`void`	`addValidationError(String itemId, String error)`	Adds a server validation message for the given form element.
`default void`	`addXFormRessource(EFormResourceType type, String path, String value)`	Deprecated.
`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()`	Deprecated, for removal: This API element is subject to removal in a future version. The form theme now consists of multiple CSS and JS files, which are included in the `getCssIncludes()` and `getJsIncludes()`.
`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()`
`default XPropertyValue`	`getXFormProperty(String property)`
`default String`	`getXFormPropertyI18n(XFormPropertyEnum property)`
`default String`	`getXFormPropertyI18n(String property)`
`IFD2XItemProvider`	`getXItemProvider()`
`XItemConditionsWrapper`	`getxItemRenderConditions()`
`default boolean`	`isDemoAccount()`	Deprecated.
`boolean`	`isDesignerPreview()`
`boolean`	`isForceBranding()`
`boolean`	`isForceFullyInline()`
`boolean`	`isForceInline()`
`boolean`	`isFormOnly()`
`boolean`	`isHideRequiredHint()`
`boolean`	`isIgnoreRenderConditions()`
`default boolean`	`isLegacyUseOptionTextForAutocomplete()`	Deprecated. Use `getXFormProperties()`.
`boolean`	`isPreview()`
`boolean`	`isPublish()`
`boolean`	`isSkipPlaceholder()`
`boolean`	`isUsebs()`
`boolean`	`isUsecss()`
`boolean`	`isUsejq()`
`boolean`	`isUseui()`
`default boolean`	`isValidateSubmitAction()`	Deprecated. Use `getXFormProperties()`.
`void`	`setAppointmentProvider(IFD2AppointmentProvider appoinmentProvider)`
`void`	`setAttachmentDeleteURL(String attachmentDeleteURL)`
`void`	`setAttachmentDownloadURL(String attachmentDownloadURL)`
`void`	`setBaseIncludeUrl(String url)`
`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
`default void`	`setDemoAccount(boolean isDemoAccount)`	Deprecated.
`void`	`setDesignerPreview(boolean isDesignerPreview)`
`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
`default void`	`setLegacyUseOptionTextForAutocomplete(boolean legacyUseOptionTextForAutocomplete)`	Deprecated. Use `getXFormProperties()`.
`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 preview)`
`void`	`setStatusProvider(IFD2StatusProvider statusProvider)`
`void`	`setTemplateProvider(IFD2TemplateProvider templateProvider)`
`void`	`setThemeCss(String themeCss)`	Deprecated, for removal: This API element is subject to removal in a future version. The form theme now consists of multiple CSS and JS files, which are included in the `getCssIncludes()` and `getJsIncludes()`.
`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)`
`default void`	`setValidateSubmitAction(boolean validateSubmitAction)`	Deprecated. Use `getXFormProperties()`.
`void`	`setValidationErrors(Map<String,List<String>> validationErrors)`
`void`	`setVRulesProvider(IFD2VRulesProvider vrulesProvider)`
`void`	`setXFormProperties(XFormProperties formProperties)`
`void`	`setXItemProvider(IFD2XItemProvider xItemProvider)`
`void`	`setXItemRenderConditions(XItemConditionsWrapper xItemRenderConditions)`

- Method Detail
  - setDesignerPreview
```
void setDesignerPreview(boolean isDesignerPreview)
```
  - isDesignerPreview
```
boolean isDesignerPreview()
```
  - getBaseIncludeUrl
```
String getBaseIncludeUrl()
```
  - setBaseIncludeUrl
```
void setBaseIncludeUrl(String url)
```
  - getFormAction
```
String getFormAction()
```
  - setFormAction
```
void setFormAction(String formAction)
```
  - isFormOnly
```
boolean isFormOnly()
```
  - setFormOnly
```
void setFormOnly(boolean formOnly)
```
  - getTitle
```
String getTitle()
```
  - setTitle
```
void setTitle(String title)
```
  - isSkipPlaceholder
```
boolean isSkipPlaceholder()
```
  - setSkipPlaceholder
```
void setSkipPlaceholder(boolean preview)
```
  - isPreview
```
boolean isPreview()
```
  - setPreview
```
void setPreview(boolean isPreview)
```
  - isPublish
```
boolean isPublish()
```
  - setPublish
```
void setPublish(boolean isPublish)
```
  - getLang
```
String getLang()
```
  - setLang
```
void setLang(String lang)
```
  - getBotFieldName
```
String getBotFieldName()
```
    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
```
void setBotFieldName(String botFieldName)
```
    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
```
String getBotFieldAutocomplete()
```
    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
```
void setBotFieldAutocomplete(String botFieldAutocomplete)
```
    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
```
XItemConditionsWrapper getxItemRenderConditions()
```
  - setXItemRenderConditions
```
void setXItemRenderConditions(XItemConditionsWrapper xItemRenderConditions)
```
  - getDataSourceProvider
```
IFD2DataSourceProvider getDataSourceProvider()
```
  - getXItemProvider
```
IFD2XItemProvider getXItemProvider()
```
  - setDataSourceProvider
```
void setDataSourceProvider(IFD2DataSourceProvider dataSourceProvider)
```
    Setter des dataSourceProvider
    
    Parameters:
    
    dataSourceProvider - IFD2DataSourceProvider der zu setzende dataSourceProvider
  - setLanguageProvider
```
void setLanguageProvider(IFD2LanguageProvider languageProvider)
```
    Setter des languageProvider
    
    Parameters:
    
    languageProvider - IFD2LanguageProvider der zu setzende languageProvider
  - getLanguageProvider
```
IFD2LanguageProvider getLanguageProvider()
```
    Getter für languageProvider
    
    Returns:
    
    IFD2LanguageProvider des languageProvider
  - getRenderCallbackProvider
```
IFD2RenderCallbackProvider getRenderCallbackProvider()
```
    Returns:
    
    The configured render callback provider.
  - setRenderCallbackProvider
```
void setRenderCallbackProvider(IFD2RenderCallbackProvider renderCallbackProvider)
```
    Parameters:
    
    renderCallbackProvider - The new render callback provider to use.
  - setLicenseDataProvider
```
void setLicenseDataProvider(IFD2LicenseDataProvider licenseDataProvider)
```
  - getLicenseDataProvider
```
IFD2LicenseDataProvider getLicenseDataProvider()
```
  - getI18N
```
com.alibaba.fastjson.JSONObject getI18N()
```
  - getI18NValue
```
String getI18NValue(String key)
```
  - isUsejq
```
boolean isUsejq()
```
  - setUsejq
```
void setUsejq(boolean usejq)
```
  - isUseui
```
boolean isUseui()
```
  - setUseui
```
void setUseui(boolean useui)
```
  - isUsebs
```
boolean isUsebs()
```
  - setUsebs
```
void setUsebs(boolean usebs)
```
  - isUsecss
```
boolean isUsecss()
```
  - setUsecss
```
void setUsecss(boolean usecss)
```
  - isForceInline
```
boolean isForceInline()
```
  - setForceInline
```
void setForceInline(boolean forceInline)
```
  - isForceFullyInline
```
boolean isForceFullyInline()
```
  - setForceFullyInline
```
void setForceFullyInline(boolean forceFullyInline)
```
  - getMetaDataProvider
```
IFD2MetaDataProvider getMetaDataProvider()
```
  - setMetaDataProvider
```
void setMetaDataProvider(IFD2MetaDataProvider metaDataProvider)
```
  - getStatusProvider
```
IFD2StatusProvider getStatusProvider()
```
  - setStatusProvider
```
void setStatusProvider(IFD2StatusProvider statusProvider)
```
  - getUserGroupProvider
```
IFD2UserGroupProvider getUserGroupProvider()
```
  - setUserGroupProvider
```
void setUserGroupProvider(IFD2UserGroupProvider userGroupProvider)
```
  - setReplacerProvider
```
void setReplacerProvider(IFD2ReplacerProvider replacerProvider)
```
  - getReplacerProvider
```
IFD2ReplacerProvider getReplacerProvider()
```
  - getAttachmentDownloadURL
```
String getAttachmentDownloadURL()
```
  - setAttachmentDownloadURL
```
void setAttachmentDownloadURL(String attachmentDownloadURL)
```
  - getAttachmentDeleteURL
```
String getAttachmentDeleteURL()
```
  - setAttachmentDeleteURL
```
void setAttachmentDeleteURL(String attachmentDeleteURL)
```
  - getProjektID
```
long getProjektID()
```
  - setProjektID
```
void setProjektID(long projektID)
```
  - getCustomFormNodes
```
List<com.hp.gagawa.java.Node> getCustomFormNodes()
```
  - setCustomFormNodes
```
void setCustomFormNodes(List<com.hp.gagawa.java.Node> customFormNodes)
```
  - addCustomFormNode
```
void addCustomFormNode(com.hp.gagawa.java.Node customNode)
```
  - getJsIncludes
```
LinkedHashMap<String,String> getJsIncludes()
```
  - setJsIncludes
```
void setJsIncludes(LinkedHashMap<String,String> jsIncludes)
```
  - getCssIncludes
```
LinkedHashMap<String,String> getCssIncludes()
```
  - getClientId
```
long getClientId()
```
    Returns:
    
    ID of the client that owns the form to be rendered.
  - setClientId
```
void setClientId(long clientId)
```
    Parameters:
    
    clientId - ID of the client that owns the form to be rendered.
  - setCssIncludes
```
void setCssIncludes(LinkedHashMap<String,String> cssIncludes)
```
  - addValidationError
```
void addValidationError(String itemId,
                        String error)
```
    Adds a server validation message for the given form element. This message is redisplayed in the form in the browser.
    
    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.
  - addValidationError
```
default void addValidationError(String baseId,
                                Integer repetitionId,
                                String error)
```
    Adds a server validation message for the given form element. This message is redisplayed in the form in the browser. This method adds a message for a repeated element. This is equivalent to calling addValidationError(String, String) with the full ID of the element.
    
    Parameters:
    
    baseId - Base ID of the non-repeated form element, e.g. xi-tf-1 (and NOT xi-tf-1_c_99).
    
    repetitionId - Repetition ID of the repeated element. Note that this is not the ordinal ID which always starts at 0. When there are three repetitions of a form element, they could have the repetition IDs 3, 25, and 99. When null or negative, the element is treated as non-repeated and only the base ID is used.
    
    error - Error message to add.
  - getValidationErrors
```
Map<String,List<String>> getValidationErrors()
```
  - setValidationErrors
```
void setValidationErrors(Map<String,List<String>> validationErrors)
```
  - getValidationErrors
```
List<String> getValidationErrors(String itemId)
```
  - getThemeCss
```
@Deprecated(forRemoval=true,
            since="8.3.0")
String getThemeCss()
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    The form theme now consists of multiple CSS and JS files, which are included in the getCssIncludes() and getJsIncludes().
    
    Gets the CSS content from the selected form theme.
    
    Returns:
    
    The CSS content from the selected form theme
  - setThemeCss
```
@Deprecated(forRemoval=true,
            since="8.3.0")
void setThemeCss(String themeCss)
```
    Deprecated, for removal: This API element is subject to removal in a future version.
    The form theme now consists of multiple CSS and JS files, which are included in the getCssIncludes() and getJsIncludes().
    
    Sets the CSS content from the selected form theme
    
    Parameters:
    
    themeCss - The CSS content from the selected form theme
  - getThemeCssClasses
```
Set<String> getThemeCssClasses()
```
    Gets the additional CSS classes that should be added to the form, as defined by the selected form theme.
    
    Returns:
    
    The additional CSS classes that should be added to the form.
    
    Since:
    
    8.3.0
  - setThemeCssClasses
```
void setThemeCssClasses(Set<String> themeCssClasses)
```
    Sets the additional CSS classes that should be added to the form, as defined by the selected form theme.
    
    Parameters:
    
    themeCssClasses - The additional CSS classes that should be added to the form.
    
    Since:
    
    8.3.0
  - getVRulesProvider
```
IFD2VRulesProvider getVRulesProvider()
```
  - setVRulesProvider
```
void setVRulesProvider(IFD2VRulesProvider vrulesProvider)
```
  - setXItemProvider
```
void setXItemProvider(IFD2XItemProvider xItemProvider)
```
  - setForceBranding
```
void setForceBranding(boolean forceBranding)
```
  - isForceBranding
```
boolean isForceBranding()
```
  - isHideRequiredHint
```
boolean isHideRequiredHint()
```
  - setHideRequiredHint
```
void setHideRequiredHint(boolean isHideRequiredHint)
```
  - getButtonDescriptor
```
XButtonDescriptor getButtonDescriptor()
```
  - setButtonDescriptor
```
void setButtonDescriptor(XButtonDescriptor buttonDescriptor)
```
  - isDemoAccount
```
@Deprecated
default boolean isDemoAccount()
```
    Deprecated.
  - setDemoAccount
```
@Deprecated
default void setDemoAccount(boolean isDemoAccount)
```
    Deprecated.
  - addXFormRessource
```
@Deprecated
default void addXFormRessource(EFormResourceType type,
                               String path,
                               String value)
```
    Deprecated.
  - setIgnoreRenderConditions
```
void setIgnoreRenderConditions(boolean ignoreRenderConditions)
```
  - isIgnoreRenderConditions
```
boolean isIgnoreRenderConditions()
```
  - getAppointmentProvider
```
IFD2AppointmentProvider getAppointmentProvider()
```
    Returns:
    
    The current provider for accessing appointments and appointment templates.
  - setAppointmentProvider
```
void setAppointmentProvider(IFD2AppointmentProvider appoinmentProvider)
```
    Parameters:
    
    appoinmentProvider - The provider to use for accessing appointments and appointment templates.
  - getTemplateProvider
```
IFD2TemplateProvider getTemplateProvider()
```
  - setTemplateProvider
```
void setTemplateProvider(IFD2TemplateProvider templateProvider)
```
  - isValidateSubmitAction
```
@Deprecated
default boolean isValidateSubmitAction()
```
    Deprecated.
    Use getXFormProperties().
    
    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
```
@Deprecated
default void setValidateSubmitAction(boolean validateSubmitAction)
```
    Deprecated.
    Use getXFormProperties().
    
    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
```
@Deprecated
default boolean isLegacyUseOptionTextForAutocomplete()
```
    Deprecated.
    Use getXFormProperties().
    
    Returns:
    
    true to use the legacy behavior where the option text of autocomplete elements was used when evaluating conditions.
  - setLegacyUseOptionTextForAutocomplete
```
@Deprecated
default void setLegacyUseOptionTextForAutocomplete(boolean legacyUseOptionTextForAutocomplete)
```
    Deprecated.
    Use getXFormProperties().
    
    Parameters:
    
    legacyUseOptionTextForAutocomplete - true to use the legacy behavior where the option text of autocomplete elements was used when evaluating conditions.
  - getXFormProperty
```
default XPropertyValue getXFormProperty(String property)
```
  - getXFormPropertyI18n
```
default String getXFormPropertyI18n(String property)
```
  - getXFormPropertyI18n
```
default String getXFormPropertyI18n(XFormPropertyEnum property)
```
  - getXFormProperties
```
XFormProperties getXFormProperties()
```
  - setXFormProperties
```
void setXFormProperties(XFormProperties formProperties)
```
  - getFormI18n
```
com.alibaba.fastjson.JSONObject getFormI18n()
```
  - setFormI18n
```
void setFormI18n(com.alibaba.fastjson.JSONObject formI18n)
```

Interface IXFormRenderConfig

Method Summary

Method Detail

setDesignerPreview

isDesignerPreview

getBaseIncludeUrl

setBaseIncludeUrl

getFormAction

setFormAction

isFormOnly

setFormOnly

getTitle

setTitle

isSkipPlaceholder

setSkipPlaceholder

isPreview

setPreview

isPublish

setPublish

getLang

setLang

getBotFieldName

setBotFieldName

getBotFieldAutocomplete

setBotFieldAutocomplete

getxItemRenderConditions

setXItemRenderConditions

getDataSourceProvider

getXItemProvider

setDataSourceProvider

setLanguageProvider

getLanguageProvider

getRenderCallbackProvider

setRenderCallbackProvider

setLicenseDataProvider

getLicenseDataProvider

getI18N

getI18NValue

isUsejq

setUsejq

isUseui

setUseui

isUsebs

setUsebs

isUsecss

setUsecss

isForceInline

setForceInline

isForceFullyInline

setForceFullyInline

getMetaDataProvider

setMetaDataProvider

getStatusProvider

setStatusProvider

getUserGroupProvider

setUserGroupProvider

setReplacerProvider

getReplacerProvider

getAttachmentDownloadURL

setAttachmentDownloadURL

getAttachmentDeleteURL

setAttachmentDeleteURL

getProjektID

setProjektID

getCustomFormNodes

setCustomFormNodes

addCustomFormNode

getJsIncludes

setJsIncludes

getCssIncludes

getClientId

setClientId

setCssIncludes

addValidationError

addValidationError

getValidationErrors

setValidationErrors

getValidationErrors

getThemeCss

setThemeCss