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 TypeMethodDescriptionvoid
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) builds theIXForm
from the contextbuilds theIXFormRenderConfig
from the contextcom.alibaba.fastjson.JSONObject
builds theJSONObject
from the render-contextcom.alibaba.fastjson.JSONObject
default Benutzer
Deprecated.default List<BenutzerGruppe>
Deprecated.usegetUserGroups()
List<com.hp.gagawa.java.Node>
*com.alibaba.fastjson.JSONObject
Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.default String
Deprecated.usegetBaseUrl()
Deprecated.Deprecated.Deprecated.UsegetWorkflowState()
and the new workflow engine.Deprecated.Deprecated.Deprecated.default Benutzer
getUser()
Deprecated.UsegetUserModel()
instead.org.pac4j.core.profile.CommonProfile
Deprecated.get profile fromIUser
boolean
boolean
boolean
render()
renders the context and returns the result asString
void
render
(IExtendedFormRequestContext requestCtx) renders the context to theHttpServletResponse
of the givenIExtendedFormRequestContext
void
render
(javax.servlet.http.HttpServletResponse response) renders the context to the givenHttpServletResponse
void
setBaseUrl
(String baseUrl) default void
setBenutzer
(Benutzer benutzer) Deprecated.default void
setBenutzerGruppen
(List<BenutzerGruppe> benutzerGruppen) Deprecated.User groups should be determined by the user.void
setButtonDescriptor
(XButtonDescriptor buttonDescriptor) void
void
setClientPluginResources
(EFormResourceType type, List<IFormResource> resources) void
void
setClientResources
(EFormResourceType type, List<MandantRessource> resources) void
setCustomNodes
(List<com.hp.gagawa.java.Node> customNodes) void
setCustomValuesMap
(Map<String, List<String[]>> customValuesMap) void
setDynContainerMap
(Map<String, FormContainerMetaData> fieldContainerMap) void
setExternal
(boolean isExternal) void
setFormRequestContext
(IFormRequestContext requestCtx) void
setFormUploadList
(List<Attachment> formUploadList) void
setFormVersion
(FormVersion formVersion) void
setFRQSession
(FRQSession frqSession) void
setHiddenInputParameters
(Map<String, String> hiddenInputParameters) void
setHideRequiredHint
(boolean isHideRequiredHint) void
setI18nJSON
(com.alibaba.fastjson.JSONObject i18nJson) void
void
setMandant
(Mandant mandant) void
setMandantCssResources
(List<MandantRessource> cssMandantResources) Deprecated.void
setMandantJsResources
(List<MandantRessource> jsMandantResources) Deprecated.void
setMandantPluginCssResources
(List<IFormResource> cssMandantPluginResources) Deprecated.void
setMandantPluginJsResources
(List<IFormResource> jsMandantPluginResources) Deprecated.void
setParameterWrapper
(ParameterWrapper parameterWrapper) void
setPluginMetaMap
(Map<String, com.alibaba.fastjson.JSONObject> pluginMetaMap) void
void
setProjectResources
(EFormResourceType type, List<ProjektRessource> resources) void
setProjekt
(Projekt projekt) void
setProjektCssResources
(List<ProjektRessource> cssProjektResources) Deprecated.void
setProjektJsResources
(List<ProjektRessource> jsProjektResources) Deprecated.void
setProzessParameter
(Map<String, List<String>> prozessParameters) void
setRenderParameter
(Map<String, List<String>> renderParameters) default void
setRequestContext
(String requestContext) Deprecated.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
Deprecated.UsesetWorkflowState(WorkflowState)
and the new workflow engine.void
setSubmitURL
(String submitUrl) void
setSystemPluginCssResources
(List<IFormResource> cssSystemPluginResources) Deprecated.void
setSystemPluginJsResources
(List<IFormResource> jsSystemPluginResources) Deprecated.void
void
setSystemPluginResources
(EFormResourceType type, List<IFormResource> resources) void
setThemeTextbaustein
(Textbaustein themeTextbaustein) void
setUrlParameter
(Map<String, List<String>> urlParameter) default void
Deprecated.UsesetUserModel(IUser)
instead.void
setUserContext
(UserContext userContext) void
setUserGroups
(List<BenutzerGruppe> userGroups) Deprecated.User groups should be determined by the user.void
setUserModel
(IUser user) void
setUserProfile
(org.pac4j.core.profile.CommonProfile profile) Deprecated.get profile fromIUser
void
setUsesNewWorkflow
(boolean usesNewWorkflow) void
setValuesMap
(Map<String, List<String[]>> valuesMap) void
setVorgang
(Vorgang vorgang) void
setWorkflowState
(WorkflowState workflowState) void
setXFormConfig
(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
Map
of all key-value pairs in the currentHttpSession
. Please note that changes to this map will not affect theHttpSession
.
-
setSessionAttributeMap
- Parameters:
sessionAttributes
- AMap
of 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 theJSONObject
from 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 theIXFormRenderConfig
from the context- Returns:
- the created
IXFormRenderConfig
- Throws:
IOException
- on errors while reading the form
-
buildXForm
builds theIXForm
from 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 theHttpServletResponse
of the givenIExtendedFormRequestContext
- Parameters:
requestCtx
-IExtendedFormRequestContext
whichHttpServletResponse
should 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
-HttpServletResponse
which 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()