java.lang.Object
- de.xima.fc.form.render.FormRenderContext

All Implemented Interfaces:

IFormRenderContext, Serializable

Direct Known Subclasses:

ExtendedFormRenderContext
```
public class FormRenderContext
extends Object
implements IFormRenderContext
```
Context of an form-render-request with data for an renderer-call

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`baseURL`	Deprecated. never used
`protected List<BenutzerGruppe>`	`benutzerGruppen`	Deprecated. never used
`protected XButtonDescriptor`	`buttonDescriptor`
`protected List<com.hp.gagawa.java.Node>`	`customNodes`
`protected Map<String,List<String[]>>`	`customValuesMap`
`protected Map<String,IFormContainerMetaData>`	`fieldContainerMap`
`protected List<Attachment>`	`formUploadList`
`protected Map<String,String>`	`hiddenInputParameters`
`protected boolean`	`hideRequiredHint`
`protected com.alibaba.fastjson.JSONObject`	`i18nJson`
`protected boolean`	`isExternal`
`protected Map<String,com.alibaba.fastjson.JSONObject>`	`pluginMetaMap`
`protected Map<String,List<String>>`	`prozessParameters`
`protected Map<String,List<String>>`	`renderParameters`
`protected IFormRequestContext`	`requestCtx`
`protected Status`	`status`	Deprecated.
`protected String`	`submitURL`
`protected Textbaustein`	`themeTextbaustein`
`protected Map<String,List<String>>`	`urlParameters`
`protected boolean`	`usesNewWorkflow`
`protected Map<String,List<String[]>>`	`valuesMap`
`protected WorkflowState`	`workflowState`
`protected IXFormRenderConfig`	`xFormConfig`

Constructor Summary

Constructors
Modifier Constructor Description

protected FormRenderContext(IFormRequestContext requestCtx)

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`addCustomNode(com.hp.gagawa.java.Node node)`
`void`	`addHiddenInputParameter(String key, String value)`
`void`	`addPluginMeta(String key, com.alibaba.fastjson.JSONObject value)`
`void`	`addProzessParameter(String key, List<String> value)`
`void`	`addRenderParameter(String key, List<String> value)`
`void`	`addUrlParameter(String key, List<String> value)`
`IXForm`	`buildXForm()`	builds the `IXForm` from the context
`IXFormRenderConfig`	`buildXFormConfig()`	builds the `IXFormRenderConfig` from the context
`com.alibaba.fastjson.JSONObject`	`buildXFormJSON()`	Deprecated.
`com.alibaba.fastjson.JSONObject`	`createUserDataJSON()`
`String`	`encodeURL(String url)`
`String`	`getBaseUrl()`
`XButtonDescriptor`	`getButtonDescriptor()`
`Map<EFormResourceType,List<IFormResource>>`	`getClientPluginResourceMap()`
`List<IFormResource>`	`getClientPluginResources(EFormResourceType type)`
`Map<EFormResourceType,List<MandantRessource>>`	`getClientResourceMap()`
`List<MandantRessource>`	`getClientResources(EFormResourceType type)`
`List<com.hp.gagawa.java.Node>`	`getCustomNodes()`
`Map<String,List<String[]>>`	`getCustomValuesMap()`
`IFormRequestContext`	`getFormRequestContext()`
`Map<EFormResourceType,List<IFormThemeResource>>`	`getFormThemeResourceMap()`	Gets the map with all resources from the `IFormTheme` that was selected for the currently rendered form.
`List<IFormThemeResource>`	`getFormThemeResources(EFormResourceType type)`	Gets all resources of the given type from the `IFormTheme` that was selected for the currently rendered form.
`List<Attachment>`	`getFormUploadList()`
`FormVersion`	`getFormVersion()`
`FRQSession`	`getFRQSession()`
`Map<String,String>`	`getHiddenInputParameter()`
`com.alibaba.fastjson.JSONObject`	`getI18nJSON()`
`Map<String,IFormContainerMetaData>`	`getIDynContainerMap()`	*
`Locale`	`getLocale()`
`Mandant`	`getMandant()`
`List<MandantRessource>`	`getMandantCssResources()`	Deprecated. use `getClientResources(EFormResourceType)`
`List<MandantRessource>`	`getMandantJsResources()`	Deprecated. use `getClientResources(EFormResourceType)`
`List<IFormResource>`	`getMandantPluginCssResources()`	Deprecated. use `getClientPluginResources(EFormResourceType)`
`List<IFormResource>`	`getMandantPluginJsResources()`	Deprecated. use `getClientPluginResources(EFormResourceType)`
`ParameterWrapper`	`getParameterWrapper()`
`Map<String,com.alibaba.fastjson.JSONObject>`	`getPluginMetaMap()`
`Map<EFormResourceType,List<ProjektRessource>>`	`getProjectResourceMap()`
`List<ProjektRessource>`	`getProjectResources(EFormResourceType type)`
`Projekt`	`getProjekt()`
`List<ProjektRessource>`	`getProjektCssResources()`	Deprecated. use `getProjectResources(EFormResourceType)`
`List<ProjektRessource>`	`getProjektJsResources()`	Deprecated. use `getProjectResources(EFormResourceType)`
`Map<String,List<String>>`	`getProzessParameter()`
`Map<String,List<String>>`	`getRenderParameter()`
`ParameterWrapper`	`getRequestParameters()`	Deprecated.
`EFormRequestType`	`getRequestType()`
`XfcSession`	`getSession()`
`Map<String,Serializable>`	`getSessionAttributeMap()`
`SessionAttributes`	`getSessionAttributes()`	Deprecated.
`String`	`getSessionID()`
`Duration`	`getSessionTimeout()`
`Status`	`getStatus()`	Deprecated.
`String`	`getSubmitURL()`
`List<IFormResource>`	`getSystemPluginCssResources()`	Deprecated. use `getSystemPluginResources(EFormResourceType)`
`List<IFormResource>`	`getSystemPluginJsResources()`	Deprecated. use `getSystemPluginResources(EFormResourceType)`
`Map<EFormResourceType,List<IFormResource>>`	`getSystemPluginResourceMap()`
`List<IFormResource>`	`getSystemPluginResources(EFormResourceType type)`
`Textbaustein`	`getThemeTextbaustein()`	Gets the `text template` with the CSS content to be used as the theme for the form.
`Map<String,List<String>>`	`getUrlParameter()`
`Map<String,List<String>>`	`getUrlParamMap()`	Deprecated.
`UserContext`	`getUserContext()`
`List<BenutzerGruppe>`	`getUserGroups()`
`IUser`	`getUserModel()`
`org.pac4j.core.profile.CommonProfile`	`getUserProfile()`	Deprecated. get profile from `IUser`
`Map<String,List<String[]>>`	`getValuesMap()`
`Vorgang`	`getVorgang()`
`WorkflowState`	`getWorkflowState()`
`IXFormRenderConfig`	`getXFormConfig()`
`boolean`	`isExternal()`
`boolean`	`isHideRequiredHint()`
`boolean`	`isUsesNewWorkflow()`
`String`	`render()`	renders the context and returns the result as `String`
`void`	`render(IExtendedFormRequestContext requestCtx)`	renders the context to the `HttpServletResponse` of the given `IExtendedFormRequestContext`
`void`	`render(javax.servlet.http.HttpServletResponse response)`	renders the context to the given `HttpServletResponse`
`void`	`setBaseUrl(String baseURI)`
`void`	`setButtonDescriptor(XButtonDescriptor buttonDescriptor)`
`void`	`setClientPluginResourceMap(Map<EFormResourceType,List<IFormResource>> resMap)`
`void`	`setClientPluginResources(EFormResourceType type, List<IFormResource> resources)`
`void`	`setClientResourceMap(Map<EFormResourceType,List<MandantRessource>> resMap)`
`void`	`setClientResources(EFormResourceType type, List<MandantRessource> resources)`
`void`	`setCustomNodes(List<com.hp.gagawa.java.Node> customNodes)`
`void`	`setCustomValuesMap(Map<String,List<String[]>> customValuesMap)`
`void`	`setExternal(boolean isExternal)`
`void`	`setFormRequestContext(IFormRequestContext requestCtx)`
`void`	`setFormThemeResourceMap(Map<EFormResourceType,List<IFormThemeResource>> formThemePluginResources)`	Sets the map with all resources from the `IFormTheme` that was selected for the currently rendered form.
`void`	`setFormUploadList(List<Attachment> formUploadList)`
`void`	`setFormVersion(FormVersion formVersion)`
`void`	`setFRQSession(FRQSession frqSession)`
`void`	`setHiddenInputParameters(Map<String,String> hiddenInputParameters)`
`void`	`setHideRequiredHint(boolean isShowRequiredHint)`
`void`	`setI18nJSON(com.alibaba.fastjson.JSONObject i18nJson)`
`void`	`setIDynContainerMap(Map<String,IFormContainerMetaData> fieldContainerMap)`
`void`	`setLocale(Locale locale)`
`void`	`setMandant(Mandant mandant)`
`void`	`setMandantCssResources(List<MandantRessource> cssMandantResources)`	Deprecated. use `setClientResources(EFormResourceType, List)`
`void`	`setMandantJsResources(List<MandantRessource> jsMandantResources)`	Deprecated. use `setClientResources(EFormResourceType, List)`
`void`	`setMandantPluginCssResources(List<IFormResource> cssMandantPluginResources)`	Deprecated. use `setClientPluginResources(EFormResourceType, List)`
`void`	`setMandantPluginJsResources(List<IFormResource> jsMandantPluginResources)`	Deprecated. use `setClientPluginResources(EFormResourceType, List)`
`void`	`setParameterWrapper(ParameterWrapper parameterWrapper)`	Deprecated.
`void`	`setPluginMetaMap(Map<String,com.alibaba.fastjson.JSONObject> pluginMetaMap)`
`void`	`setProjectResourceMap(Map<EFormResourceType,List<ProjektRessource>> resMap)`
`void`	`setProjectResources(EFormResourceType type, List<ProjektRessource> resources)`
`void`	`setProjekt(Projekt projekt)`
`void`	`setProjektCssResources(List<ProjektRessource> cssProjektResources)`	Deprecated. use `setProjectResources(EFormResourceType, List)`
`void`	`setProjektJsResources(List<ProjektRessource> jsProjektResources)`	Deprecated. use `setProjectResources(EFormResourceType, List)`
`void`	`setProzessParameter(Map<String,List<String>> prozessParameters)`
`void`	`setRenderParameter(Map<String,List<String>> renderParameters)`
`void`	`setRequestParameters(ParameterWrapper requestParameters)`	Deprecated.
`void`	`setRequestType(EFormRequestType requestType)`
`void`	`setSession(XfcSession session)`
`void`	`setSessionAttributeMap(Map<String,Serializable> sessionAttributes)`
`void`	`setSessionAttributes(SessionAttributes sessionAttributes)`	Deprecated.
`void`	`setSessionID(String sessionID)`
`void`	`setSessionTimeout(Duration timeout)`
`void`	`setStatus(Status status)`	Deprecated.
`void`	`setSubmitURL(String submitUrl)`
`void`	`setSystemPluginCssResources(List<IFormResource> cssSystemPluginResources)`	Deprecated. use `setSystemPluginResources(EFormResourceType, List)`
`void`	`setSystemPluginJsResources(List<IFormResource> jsSystemPluginResources)`	Deprecated. use `setSystemPluginResources(EFormResourceType, List)`
`void`	`setSystemPluginResourceMap(Map<EFormResourceType,List<IFormResource>> resMap)`
`void`	`setSystemPluginResources(EFormResourceType type, List<IFormResource> resources)`
`void`	`setThemeTextbaustein(Textbaustein themeTextbaustein)`	Sets the `text template` with the CSS content to be used as the theme for the form.
`void`	`setUrlParameter(Map<String,List<String>> urlParameter)`
`void`	`setUserContext(UserContext userContext)`
`void`	`setUserGroups(List<BenutzerGruppe> benutzerGruppen)`	Deprecated. User groups should be determined by the user.
`void`	`setUserModel(IUser user)`
`void`	`setUserProfile(org.pac4j.core.profile.CommonProfile profile)`	Deprecated. get profile from `IUser`
`void`	`setUsesNewWorkflow(boolean usesNewWorkflow)`
`void`	`setValuesMap(Map<String,List<String[]>> valuesMap)`
`void`	`setVorgang(Vorgang vorgang)`
`void`	`setWorkflowState(WorkflowState workflowState)`
`void`	`setXFormConfig(IXFormRenderConfig xFormConfig)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.xima.fc.interfaces.form.IFormRenderContext
getBenutzer, getBenutzerGruppen, getDynContainerMap, getRequestContext, getUser, setBenutzer, setBenutzerGruppen, setDynContainerMap, setRequestContext, setUser

- Field Detail
  - requestCtx
```
protected IFormRequestContext requestCtx
```
  - hiddenInputParameters
```
protected Map<String,String> hiddenInputParameters
```
  - prozessParameters
```
protected Map<String,List<String>> prozessParameters
```
  - renderParameters
```
protected Map<String,List<String>> renderParameters
```
  - urlParameters
```
protected Map<String,List<String>> urlParameters
```
  - pluginMetaMap
```
protected Map<String,com.alibaba.fastjson.JSONObject> pluginMetaMap
```
  - valuesMap
```
protected Map<String,List<String[]>> valuesMap
```
  - customValuesMap
```
protected Map<String,List<String[]>> customValuesMap
```
  - fieldContainerMap
```
protected Map<String,IFormContainerMetaData> fieldContainerMap
```
  - customNodes
```
protected List<com.hp.gagawa.java.Node> customNodes
```
  - formUploadList
```
protected List<Attachment> formUploadList
```
  - isExternal
```
protected boolean isExternal
```
  - status
```
@Deprecated
protected Status status
```
    Deprecated.
  - workflowState
```
protected WorkflowState workflowState
```
  - usesNewWorkflow
```
protected boolean usesNewWorkflow
```
  - themeTextbaustein
```
protected Textbaustein themeTextbaustein
```
  - hideRequiredHint
```
protected boolean hideRequiredHint
```
  - buttonDescriptor
```
protected XButtonDescriptor buttonDescriptor
```
  - submitURL
```
protected String submitURL
```
  - xFormConfig
```
protected IXFormRenderConfig xFormConfig
```
  - i18nJson
```
protected com.alibaba.fastjson.JSONObject i18nJson
```
  - benutzerGruppen
```
@Deprecated
protected List<BenutzerGruppe> benutzerGruppen
```
    Deprecated.
    never used
  - baseURL
```
@Deprecated
protected String baseURL
```
    Deprecated.
    never used
- Constructor Detail
  - FormRenderContext
```
protected FormRenderContext(IFormRequestContext requestCtx)
                     throws ContextBuilderException
```
    Throws:
    
    ContextBuilderException
- Method Detail
  - getUserContext
```
public UserContext getUserContext()
```
    Specified by:
    
    getUserContext in interface IFormRenderContext
  - setUserContext
```
public void setUserContext(UserContext userContext)
```
    Specified by:
    
    setUserContext in interface IFormRenderContext
  - getHiddenInputParameter
```
public Map<String,String> getHiddenInputParameter()
```
    Specified by:
    
    getHiddenInputParameter in interface IFormRenderContext
  - addHiddenInputParameter
```
public void addHiddenInputParameter(String key,
                                    String value)
```
    Specified by:
    
    addHiddenInputParameter in interface IFormRenderContext
  - setHiddenInputParameters
```
public void setHiddenInputParameters(Map<String,String> hiddenInputParameters)
```
    Specified by:
    
    setHiddenInputParameters in interface IFormRenderContext
  - getProzessParameter
```
public Map<String,List<String>> getProzessParameter()
```
    Specified by:
    
    getProzessParameter in interface IFormRenderContext
  - addProzessParameter
```
public void addProzessParameter(String key,
                                List<String> value)
```
    Specified by:
    
    addProzessParameter in interface IFormRenderContext
  - setProzessParameter
```
public void setProzessParameter(Map<String,List<String>> prozessParameters)
```
    Specified by:
    
    setProzessParameter in interface IFormRenderContext
  - getRenderParameter
```
public Map<String,List<String>> getRenderParameter()
```
    Specified by:
    
    getRenderParameter in interface IFormRenderContext
  - addRenderParameter
```
public void addRenderParameter(String key,
                               List<String> value)
```
    Specified by:
    
    addRenderParameter in interface IFormRenderContext
  - setRenderParameter
```
public void setRenderParameter(Map<String,List<String>> renderParameters)
```
    Specified by:
    
    setRenderParameter in interface IFormRenderContext
  - getUrlParameter
```
public Map<String,List<String>> getUrlParameter()
```
    Specified by:
    
    getUrlParameter in interface IFormRenderContext
  - addUrlParameter
```
public void addUrlParameter(String key,
                            List<String> value)
```
    Specified by:
    
    addUrlParameter in interface IFormRenderContext
  - setUrlParameter
```
public void setUrlParameter(Map<String,List<String>> urlParameter)
```
    Specified by:
    
    setUrlParameter in interface IFormRenderContext
  - getPluginMetaMap
```
public Map<String,com.alibaba.fastjson.JSONObject> getPluginMetaMap()
```
    Specified by:
    
    getPluginMetaMap in interface IFormRenderContext
  - addPluginMeta
```
public void addPluginMeta(String key,
                          com.alibaba.fastjson.JSONObject value)
```
    Specified by:
    
    addPluginMeta in interface IFormRenderContext
  - setPluginMetaMap
```
public void setPluginMetaMap(Map<String,com.alibaba.fastjson.JSONObject> pluginMetaMap)
```
    Specified by:
    
    setPluginMetaMap in interface IFormRenderContext
  - getCustomNodes
```
public List<com.hp.gagawa.java.Node> getCustomNodes()
```
    Specified by:
    
    getCustomNodes in interface IFormRenderContext
  - addCustomNode
```
public void addCustomNode(com.hp.gagawa.java.Node node)
```
    Specified by:
    
    addCustomNode in interface IFormRenderContext
  - setCustomNodes
```
public void setCustomNodes(List<com.hp.gagawa.java.Node> customNodes)
```
    Specified by:
    
    setCustomNodes in interface IFormRenderContext
  - getValuesMap
```
public Map<String,List<String[]>> getValuesMap()
```
    Specified by:
    
    getValuesMap in interface IFormRenderContext
  - setValuesMap
```
public void setValuesMap(Map<String,List<String[]>> valuesMap)
```
    Specified by:
    
    setValuesMap in interface IFormRenderContext
  - getCustomValuesMap
```
public Map<String,List<String[]>> getCustomValuesMap()
```
    Specified by:
    
    getCustomValuesMap in interface IFormRenderContext
  - setCustomValuesMap
```
public void setCustomValuesMap(Map<String,List<String[]>> customValuesMap)
```
    Specified by:
    
    setCustomValuesMap in interface IFormRenderContext
  - getFRQSession
```
public FRQSession getFRQSession()
```
    Specified by:
    
    getFRQSession in interface IFormRenderContext
  - setFRQSession
```
public void setFRQSession(FRQSession frqSession)
```
    Specified by:
    
    setFRQSession in interface IFormRenderContext
  - getSession
```
public XfcSession getSession()
```
    Specified by:
    
    getSession in interface IFormRenderContext
  - setSession
```
public void setSession(XfcSession session)
```
    Specified by:
    
    setSession in interface IFormRenderContext
  - getProjekt
```
public Projekt getProjekt()
```
    Specified by:
    
    getProjekt in interface IFormRenderContext
  - setProjekt
```
public void setProjekt(Projekt projekt)
```
    Specified by:
    
    setProjekt in interface IFormRenderContext
  - getFormVersion
```
public FormVersion getFormVersion()
```
    Specified by:
    
    getFormVersion in interface IFormRenderContext
  - setFormVersion
```
public void setFormVersion(FormVersion formVersion)
```
    Specified by:
    
    setFormVersion in interface IFormRenderContext
  - getUserModel
```
public IUser getUserModel()
```
    Specified by:
    
    getUserModel in interface IFormRenderContext
  - setUserModel
```
public void setUserModel(IUser user)
```
    Specified by:
    
    setUserModel in interface IFormRenderContext
  - getVorgang
```
public Vorgang getVorgang()
```
    Specified by:
    
    getVorgang in interface IFormRenderContext
  - setVorgang
```
public void setVorgang(Vorgang vorgang)
```
    Specified by:
    
    setVorgang in interface IFormRenderContext
  - getMandant
```
public Mandant getMandant()
```
    Specified by:
    
    getMandant in interface IFormRenderContext
  - setMandant
```
public void setMandant(Mandant mandant)
```
    Specified by:
    
    setMandant in interface IFormRenderContext
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface IFormRenderContext
  - setLocale
```
public void setLocale(Locale locale)
```
    Specified by:
    
    setLocale in interface IFormRenderContext
  - getUserGroups
```
public List<BenutzerGruppe> getUserGroups()
```
    Specified by:
    
    getUserGroups in interface IFormRenderContext
  - createUserDataJSON
```
public com.alibaba.fastjson.JSONObject createUserDataJSON()
```
    Specified by:
    
    createUserDataJSON in interface IFormRenderContext
  - getSessionAttributeMap
```
public Map<String,Serializable> getSessionAttributeMap()
```
    Specified by:
    
    getSessionAttributeMap in interface IFormRenderContext
    
    Returns:
    
    A Map of all key-value pairs in the current HttpSession. Please note that changes to this map will not affect the HttpSession.
  - setSessionAttributeMap
```
public void setSessionAttributeMap(Map<String,Serializable> sessionAttributes)
```
    Specified by:
    
    setSessionAttributeMap in interface IFormRenderContext
    
    Parameters:
    
    sessionAttributes - A Map of all key-value pairs in the current HttpSession. Please note that changes to this map will not affect the HttpSession.
  - getSessionTimeout
```
public Duration getSessionTimeout()
```
    Specified by:
    
    getSessionTimeout in interface IFormRenderContext
    
    Returns:
    
    The time it takes for an HTTP session on the server to timeout. This relates to the server which provided the form, the timeout may be different depending on the server.
  - setSessionTimeout
```
public void setSessionTimeout(Duration timeout)
```
    Specified by:
    
    setSessionTimeout in interface IFormRenderContext
    
    Parameters:
    
    timeout - The time it takes for an HTTP session on the server to timeout. This relates to the server which provided the form, the timeout may be different depending on the server.
  - getBaseUrl
```
public String getBaseUrl()
```
    Specified by:
    
    getBaseUrl in interface IFormRenderContext
  - setBaseUrl
```
public void setBaseUrl(String baseURI)
```
    Specified by:
    
    setBaseUrl in interface IFormRenderContext
  - getSessionID
```
public String getSessionID()
```
    Specified by:
    
    getSessionID in interface IFormRenderContext
  - setSessionID
```
public void setSessionID(String sessionID)
```
    Specified by:
    
    setSessionID in interface IFormRenderContext
  - getRequestType
```
public EFormRequestType getRequestType()
```
    Specified by:
    
    getRequestType in interface IFormRenderContext
  - setRequestType
```
public void setRequestType(EFormRequestType requestType)
```
    Specified by:
    
    setRequestType in interface IFormRenderContext
  - getParameterWrapper
```
public ParameterWrapper getParameterWrapper()
```
    Specified by:
    
    getParameterWrapper in interface IFormRenderContext
  - setParameterWrapper
```
@Deprecated
public void setParameterWrapper(ParameterWrapper parameterWrapper)
```
    Deprecated.
    
    Specified by:
    
    setParameterWrapper in interface IFormRenderContext
  - getStatus
```
@Deprecated
public Status getStatus()
```
    Deprecated.
    
    Specified by:
    
    getStatus in interface IFormRenderContext
    
    Returns:
    
    A state of the form record to use for rendering the form.
  - setStatus
```
@Deprecated
public void setStatus(Status status)
```
    Deprecated.
    
    Specified by:
    
    setStatus in interface IFormRenderContext
    
    Parameters:
    
    status - A state of the form record to use for rendering the form.
  - getSubmitURL
```
public String getSubmitURL()
```
    Specified by:
    
    getSubmitURL in interface IFormRenderContext
  - setSubmitURL
```
public void setSubmitURL(String submitUrl)
```
    Specified by:
    
    setSubmitURL in interface IFormRenderContext
  - isExternal
```
public boolean isExternal()
```
    Specified by:
    
    isExternal in interface IFormRenderContext
  - setExternal
```
public void setExternal(boolean isExternal)
```
    Specified by:
    
    setExternal in interface IFormRenderContext
  - isUsesNewWorkflow
```
public boolean isUsesNewWorkflow()
```
    Specified by:
    
    isUsesNewWorkflow in interface IFormRenderContext
  - setUsesNewWorkflow
```
public void setUsesNewWorkflow(boolean usesNewWorkflow)
```
    Specified by:
    
    setUsesNewWorkflow in interface IFormRenderContext
  - getWorkflowState
```
public WorkflowState getWorkflowState()
```
    Specified by:
    
    getWorkflowState in interface IFormRenderContext
  - setWorkflowState
```
public void setWorkflowState(WorkflowState workflowState)
```
    Specified by:
    
    setWorkflowState in interface IFormRenderContext
  - getXFormConfig
```
public IXFormRenderConfig getXFormConfig()
```
    Specified by:
    
    getXFormConfig in interface IFormRenderContext
  - setXFormConfig
```
public void setXFormConfig(IXFormRenderConfig xFormConfig)
```
    Specified by:
    
    setXFormConfig in interface IFormRenderContext
  - encodeURL
```
public String encodeURL(String url)
```
    Specified by:
    
    encodeURL in interface IFormRenderContext
  - getFormUploadList
```
public List<Attachment> getFormUploadList()
```
    Specified by:
    
    getFormUploadList in interface IFormRenderContext
  - setFormUploadList
```
public void setFormUploadList(List<Attachment> formUploadList)
```
    Specified by:
    
    setFormUploadList in interface IFormRenderContext
  - setI18nJSON
```
public void setI18nJSON(com.alibaba.fastjson.JSONObject i18nJson)
```
    Specified by:
    
    setI18nJSON in interface IFormRenderContext
  - getI18nJSON
```
public com.alibaba.fastjson.JSONObject getI18nJSON()
```
    Specified by:
    
    getI18nJSON in interface IFormRenderContext
  - getIDynContainerMap
```
public Map<String,IFormContainerMetaData> getIDynContainerMap()
```
    Description copied from interface: IFormRenderContext
    
    *
    
    Specified by:
    
    getIDynContainerMap in interface IFormRenderContext
    
    Returns:
    
    A map between the name of a repeated container and its metadata. No mapping is present when the containeris not repeated.
  - setIDynContainerMap
```
public void setIDynContainerMap(Map<String,IFormContainerMetaData> fieldContainerMap)
```
    Specified by:
    
    setIDynContainerMap in interface IFormRenderContext
    
    Parameters:
    
    fieldContainerMap - A map between the name of a form field and the (repetition) container that contains the form field. No mapping is present when the form field is not repeated.
  - getFormRequestContext
```
public IFormRequestContext getFormRequestContext()
```
    Specified by:
    
    getFormRequestContext in interface IFormRenderContext
  - setFormRequestContext
```
public void setFormRequestContext(IFormRequestContext requestCtx)
```
    Specified by:
    
    setFormRequestContext in interface IFormRenderContext
  - getThemeTextbaustein
```
public Textbaustein getThemeTextbaustein()
```
    Description copied from interface: IFormRenderContext
    
    Gets the text template with the CSS content to be used as the theme for the form.
    
    Specified by:
    
    getThemeTextbaustein in interface IFormRenderContext
    
    Returns:
    
    The text template with the theme CSS.
  - setThemeTextbaustein
```
public void setThemeTextbaustein(Textbaustein themeTextbaustein)
```
    Description copied from interface: IFormRenderContext
    
    Sets the text template with the CSS content to be used as the theme for the form.
    
    Specified by:
    
    setThemeTextbaustein in interface IFormRenderContext
    
    Parameters:
    
    themeTextbaustein - The text template with the theme CSS.
  - getProjectResourceMap
```
public Map<EFormResourceType,List<ProjektRessource>> getProjectResourceMap()
```
    Specified by:
    
    getProjectResourceMap in interface IFormRenderContext
  - setProjectResourceMap
```
public void setProjectResourceMap(Map<EFormResourceType,List<ProjektRessource>> resMap)
```
    Specified by:
    
    setProjectResourceMap in interface IFormRenderContext
  - isHideRequiredHint
```
public boolean isHideRequiredHint()
```
    Specified by:
    
    isHideRequiredHint in interface IFormRenderContext
  - setHideRequiredHint
```
public void setHideRequiredHint(boolean isShowRequiredHint)
```
    Specified by:
    
    setHideRequiredHint in interface IFormRenderContext
  - getButtonDescriptor
```
public XButtonDescriptor getButtonDescriptor()
```
    Specified by:
    
    getButtonDescriptor in interface IFormRenderContext
  - setButtonDescriptor
```
public void setButtonDescriptor(XButtonDescriptor buttonDescriptor)
```
    Specified by:
    
    setButtonDescriptor in interface IFormRenderContext
  - getProjectResources
```
public List<ProjektRessource> getProjectResources(EFormResourceType type)
```
    Specified by:
    
    getProjectResources in interface IFormRenderContext
  - setProjectResources
```
public void setProjectResources(EFormResourceType type,
                                List<ProjektRessource> resources)
```
    Specified by:
    
    setProjectResources in interface IFormRenderContext
  - getClientResourceMap
```
public Map<EFormResourceType,List<MandantRessource>> getClientResourceMap()
```
    Specified by:
    
    getClientResourceMap in interface IFormRenderContext
  - setClientResourceMap
```
public void setClientResourceMap(Map<EFormResourceType,List<MandantRessource>> resMap)
```
    Specified by:
    
    setClientResourceMap in interface IFormRenderContext
  - getClientResources
```
public List<MandantRessource> getClientResources(EFormResourceType type)
```
    Specified by:
    
    getClientResources in interface IFormRenderContext
  - setClientResources
```
public void setClientResources(EFormResourceType type,
                               List<MandantRessource> resources)
```
    Specified by:
    
    setClientResources in interface IFormRenderContext
  - getClientPluginResourceMap
```
public Map<EFormResourceType,List<IFormResource>> getClientPluginResourceMap()
```
    Specified by:
    
    getClientPluginResourceMap in interface IFormRenderContext
  - setClientPluginResourceMap
```
public void setClientPluginResourceMap(Map<EFormResourceType,List<IFormResource>> resMap)
```
    Specified by:
    
    setClientPluginResourceMap in interface IFormRenderContext
  - getClientPluginResources
```
public List<IFormResource> getClientPluginResources(EFormResourceType type)
```
    Specified by:
    
    getClientPluginResources in interface IFormRenderContext
  - setClientPluginResources
```
public void setClientPluginResources(EFormResourceType type,
                                     List<IFormResource> resources)
```
    Specified by:
    
    setClientPluginResources in interface IFormRenderContext
  - getFormThemeResourceMap
```
public Map<EFormResourceType,List<IFormThemeResource>> getFormThemeResourceMap()
```
    Description copied from interface: IFormRenderContext
    
    Gets the map with all resources from the IFormTheme that was selected for the currently rendered form.
    
    Specified by:
    
    getFormThemeResourceMap in interface IFormRenderContext
    
    Returns:
    
    A map with all resources from the selected IFormTheme.
  - setFormThemeResourceMap
```
public void setFormThemeResourceMap(Map<EFormResourceType,List<IFormThemeResource>> formThemePluginResources)
```
    Description copied from interface: IFormRenderContext
    
    Sets the map with all resources from the IFormTheme that was selected for the currently rendered form.
    
    Specified by:
    
    setFormThemeResourceMap in interface IFormRenderContext
    
    Parameters:
    
    formThemePluginResources - A map with all resources from the selected IFormTheme.
  - getFormThemeResources
```
public List<IFormThemeResource> getFormThemeResources(EFormResourceType type)
```
    Description copied from interface: IFormRenderContext
    
    Gets all resources of the given type from the IFormTheme that was selected for the currently rendered form.
    
    Specified by:
    
    getFormThemeResources in interface IFormRenderContext
    
    Parameters:
    
    type - The type of the resources to get.
    
    Returns:
    
    A list with all resources of the given type from the selected IFormTheme.
  - getSystemPluginResourceMap
```
public Map<EFormResourceType,List<IFormResource>> getSystemPluginResourceMap()
```
    Specified by:
    
    getSystemPluginResourceMap in interface IFormRenderContext
  - setSystemPluginResourceMap
```
public void setSystemPluginResourceMap(Map<EFormResourceType,List<IFormResource>> resMap)
```
    Specified by:
    
    setSystemPluginResourceMap in interface IFormRenderContext
  - getSystemPluginResources
```
public List<IFormResource> getSystemPluginResources(EFormResourceType type)
```
    Specified by:
    
    getSystemPluginResources in interface IFormRenderContext
  - setSystemPluginResources
```
public void setSystemPluginResources(EFormResourceType type,
                                     List<IFormResource> resources)
```
    Specified by:
    
    setSystemPluginResources in interface IFormRenderContext
  - buildXForm
```
public IXForm buildXForm()
                  throws IOException,
                         com.alibaba.fastjson.JSONException
```
    Description copied from interface: IFormRenderContext
    
    builds the IXForm from the context
    
    Specified by:
    
    buildXForm in interface IFormRenderContext
    
    Returns:
    
    the created IXForm
    
    Throws:
    
    IOException - on errors while reading the form
    
    com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject
  - buildXFormConfig
```
public IXFormRenderConfig buildXFormConfig()
                                    throws IOException
```
    Description copied from interface: IFormRenderContext
    
    builds the IXFormRenderConfig from the context
    
    Specified by:
    
    buildXFormConfig in interface IFormRenderContext
    
    Returns:
    
    the created IXFormRenderConfig
    
    Throws:
    
    IOException - on errors while reading the form
  - buildXFormJSON
```
@Deprecated
public com.alibaba.fastjson.JSONObject buildXFormJSON()
                                               throws IOException,
                                                      com.alibaba.fastjson.JSONException
```
    Deprecated.
    
    Description copied from interface: IFormRenderContext
    
    builds the JSONObject from the render-context
    
    Specified by:
    
    buildXFormJSON in interface IFormRenderContext
    
    Returns:
    
    the created JSONObject
    
    Throws:
    
    IOException - on errors while reading the form
    
    com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject
  - render
```
public String render()
              throws IOException,
                     com.alibaba.fastjson.JSONException
```
    Description copied from interface: IFormRenderContext
    
    renders the context and returns the result as String
    
    Specified by:
    
    render in interface IFormRenderContext
    
    Returns:
    
    the rendered form as String
    
    Throws:
    
    IOException - on errors while reading or rendering the form
    
    com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject
  - render
```
public void render(IExtendedFormRequestContext requestCtx)
            throws IOException,
                   com.alibaba.fastjson.JSONException
```
    Description copied from interface: IFormRenderContext
    
    renders the context to the HttpServletResponse of the given IExtendedFormRequestContext
    
    Specified by:
    
    render in interface IFormRenderContext
    
    Parameters:
    
    requestCtx - IExtendedFormRequestContext which HttpServletResponse should be used
    
    Throws:
    
    IOException - on errors while reading or rendering the form
    
    com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject
  - render
```
public void render(javax.servlet.http.HttpServletResponse response)
            throws IOException,
                   com.alibaba.fastjson.JSONException
```
    Description copied from interface: IFormRenderContext
    
    renders the context to the given HttpServletResponse
    
    Specified by:
    
    render in interface IFormRenderContext
    
    Parameters:
    
    response - HttpServletResponse which should be used
    
    Throws:
    
    IOException - on errors while reading or rendering the form
    
    com.alibaba.fastjson.JSONException - on errors while generating the forms JSONObject
  - getUserProfile
```
@Deprecated
public org.pac4j.core.profile.CommonProfile getUserProfile()
```
    Deprecated.
    get profile from IUser
    
    Specified by:
    
    getUserProfile in interface IFormRenderContext
  - setUserProfile
```
@Deprecated
public void setUserProfile(org.pac4j.core.profile.CommonProfile profile)
```
    Deprecated.
    get profile from IUser
    
    Specified by:
    
    setUserProfile in interface IFormRenderContext
  - setUserGroups
```
@Deprecated
public void setUserGroups(List<BenutzerGruppe> benutzerGruppen)
```
    Deprecated.
    User groups should be determined by the user. Use setUserModel(IUser) with a user that has user groups instead.
    
    Specified by:
    
    setUserGroups in interface IFormRenderContext
  - getSessionAttributes
```
@Deprecated
public SessionAttributes getSessionAttributes()
```
    Deprecated.
    
    Specified by:
    
    getSessionAttributes in interface IFormRenderContext
  - setSessionAttributes
```
@Deprecated
public void setSessionAttributes(SessionAttributes sessionAttributes)
```
    Deprecated.
    
    Specified by:
    
    setSessionAttributes in interface IFormRenderContext
  - getRequestParameters
```
@Deprecated
public ParameterWrapper getRequestParameters()
```
    Deprecated.
    
    Specified by:
    
    getRequestParameters in interface IFormRenderContext
  - setRequestParameters
```
@Deprecated
public void setRequestParameters(ParameterWrapper requestParameters)
```
    Deprecated.
    
    Specified by:
    
    setRequestParameters in interface IFormRenderContext
  - getUrlParamMap
```
@Deprecated
public Map<String,List<String>> getUrlParamMap()
```
    Deprecated.
    
    Specified by:
    
    getUrlParamMap in interface IFormRenderContext
  - getMandantJsResources
```
@Deprecated
public List<MandantRessource> getMandantJsResources()
```
    Deprecated.
    use getClientResources(EFormResourceType)
    
    Specified by:
    
    getMandantJsResources in interface IFormRenderContext
  - setMandantJsResources
```
@Deprecated
public void setMandantJsResources(List<MandantRessource> jsMandantResources)
```
    Deprecated.
    use setClientResources(EFormResourceType, List)
    
    Specified by:
    
    setMandantJsResources in interface IFormRenderContext
  - getMandantCssResources
```
@Deprecated
public List<MandantRessource> getMandantCssResources()
```
    Deprecated.
    use getClientResources(EFormResourceType)
    
    Specified by:
    
    getMandantCssResources in interface IFormRenderContext
  - setMandantCssResources
```
@Deprecated
public void setMandantCssResources(List<MandantRessource> cssMandantResources)
```
    Deprecated.
    use setClientResources(EFormResourceType, List)
    
    Specified by:
    
    setMandantCssResources in interface IFormRenderContext
  - getProjektJsResources
```
@Deprecated
public List<ProjektRessource> getProjektJsResources()
```
    Deprecated.
    use getProjectResources(EFormResourceType)
    
    Specified by:
    
    getProjektJsResources in interface IFormRenderContext
  - setProjektJsResources
```
@Deprecated
public void setProjektJsResources(List<ProjektRessource> jsProjektResources)
```
    Deprecated.
    use setProjectResources(EFormResourceType, List)
    
    Specified by:
    
    setProjektJsResources in interface IFormRenderContext
  - getProjektCssResources
```
@Deprecated
public List<ProjektRessource> getProjektCssResources()
```
    Deprecated.
    use getProjectResources(EFormResourceType)
    
    Specified by:
    
    getProjektCssResources in interface IFormRenderContext
  - setProjektCssResources
```
@Deprecated
public void setProjektCssResources(List<ProjektRessource> cssProjektResources)
```
    Deprecated.
    use setProjectResources(EFormResourceType, List)
    
    Specified by:
    
    setProjektCssResources in interface IFormRenderContext
  - getSystemPluginJsResources
```
@Deprecated
public List<IFormResource> getSystemPluginJsResources()
```
    Deprecated.
    use getSystemPluginResources(EFormResourceType)
    
    Specified by:
    
    getSystemPluginJsResources in interface IFormRenderContext
  - setSystemPluginJsResources
```
@Deprecated
public void setSystemPluginJsResources(List<IFormResource> jsSystemPluginResources)
```
    Deprecated.
    use setSystemPluginResources(EFormResourceType, List)
    
    Specified by:
    
    setSystemPluginJsResources in interface IFormRenderContext
  - getSystemPluginCssResources
```
@Deprecated
public List<IFormResource> getSystemPluginCssResources()
```
    Deprecated.
    use getSystemPluginResources(EFormResourceType)
    
    Specified by:
    
    getSystemPluginCssResources in interface IFormRenderContext
  - setSystemPluginCssResources
```
@Deprecated
public void setSystemPluginCssResources(List<IFormResource> cssSystemPluginResources)
```
    Deprecated.
    use setSystemPluginResources(EFormResourceType, List)
    
    Specified by:
    
    setSystemPluginCssResources in interface IFormRenderContext
  - getMandantPluginJsResources
```
@Deprecated
public List<IFormResource> getMandantPluginJsResources()
```
    Deprecated.
    use getClientPluginResources(EFormResourceType)
    
    Specified by:
    
    getMandantPluginJsResources in interface IFormRenderContext
  - setMandantPluginJsResources
```
@Deprecated
public void setMandantPluginJsResources(List<IFormResource> jsMandantPluginResources)
```
    Deprecated.
    use setClientPluginResources(EFormResourceType, List)
    
    Specified by:
    
    setMandantPluginJsResources in interface IFormRenderContext
  - getMandantPluginCssResources
```
@Deprecated
public List<IFormResource> getMandantPluginCssResources()
```
    Deprecated.
    use getClientPluginResources(EFormResourceType)
    
    Specified by:
    
    getMandantPluginCssResources in interface IFormRenderContext
  - setMandantPluginCssResources
```
@Deprecated
public void setMandantPluginCssResources(List<IFormResource> cssMandantPluginResources)
```
    Deprecated.
    use setClientPluginResources(EFormResourceType, List)
    
    Specified by:
    
    setMandantPluginCssResources in interface IFormRenderContext

Class FormRenderContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface de.xima.fc.interfaces.form.IFormRenderContext

Field Detail

requestCtx

hiddenInputParameters

prozessParameters

renderParameters

urlParameters

pluginMetaMap

valuesMap

customValuesMap

fieldContainerMap

customNodes

formUploadList

isExternal

status

workflowState

usesNewWorkflow

themeTextbaustein

hideRequiredHint

buttonDescriptor

submitURL

xFormConfig

i18nJson

benutzerGruppen

baseURL

Constructor Detail

FormRenderContext

Method Detail

getUserContext

setUserContext

getHiddenInputParameter

addHiddenInputParameter

setHiddenInputParameters

getProzessParameter

addProzessParameter

setProzessParameter

getRenderParameter

addRenderParameter

setRenderParameter

getUrlParameter

addUrlParameter

setUrlParameter

getPluginMetaMap

addPluginMeta

setPluginMetaMap

getCustomNodes

addCustomNode

setCustomNodes

getValuesMap

setValuesMap

getCustomValuesMap

setCustomValuesMap

getFRQSession

setFRQSession

getSession

setSession

getProjekt

setProjekt

getFormVersion

setFormVersion

getUserModel

setUserModel

getVorgang

setVorgang

getMandant

setMandant

getLocale

setLocale

getUserGroups

createUserDataJSON

getSessionAttributeMap

setSessionAttributeMap

getSessionTimeout

setSessionTimeout

getBaseUrl