Package de.xima.fc.interfaces.form
Interface IFormRenderContext
- All Superinterfaces:
Serializable
- All Known Subinterfaces:
IExtendedFormRenderContext
- All Known Implementing Classes:
ExtendedFormRenderContext,FD2RenderContext,FormRenderContext
Context for rendering an form
- Author:
- XIMA MEDIA GmbH
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddCustomNode(com.hp.gagawa.java.Node node) voidaddHiddenInputParameter(String key, String value) voidaddPluginMeta(String key, com.alibaba.fastjson.JSONObject value) voidaddProzessParameter(String key, List<String> value) voidaddRenderParameter(String key, List<String> value) voidaddUrlParameter(String key, List<String> value) builds theIXFormfrom the contextbuilds theIXFormRenderConfigfrom the contextcom.alibaba.fastjson.JSONObjectbuilds theJSONObjectfrom the render-contextcom.alibaba.fastjson.JSONObjectdefault BenutzerDeprecated.default List<BenutzerGruppe>Deprecated.usegetUserGroups()List<com.hp.gagawa.java.Node>*com.alibaba.fastjson.JSONObjectDeprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.default StringDeprecated.usegetBaseUrl()Deprecated.Deprecated.Deprecated.UsegetWorkflowState()and the new workflow engine.Deprecated.Deprecated.Deprecated.default BenutzergetUser()Deprecated.UsegetUserModel()instead.org.pac4j.core.profile.CommonProfileDeprecated.get profile fromIUserbooleanbooleanbooleanrender()renders the context and returns the result asStringvoidrender(IExtendedFormRequestContext requestCtx) renders the context to theHttpServletResponseof the givenIExtendedFormRequestContextvoidrender(javax.servlet.http.HttpServletResponse response) renders the context to the givenHttpServletResponsevoidsetBaseUrl(String baseUrl) default voidsetBenutzer(Benutzer benutzer) Deprecated.default voidsetBenutzerGruppen(List<BenutzerGruppe> benutzerGruppen) Deprecated.User groups should be determined by the user.voidsetButtonDescriptor(XButtonDescriptor buttonDescriptor) voidvoidsetClientPluginResources(EFormResourceType type, List<IFormResource> resources) voidvoidsetClientResources(EFormResourceType type, List<MandantRessource> resources) voidsetCustomNodes(List<com.hp.gagawa.java.Node> customNodes) voidsetCustomValuesMap(Map<String, List<String[]>> customValuesMap) voidsetDynContainerMap(Map<String, FormContainerMetaData> fieldContainerMap) voidsetExternal(boolean isExternal) voidsetFormRequestContext(IFormRequestContext requestCtx) voidsetFormUploadList(List<Attachment> formUploadList) voidsetFormVersion(FormVersion formVersion) voidsetFRQSession(FRQSession frqSession) voidsetHiddenInputParameters(Map<String, String> hiddenInputParameters) voidsetHideRequiredHint(boolean isHideRequiredHint) voidsetI18nJSON(com.alibaba.fastjson.JSONObject i18nJson) voidvoidsetMandant(Mandant mandant) voidsetMandantCssResources(List<MandantRessource> cssMandantResources) Deprecated.voidsetMandantJsResources(List<MandantRessource> jsMandantResources) Deprecated.voidsetMandantPluginCssResources(List<IFormResource> cssMandantPluginResources) Deprecated.voidsetMandantPluginJsResources(List<IFormResource> jsMandantPluginResources) Deprecated.voidsetParameterWrapper(ParameterWrapper parameterWrapper) voidsetPluginMetaMap(Map<String, com.alibaba.fastjson.JSONObject> pluginMetaMap) voidvoidsetProjectResources(EFormResourceType type, List<ProjektRessource> resources) voidsetProjekt(Projekt projekt) voidsetProjektCssResources(List<ProjektRessource> cssProjektResources) Deprecated.voidsetProjektJsResources(List<ProjektRessource> jsProjektResources) Deprecated.voidsetProzessParameter(Map<String, List<String>> prozessParameters) voidsetRenderParameter(Map<String, List<String>> renderParameters) default voidsetRequestContext(String requestContext) Deprecated.voidsetRequestParameters(ParameterWrapper requestParameters) Deprecated.voidsetRequestType(EFormRequestType requestType) voidsetSession(XfcSession session) voidsetSessionAttributeMap(Map<String, Serializable> sessionAttributes) voidsetSessionAttributes(SessionAttributes sessionAttributes) Deprecated.voidsetSessionID(String sessionID) voidsetSessionTimeout(Duration timeout) voidDeprecated.UsesetWorkflowState(WorkflowState)and the new workflow engine.voidsetSubmitURL(String submitUrl) voidsetSystemPluginCssResources(List<IFormResource> cssSystemPluginResources) Deprecated.voidsetSystemPluginJsResources(List<IFormResource> jsSystemPluginResources) Deprecated.voidvoidsetSystemPluginResources(EFormResourceType type, List<IFormResource> resources) voidsetThemeTextbaustein(Textbaustein themeTextbaustein) voidsetUrlParameter(Map<String, List<String>> urlParameter) default voidDeprecated.UsesetUserModel(IUser)instead.voidsetUserContext(UserContext userContext) voidsetUserGroups(List<BenutzerGruppe> userGroups) Deprecated.User groups should be determined by the user.voidsetUserModel(IUser user) voidsetUserProfile(org.pac4j.core.profile.CommonProfile profile) Deprecated.get profile fromIUservoidsetUsesNewWorkflow(boolean usesNewWorkflow) voidsetValuesMap(Map<String, List<String[]>> valuesMap) voidsetVorgang(Vorgang vorgang) voidsetWorkflowState(WorkflowState workflowState) voidsetXFormConfig(IXFormRenderConfig xFormConfig)
-
Method Details
-
getUserContext
UserContext getUserContext() -
setUserContext
-
getHiddenInputParameter
-
addHiddenInputParameter
-
setHiddenInputParameters
-
getProzessParameter
-
addProzessParameter
-
setProzessParameter
-
getRenderParameter
-
addRenderParameter
-
setRenderParameter
-
getUrlParameter
-
addUrlParameter
-
setUrlParameter
-
getPluginMetaMap
-
addPluginMeta
-
setPluginMetaMap
-
getCustomNodes
List<com.hp.gagawa.java.Node> getCustomNodes() -
addCustomNode
void addCustomNode(com.hp.gagawa.java.Node node) -
setCustomNodes
-
getFormUploadList
List<Attachment> getFormUploadList() -
setFormUploadList
-
getValuesMap
-
setValuesMap
-
getCustomValuesMap
-
setCustomValuesMap
-
getFRQSession
FRQSession getFRQSession() -
setFRQSession
-
getSession
XfcSession getSession() -
setSession
-
getProjekt
Projekt getProjekt() -
setProjekt
-
getFormVersion
FormVersion getFormVersion() -
setFormVersion
-
getUserModel
IUser getUserModel() -
setUserModel
-
getUserGroups
List<BenutzerGruppe> getUserGroups() -
createUserDataJSON
com.alibaba.fastjson.JSONObject createUserDataJSON() -
getVorgang
Vorgang getVorgang() -
setVorgang
-
getStatus
Deprecated.UsegetWorkflowState()and the new workflow engine.- Returns:
- A state of the form record to use for rendering the form.
-
getWorkflowState
WorkflowState getWorkflowState() -
isUsesNewWorkflow
boolean isUsesNewWorkflow() -
setStatus
Deprecated.UsesetWorkflowState(WorkflowState)and the new workflow engine.- Parameters:
status- A state of the form record to use for rendering the form.
-
setWorkflowState
-
setUsesNewWorkflow
void setUsesNewWorkflow(boolean usesNewWorkflow) -
getMandant
Mandant getMandant() -
setMandant
-
getSessionAttributeMap
Map<String,Serializable> getSessionAttributeMap()- Returns:
- A
Mapof all key-value pairs in the currentHttpSession. Please note that changes to this map will not affect theHttpSession.
-
setSessionAttributeMap
- Parameters:
sessionAttributes- AMapof all key-value pairs in the currentHttpSession. Please note that changes to this map will not affect theHttpSession.
-
getSessionTimeout
Duration getSessionTimeout()- 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.
- Since:
- 7.2.1
-
setSessionTimeout
- 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.- Since:
- 7.2.1
-
getLocale
Locale getLocale() -
setLocale
-
getBaseUrl
String getBaseUrl() -
setBaseUrl
-
getSessionID
String getSessionID() -
setSessionID
-
getRequestType
EFormRequestType getRequestType() -
setRequestType
-
getSubmitURL
String getSubmitURL() -
setSubmitURL
-
isExternal
boolean isExternal() -
setExternal
void setExternal(boolean isExternal) -
getXFormConfig
IXFormRenderConfig getXFormConfig() -
setXFormConfig
-
getParameterWrapper
ParameterWrapper getParameterWrapper() -
setParameterWrapper
-
setI18nJSON
void setI18nJSON(com.alibaba.fastjson.JSONObject i18nJson) -
getI18nJSON
com.alibaba.fastjson.JSONObject getI18nJSON() -
getThemeTextbaustein
Textbaustein getThemeTextbaustein() -
setThemeTextbaustein
-
getDynContainerMap
Map<String,FormContainerMetaData> getDynContainerMap()*- Returns:
- A map between the name of a repeated container and its metadata. No mapping is present when the containeris not repeated.
-
setDynContainerMap
- 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
IFormRequestContext getFormRequestContext() -
setFormRequestContext
-
getProjectResourceMap
Map<EFormResourceType,List<ProjektRessource>> getProjectResourceMap() -
setProjectResourceMap
-
getProjectResources
-
setProjectResources
-
getClientResourceMap
Map<EFormResourceType,List<MandantRessource>> getClientResourceMap() -
setClientResourceMap
-
getClientResources
-
setClientResources
-
getClientPluginResourceMap
Map<EFormResourceType,List<IFormResource>> getClientPluginResourceMap() -
setClientPluginResourceMap
-
getClientPluginResources
-
setClientPluginResources
-
getSystemPluginResourceMap
Map<EFormResourceType,List<IFormResource>> getSystemPluginResourceMap() -
setSystemPluginResourceMap
-
getSystemPluginResources
-
setSystemPluginResources
-
isHideRequiredHint
boolean isHideRequiredHint() -
setHideRequiredHint
void setHideRequiredHint(boolean isHideRequiredHint) -
getButtonDescriptor
XButtonDescriptor getButtonDescriptor() -
setButtonDescriptor
-
encodeURL
-
buildXFormJSON
com.alibaba.fastjson.JSONObject buildXFormJSON() throws IOException, com.alibaba.fastjson.JSONExceptionbuilds theJSONObjectfrom the render-context- Returns:
- the created
JSONObject - Throws:
IOException- on errors while reading the formcom.alibaba.fastjson.JSONException- on errors while generating the formsJSONObject
-
buildXFormConfig
builds theIXFormRenderConfigfrom the context- Returns:
- the created
IXFormRenderConfig - Throws:
IOException- on errors while reading the form
-
buildXForm
builds theIXFormfrom the context- Returns:
- the created
IXForm - Throws:
IOException- on errors while reading the formcom.alibaba.fastjson.JSONException- on errors while generating the formsJSONObject
-
render
renders the context and returns the result asString- Returns:
- the rendered form as
String - Throws:
IOException- on errors while reading or rendering the formcom.alibaba.fastjson.JSONException- on errors while generating the formsJSONObject
-
render
void render(IExtendedFormRequestContext requestCtx) throws IOException, com.alibaba.fastjson.JSONException renders the context to theHttpServletResponseof the givenIExtendedFormRequestContext- Parameters:
requestCtx-IExtendedFormRequestContextwhichHttpServletResponseshould be used- Throws:
IOException- on errors while reading or rendering the formcom.alibaba.fastjson.JSONException- on errors while generating the formsJSONObject
-
render
void render(javax.servlet.http.HttpServletResponse response) throws IOException, com.alibaba.fastjson.JSONException renders the context to the givenHttpServletResponse- Parameters:
response-HttpServletResponsewhich should be used- Throws:
IOException- on errors while reading or rendering the formcom.alibaba.fastjson.JSONException- on errors while generating the formsJSONObject
-
getUserProfile
Deprecated.get profile fromIUser -
setUserProfile
Deprecated.get profile fromIUser -
getUser
Deprecated.UsegetUserModel()instead. -
setUser
Deprecated.UsesetUserModel(IUser)instead. -
getBenutzer
Deprecated.usegetUser() -
setBenutzer
Deprecated. -
getBenutzerGruppen
Deprecated.usegetUserGroups() -
setBenutzerGruppen
Deprecated.User groups should be determined by the user. UsesetUserModel(IUser)with a user that has user groups instead. -
setUserGroups
Deprecated.User groups should be determined by the user. UsesetUserModel(IUser)with a user that has user groups instead. -
getSessionAttributes
Deprecated. -
setSessionAttributes
Deprecated. -
getRequestParameters
Deprecated. -
setRequestParameters
Deprecated. -
getUrlParamMap
Deprecated. -
getMandantJsResources
Deprecated. -
setMandantJsResources
Deprecated. -
getMandantCssResources
Deprecated. -
setMandantCssResources
Deprecated. -
getProjektJsResources
Deprecated. -
setProjektJsResources
Deprecated. -
getProjektCssResources
Deprecated. -
setProjektCssResources
Deprecated. -
getSystemPluginJsResources
Deprecated. -
setSystemPluginJsResources
Deprecated. -
getSystemPluginCssResources
Deprecated. -
setSystemPluginCssResources
Deprecated. -
getMandantPluginJsResources
Deprecated. -
setMandantPluginJsResources
Deprecated. -
getMandantPluginCssResources
Deprecated. -
setMandantPluginCssResources
Deprecated. -
getRequestContext
Deprecated.usegetBaseUrl() -
setRequestContext
Deprecated.
-
getUser()