Package de.xima.fc.form.render
Class FormRenderContext
java.lang.Object
de.xima.fc.form.render.FormRenderContext
- All Implemented Interfaces:
IFormRenderContext
,Serializable
- Direct Known Subclasses:
ExtendedFormRenderContext
Context of an form-render-request with data for an renderer-call
- Author:
- XIMA MEDIA GmbH
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
Deprecated.never usedprotected List<BenutzerGruppe>
Deprecated.never usedprotected XButtonDescriptor
protected List<com.hp.gagawa.java.Node>
protected Map<String,
FormContainerMetaData> protected List<Attachment>
protected boolean
protected com.alibaba.fastjson.JSONObject
protected boolean
protected IFormRequestContext
protected Status
Deprecated.protected String
protected Textbaustein
protected boolean
protected WorkflowState
protected IXFormRenderConfig
-
Constructor Summary
Constructors -
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
List<com.hp.gagawa.java.Node>
*com.alibaba.fastjson.JSONObject
Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.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 baseURI) 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 isShowRequiredHint) 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) Deprecated.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) 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.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) 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 fromIUser
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, getRequestContext, getUser, setBenutzer, setBenutzerGruppen, setRequestContext, setUser
-
Field Details
-
requestCtx
-
prozessParameters
-
renderParameters
-
urlParameters
-
pluginMetaMap
-
valuesMap
-
customValuesMap
-
fieldContainerMap
-
customNodes
-
formUploadList
-
isExternal
protected boolean isExternal -
status
Deprecated. -
workflowState
-
usesNewWorkflow
protected boolean usesNewWorkflow -
themeTextbaustein
-
hideRequiredHint
protected boolean hideRequiredHint -
buttonDescriptor
-
submitURL
-
xFormConfig
-
i18nJson
protected com.alibaba.fastjson.JSONObject i18nJson -
benutzerGruppen
Deprecated.never used -
baseURL
Deprecated.never used
-
-
Constructor Details
-
FormRenderContext
- Throws:
ContextBuilderException
-
-
Method Details
-
getUserContext
- Specified by:
getUserContext
in interfaceIFormRenderContext
-
setUserContext
- Specified by:
setUserContext
in interfaceIFormRenderContext
-
getHiddenInputParameter
- Specified by:
getHiddenInputParameter
in interfaceIFormRenderContext
-
addHiddenInputParameter
- Specified by:
addHiddenInputParameter
in interfaceIFormRenderContext
-
setHiddenInputParameters
- Specified by:
setHiddenInputParameters
in interfaceIFormRenderContext
-
getProzessParameter
- Specified by:
getProzessParameter
in interfaceIFormRenderContext
-
addProzessParameter
- Specified by:
addProzessParameter
in interfaceIFormRenderContext
-
setProzessParameter
- Specified by:
setProzessParameter
in interfaceIFormRenderContext
-
getRenderParameter
- Specified by:
getRenderParameter
in interfaceIFormRenderContext
-
addRenderParameter
- Specified by:
addRenderParameter
in interfaceIFormRenderContext
-
setRenderParameter
- Specified by:
setRenderParameter
in interfaceIFormRenderContext
-
getUrlParameter
- Specified by:
getUrlParameter
in interfaceIFormRenderContext
-
addUrlParameter
- Specified by:
addUrlParameter
in interfaceIFormRenderContext
-
setUrlParameter
- Specified by:
setUrlParameter
in interfaceIFormRenderContext
-
getPluginMetaMap
- Specified by:
getPluginMetaMap
in interfaceIFormRenderContext
-
addPluginMeta
- Specified by:
addPluginMeta
in interfaceIFormRenderContext
-
setPluginMetaMap
- Specified by:
setPluginMetaMap
in interfaceIFormRenderContext
-
getCustomNodes
- Specified by:
getCustomNodes
in interfaceIFormRenderContext
-
addCustomNode
public void addCustomNode(com.hp.gagawa.java.Node node) - Specified by:
addCustomNode
in interfaceIFormRenderContext
-
setCustomNodes
- Specified by:
setCustomNodes
in interfaceIFormRenderContext
-
getValuesMap
- Specified by:
getValuesMap
in interfaceIFormRenderContext
-
setValuesMap
- Specified by:
setValuesMap
in interfaceIFormRenderContext
-
getCustomValuesMap
- Specified by:
getCustomValuesMap
in interfaceIFormRenderContext
-
setCustomValuesMap
- Specified by:
setCustomValuesMap
in interfaceIFormRenderContext
-
getFRQSession
- Specified by:
getFRQSession
in interfaceIFormRenderContext
-
setFRQSession
- Specified by:
setFRQSession
in interfaceIFormRenderContext
-
getSession
- Specified by:
getSession
in interfaceIFormRenderContext
-
setSession
- Specified by:
setSession
in interfaceIFormRenderContext
-
getProjekt
- Specified by:
getProjekt
in interfaceIFormRenderContext
-
setProjekt
- Specified by:
setProjekt
in interfaceIFormRenderContext
-
getFormVersion
- Specified by:
getFormVersion
in interfaceIFormRenderContext
-
setFormVersion
- Specified by:
setFormVersion
in interfaceIFormRenderContext
-
getUserModel
- Specified by:
getUserModel
in interfaceIFormRenderContext
-
setUserModel
- Specified by:
setUserModel
in interfaceIFormRenderContext
-
getVorgang
- Specified by:
getVorgang
in interfaceIFormRenderContext
-
setVorgang
- Specified by:
setVorgang
in interfaceIFormRenderContext
-
getMandant
- Specified by:
getMandant
in interfaceIFormRenderContext
-
setMandant
- Specified by:
setMandant
in interfaceIFormRenderContext
-
getLocale
- Specified by:
getLocale
in interfaceIFormRenderContext
-
setLocale
- Specified by:
setLocale
in interfaceIFormRenderContext
-
getUserGroups
- Specified by:
getUserGroups
in interfaceIFormRenderContext
-
createUserDataJSON
public com.alibaba.fastjson.JSONObject createUserDataJSON()- Specified by:
createUserDataJSON
in interfaceIFormRenderContext
-
getSessionAttributeMap
- Specified by:
getSessionAttributeMap
in interfaceIFormRenderContext
- Returns:
- A
Map
of all key-value pairs in the currentHttpSession
. Please note that changes to this map will not affect theHttpSession
.
-
setSessionAttributeMap
- Specified by:
setSessionAttributeMap
in interfaceIFormRenderContext
- Parameters:
sessionAttributes
- AMap
of all key-value pairs in the currentHttpSession
. Please note that changes to this map will not affect theHttpSession
.
-
getSessionTimeout
- Specified by:
getSessionTimeout
in interfaceIFormRenderContext
- 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
- Specified by:
setSessionTimeout
in interfaceIFormRenderContext
- 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
- Specified by:
getBaseUrl
in interfaceIFormRenderContext
-
setBaseUrl
- Specified by:
setBaseUrl
in interfaceIFormRenderContext
-
getSessionID
- Specified by:
getSessionID
in interfaceIFormRenderContext
-
setSessionID
- Specified by:
setSessionID
in interfaceIFormRenderContext
-
getRequestType
- Specified by:
getRequestType
in interfaceIFormRenderContext
-
setRequestType
- Specified by:
setRequestType
in interfaceIFormRenderContext
-
getParameterWrapper
- Specified by:
getParameterWrapper
in interfaceIFormRenderContext
-
setParameterWrapper
Deprecated.- Specified by:
setParameterWrapper
in interfaceIFormRenderContext
-
getStatus
Deprecated.- Specified by:
getStatus
in interfaceIFormRenderContext
- Returns:
- A state of the form record to use for rendering the form.
-
setStatus
Deprecated.- Specified by:
setStatus
in interfaceIFormRenderContext
- Parameters:
status
- A state of the form record to use for rendering the form.
-
getSubmitURL
- Specified by:
getSubmitURL
in interfaceIFormRenderContext
-
setSubmitURL
- Specified by:
setSubmitURL
in interfaceIFormRenderContext
-
isExternal
public boolean isExternal()- Specified by:
isExternal
in interfaceIFormRenderContext
-
setExternal
public void setExternal(boolean isExternal) - Specified by:
setExternal
in interfaceIFormRenderContext
-
isUsesNewWorkflow
public boolean isUsesNewWorkflow()- Specified by:
isUsesNewWorkflow
in interfaceIFormRenderContext
-
setUsesNewWorkflow
public void setUsesNewWorkflow(boolean usesNewWorkflow) - Specified by:
setUsesNewWorkflow
in interfaceIFormRenderContext
-
getWorkflowState
- Specified by:
getWorkflowState
in interfaceIFormRenderContext
-
setWorkflowState
- Specified by:
setWorkflowState
in interfaceIFormRenderContext
-
getXFormConfig
- Specified by:
getXFormConfig
in interfaceIFormRenderContext
-
setXFormConfig
- Specified by:
setXFormConfig
in interfaceIFormRenderContext
-
encodeURL
- Specified by:
encodeURL
in interfaceIFormRenderContext
-
getFormUploadList
- Specified by:
getFormUploadList
in interfaceIFormRenderContext
-
setFormUploadList
- Specified by:
setFormUploadList
in interfaceIFormRenderContext
-
setI18nJSON
public void setI18nJSON(com.alibaba.fastjson.JSONObject i18nJson) - Specified by:
setI18nJSON
in interfaceIFormRenderContext
-
getI18nJSON
public com.alibaba.fastjson.JSONObject getI18nJSON()- Specified by:
getI18nJSON
in interfaceIFormRenderContext
-
getDynContainerMap
Description copied from interface:IFormRenderContext
*- Specified by:
getDynContainerMap
in interfaceIFormRenderContext
- Returns:
- A map between the name of a repeated container and its metadata. No mapping is present when the containeris not repeated.
-
setDynContainerMap
- Specified by:
setDynContainerMap
in interfaceIFormRenderContext
- 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
- Specified by:
getFormRequestContext
in interfaceIFormRenderContext
-
setFormRequestContext
- Specified by:
setFormRequestContext
in interfaceIFormRenderContext
-
getThemeTextbaustein
- Specified by:
getThemeTextbaustein
in interfaceIFormRenderContext
-
setThemeTextbaustein
- Specified by:
setThemeTextbaustein
in interfaceIFormRenderContext
-
getProjectResourceMap
- Specified by:
getProjectResourceMap
in interfaceIFormRenderContext
-
setProjectResourceMap
- Specified by:
setProjectResourceMap
in interfaceIFormRenderContext
-
isHideRequiredHint
public boolean isHideRequiredHint()- Specified by:
isHideRequiredHint
in interfaceIFormRenderContext
-
setHideRequiredHint
public void setHideRequiredHint(boolean isShowRequiredHint) - Specified by:
setHideRequiredHint
in interfaceIFormRenderContext
-
getButtonDescriptor
- Specified by:
getButtonDescriptor
in interfaceIFormRenderContext
-
setButtonDescriptor
- Specified by:
setButtonDescriptor
in interfaceIFormRenderContext
-
getProjectResources
- Specified by:
getProjectResources
in interfaceIFormRenderContext
-
setProjectResources
- Specified by:
setProjectResources
in interfaceIFormRenderContext
-
getClientResourceMap
- Specified by:
getClientResourceMap
in interfaceIFormRenderContext
-
setClientResourceMap
- Specified by:
setClientResourceMap
in interfaceIFormRenderContext
-
getClientResources
- Specified by:
getClientResources
in interfaceIFormRenderContext
-
setClientResources
- Specified by:
setClientResources
in interfaceIFormRenderContext
-
getClientPluginResourceMap
- Specified by:
getClientPluginResourceMap
in interfaceIFormRenderContext
-
setClientPluginResourceMap
- Specified by:
setClientPluginResourceMap
in interfaceIFormRenderContext
-
getClientPluginResources
- Specified by:
getClientPluginResources
in interfaceIFormRenderContext
-
setClientPluginResources
- Specified by:
setClientPluginResources
in interfaceIFormRenderContext
-
getSystemPluginResourceMap
- Specified by:
getSystemPluginResourceMap
in interfaceIFormRenderContext
-
setSystemPluginResourceMap
- Specified by:
setSystemPluginResourceMap
in interfaceIFormRenderContext
-
getSystemPluginResources
- Specified by:
getSystemPluginResources
in interfaceIFormRenderContext
-
setSystemPluginResources
- Specified by:
setSystemPluginResources
in interfaceIFormRenderContext
-
buildXForm
Description copied from interface:IFormRenderContext
builds theIXForm
from the context- Specified by:
buildXForm
in interfaceIFormRenderContext
- Returns:
- the created
IXForm
- Throws:
IOException
- on errors while reading the formcom.alibaba.fastjson.JSONException
- on errors while generating the formsJSONObject
-
buildXFormConfig
Description copied from interface:IFormRenderContext
builds theIXFormRenderConfig
from the context- Specified by:
buildXFormConfig
in interfaceIFormRenderContext
- Returns:
- the created
IXFormRenderConfig
- Throws:
IOException
- on errors while reading the form
-
buildXFormJSON
public com.alibaba.fastjson.JSONObject buildXFormJSON() throws IOException, com.alibaba.fastjson.JSONExceptionDescription copied from interface:IFormRenderContext
builds theJSONObject
from the render-context- Specified by:
buildXFormJSON
in interfaceIFormRenderContext
- Returns:
- the created
JSONObject
- Throws:
IOException
- on errors while reading the formcom.alibaba.fastjson.JSONException
- on errors while generating the formsJSONObject
-
render
Description copied from interface:IFormRenderContext
renders the context and returns the result asString
- Specified by:
render
in interfaceIFormRenderContext
- 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
public void render(IExtendedFormRequestContext requestCtx) throws IOException, com.alibaba.fastjson.JSONException Description copied from interface:IFormRenderContext
renders the context to theHttpServletResponse
of the givenIExtendedFormRequestContext
- Specified by:
render
in interfaceIFormRenderContext
- 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
public void render(javax.servlet.http.HttpServletResponse response) throws IOException, com.alibaba.fastjson.JSONException Description copied from interface:IFormRenderContext
renders the context to the givenHttpServletResponse
- Specified by:
render
in interfaceIFormRenderContext
- 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
- Specified by:
getUserProfile
in interfaceIFormRenderContext
-
setUserProfile
Deprecated.get profile fromIUser
- Specified by:
setUserProfile
in interfaceIFormRenderContext
-
setUserGroups
Deprecated.User groups should be determined by the user. UsesetUserModel(IUser)
with a user that has user groups instead.- Specified by:
setUserGroups
in interfaceIFormRenderContext
-
getSessionAttributes
Deprecated.- Specified by:
getSessionAttributes
in interfaceIFormRenderContext
-
setSessionAttributes
Deprecated.- Specified by:
setSessionAttributes
in interfaceIFormRenderContext
-
getRequestParameters
Deprecated.- Specified by:
getRequestParameters
in interfaceIFormRenderContext
-
setRequestParameters
Deprecated.- Specified by:
setRequestParameters
in interfaceIFormRenderContext
-
getUrlParamMap
Deprecated.- Specified by:
getUrlParamMap
in interfaceIFormRenderContext
-
getMandantJsResources
Deprecated.- Specified by:
getMandantJsResources
in interfaceIFormRenderContext
-
setMandantJsResources
Deprecated.- Specified by:
setMandantJsResources
in interfaceIFormRenderContext
-
getMandantCssResources
Deprecated.- Specified by:
getMandantCssResources
in interfaceIFormRenderContext
-
setMandantCssResources
Deprecated.- Specified by:
setMandantCssResources
in interfaceIFormRenderContext
-
getProjektJsResources
Deprecated.- Specified by:
getProjektJsResources
in interfaceIFormRenderContext
-
setProjektJsResources
Deprecated.- Specified by:
setProjektJsResources
in interfaceIFormRenderContext
-
getProjektCssResources
Deprecated.- Specified by:
getProjektCssResources
in interfaceIFormRenderContext
-
setProjektCssResources
Deprecated.- Specified by:
setProjektCssResources
in interfaceIFormRenderContext
-
getSystemPluginJsResources
Deprecated.- Specified by:
getSystemPluginJsResources
in interfaceIFormRenderContext
-
setSystemPluginJsResources
Deprecated.- Specified by:
setSystemPluginJsResources
in interfaceIFormRenderContext
-
getSystemPluginCssResources
Deprecated.- Specified by:
getSystemPluginCssResources
in interfaceIFormRenderContext
-
setSystemPluginCssResources
Deprecated.- Specified by:
setSystemPluginCssResources
in interfaceIFormRenderContext
-
getMandantPluginJsResources
Deprecated.- Specified by:
getMandantPluginJsResources
in interfaceIFormRenderContext
-
setMandantPluginJsResources
Deprecated.- Specified by:
setMandantPluginJsResources
in interfaceIFormRenderContext
-
getMandantPluginCssResources
Deprecated.- Specified by:
getMandantPluginCssResources
in interfaceIFormRenderContext
-
setMandantPluginCssResources
Deprecated.- Specified by:
setMandantPluginCssResources
in interfaceIFormRenderContext
-