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 StringDeprecated.never usedprotected List<BenutzerGruppe>Deprecated.never usedprotected XButtonDescriptorprotected List<com.hp.gagawa.java.Node>protected Map<String,FormContainerMetaData> protected List<Attachment>protected booleanprotected com.alibaba.fastjson.JSONObjectprotected booleanprotected IFormRequestContextprotected StatusDeprecated.protected Stringprotected Textbausteinprotected booleanprotected WorkflowStateprotected IXFormRenderConfig -
Constructor Summary
Constructors -
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.JSONObjectList<com.hp.gagawa.java.Node>*com.alibaba.fastjson.JSONObjectDeprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.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 baseURI) 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 isShowRequiredHint) 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) Deprecated.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) 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.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) voidsetUserContext(UserContext userContext) voidsetUserGroups(List<BenutzerGruppe> benutzerGruppen) 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) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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:
getUserContextin interfaceIFormRenderContext
-
setUserContext
- Specified by:
setUserContextin interfaceIFormRenderContext
-
getHiddenInputParameter
- Specified by:
getHiddenInputParameterin interfaceIFormRenderContext
-
addHiddenInputParameter
- Specified by:
addHiddenInputParameterin interfaceIFormRenderContext
-
setHiddenInputParameters
- Specified by:
setHiddenInputParametersin interfaceIFormRenderContext
-
getProzessParameter
- Specified by:
getProzessParameterin interfaceIFormRenderContext
-
addProzessParameter
- Specified by:
addProzessParameterin interfaceIFormRenderContext
-
setProzessParameter
- Specified by:
setProzessParameterin interfaceIFormRenderContext
-
getRenderParameter
- Specified by:
getRenderParameterin interfaceIFormRenderContext
-
addRenderParameter
- Specified by:
addRenderParameterin interfaceIFormRenderContext
-
setRenderParameter
- Specified by:
setRenderParameterin interfaceIFormRenderContext
-
getUrlParameter
- Specified by:
getUrlParameterin interfaceIFormRenderContext
-
addUrlParameter
- Specified by:
addUrlParameterin interfaceIFormRenderContext
-
setUrlParameter
- Specified by:
setUrlParameterin interfaceIFormRenderContext
-
getPluginMetaMap
- Specified by:
getPluginMetaMapin interfaceIFormRenderContext
-
addPluginMeta
- Specified by:
addPluginMetain interfaceIFormRenderContext
-
setPluginMetaMap
- Specified by:
setPluginMetaMapin interfaceIFormRenderContext
-
getCustomNodes
- Specified by:
getCustomNodesin interfaceIFormRenderContext
-
addCustomNode
public void addCustomNode(com.hp.gagawa.java.Node node) - Specified by:
addCustomNodein interfaceIFormRenderContext
-
setCustomNodes
- Specified by:
setCustomNodesin interfaceIFormRenderContext
-
getValuesMap
- Specified by:
getValuesMapin interfaceIFormRenderContext
-
setValuesMap
- Specified by:
setValuesMapin interfaceIFormRenderContext
-
getCustomValuesMap
- Specified by:
getCustomValuesMapin interfaceIFormRenderContext
-
setCustomValuesMap
- Specified by:
setCustomValuesMapin interfaceIFormRenderContext
-
getFRQSession
- Specified by:
getFRQSessionin interfaceIFormRenderContext
-
setFRQSession
- Specified by:
setFRQSessionin interfaceIFormRenderContext
-
getSession
- Specified by:
getSessionin interfaceIFormRenderContext
-
setSession
- Specified by:
setSessionin interfaceIFormRenderContext
-
getProjekt
- Specified by:
getProjektin interfaceIFormRenderContext
-
setProjekt
- Specified by:
setProjektin interfaceIFormRenderContext
-
getFormVersion
- Specified by:
getFormVersionin interfaceIFormRenderContext
-
setFormVersion
- Specified by:
setFormVersionin interfaceIFormRenderContext
-
getUserModel
- Specified by:
getUserModelin interfaceIFormRenderContext
-
setUserModel
- Specified by:
setUserModelin interfaceIFormRenderContext
-
getVorgang
- Specified by:
getVorgangin interfaceIFormRenderContext
-
setVorgang
- Specified by:
setVorgangin interfaceIFormRenderContext
-
getMandant
- Specified by:
getMandantin interfaceIFormRenderContext
-
setMandant
- Specified by:
setMandantin interfaceIFormRenderContext
-
getLocale
- Specified by:
getLocalein interfaceIFormRenderContext
-
setLocale
- Specified by:
setLocalein interfaceIFormRenderContext
-
getUserGroups
- Specified by:
getUserGroupsin interfaceIFormRenderContext
-
createUserDataJSON
public com.alibaba.fastjson.JSONObject createUserDataJSON()- Specified by:
createUserDataJSONin interfaceIFormRenderContext
-
getSessionAttributeMap
- Specified by:
getSessionAttributeMapin interfaceIFormRenderContext- Returns:
- A
Mapof all key-value pairs in the currentHttpSession. Please note that changes to this map will not affect theHttpSession.
-
setSessionAttributeMap
- Specified by:
setSessionAttributeMapin interfaceIFormRenderContext- Parameters:
sessionAttributes- AMapof all key-value pairs in the currentHttpSession. Please note that changes to this map will not affect theHttpSession.
-
getSessionTimeout
- Specified by:
getSessionTimeoutin 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:
setSessionTimeoutin 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:
getBaseUrlin interfaceIFormRenderContext
-
setBaseUrl
- Specified by:
setBaseUrlin interfaceIFormRenderContext
-
getSessionID
- Specified by:
getSessionIDin interfaceIFormRenderContext
-
setSessionID
- Specified by:
setSessionIDin interfaceIFormRenderContext
-
getRequestType
- Specified by:
getRequestTypein interfaceIFormRenderContext
-
setRequestType
- Specified by:
setRequestTypein interfaceIFormRenderContext
-
getParameterWrapper
- Specified by:
getParameterWrapperin interfaceIFormRenderContext
-
setParameterWrapper
Deprecated.- Specified by:
setParameterWrapperin interfaceIFormRenderContext
-
getStatus
Deprecated.- Specified by:
getStatusin interfaceIFormRenderContext- Returns:
- A state of the form record to use for rendering the form.
-
setStatus
Deprecated.- Specified by:
setStatusin interfaceIFormRenderContext- Parameters:
status- A state of the form record to use for rendering the form.
-
getSubmitURL
- Specified by:
getSubmitURLin interfaceIFormRenderContext
-
setSubmitURL
- Specified by:
setSubmitURLin interfaceIFormRenderContext
-
isExternal
public boolean isExternal()- Specified by:
isExternalin interfaceIFormRenderContext
-
setExternal
public void setExternal(boolean isExternal) - Specified by:
setExternalin interfaceIFormRenderContext
-
isUsesNewWorkflow
public boolean isUsesNewWorkflow()- Specified by:
isUsesNewWorkflowin interfaceIFormRenderContext
-
setUsesNewWorkflow
public void setUsesNewWorkflow(boolean usesNewWorkflow) - Specified by:
setUsesNewWorkflowin interfaceIFormRenderContext
-
getWorkflowState
- Specified by:
getWorkflowStatein interfaceIFormRenderContext
-
setWorkflowState
- Specified by:
setWorkflowStatein interfaceIFormRenderContext
-
getXFormConfig
- Specified by:
getXFormConfigin interfaceIFormRenderContext
-
setXFormConfig
- Specified by:
setXFormConfigin interfaceIFormRenderContext
-
encodeURL
- Specified by:
encodeURLin interfaceIFormRenderContext
-
getFormUploadList
- Specified by:
getFormUploadListin interfaceIFormRenderContext
-
setFormUploadList
- Specified by:
setFormUploadListin interfaceIFormRenderContext
-
setI18nJSON
public void setI18nJSON(com.alibaba.fastjson.JSONObject i18nJson) - Specified by:
setI18nJSONin interfaceIFormRenderContext
-
getI18nJSON
public com.alibaba.fastjson.JSONObject getI18nJSON()- Specified by:
getI18nJSONin interfaceIFormRenderContext
-
getDynContainerMap
Description copied from interface:IFormRenderContext*- Specified by:
getDynContainerMapin 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:
setDynContainerMapin 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:
getFormRequestContextin interfaceIFormRenderContext
-
setFormRequestContext
- Specified by:
setFormRequestContextin interfaceIFormRenderContext
-
getThemeTextbaustein
- Specified by:
getThemeTextbausteinin interfaceIFormRenderContext
-
setThemeTextbaustein
- Specified by:
setThemeTextbausteinin interfaceIFormRenderContext
-
getProjectResourceMap
- Specified by:
getProjectResourceMapin interfaceIFormRenderContext
-
setProjectResourceMap
- Specified by:
setProjectResourceMapin interfaceIFormRenderContext
-
isHideRequiredHint
public boolean isHideRequiredHint()- Specified by:
isHideRequiredHintin interfaceIFormRenderContext
-
setHideRequiredHint
public void setHideRequiredHint(boolean isShowRequiredHint) - Specified by:
setHideRequiredHintin interfaceIFormRenderContext
-
getButtonDescriptor
- Specified by:
getButtonDescriptorin interfaceIFormRenderContext
-
setButtonDescriptor
- Specified by:
setButtonDescriptorin interfaceIFormRenderContext
-
getProjectResources
- Specified by:
getProjectResourcesin interfaceIFormRenderContext
-
setProjectResources
- Specified by:
setProjectResourcesin interfaceIFormRenderContext
-
getClientResourceMap
- Specified by:
getClientResourceMapin interfaceIFormRenderContext
-
setClientResourceMap
- Specified by:
setClientResourceMapin interfaceIFormRenderContext
-
getClientResources
- Specified by:
getClientResourcesin interfaceIFormRenderContext
-
setClientResources
- Specified by:
setClientResourcesin interfaceIFormRenderContext
-
getClientPluginResourceMap
- Specified by:
getClientPluginResourceMapin interfaceIFormRenderContext
-
setClientPluginResourceMap
- Specified by:
setClientPluginResourceMapin interfaceIFormRenderContext
-
getClientPluginResources
- Specified by:
getClientPluginResourcesin interfaceIFormRenderContext
-
setClientPluginResources
- Specified by:
setClientPluginResourcesin interfaceIFormRenderContext
-
getSystemPluginResourceMap
- Specified by:
getSystemPluginResourceMapin interfaceIFormRenderContext
-
setSystemPluginResourceMap
- Specified by:
setSystemPluginResourceMapin interfaceIFormRenderContext
-
getSystemPluginResources
- Specified by:
getSystemPluginResourcesin interfaceIFormRenderContext
-
setSystemPluginResources
- Specified by:
setSystemPluginResourcesin interfaceIFormRenderContext
-
buildXForm
Description copied from interface:IFormRenderContextbuilds theIXFormfrom the context- Specified by:
buildXFormin 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:IFormRenderContextbuilds theIXFormRenderConfigfrom the context- Specified by:
buildXFormConfigin 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:IFormRenderContextbuilds theJSONObjectfrom the render-context- Specified by:
buildXFormJSONin 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:IFormRenderContextrenders the context and returns the result asString- Specified by:
renderin 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:IFormRenderContextrenders the context to theHttpServletResponseof the givenIExtendedFormRequestContext- Specified by:
renderin interfaceIFormRenderContext- 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
public void render(javax.servlet.http.HttpServletResponse response) throws IOException, com.alibaba.fastjson.JSONException Description copied from interface:IFormRenderContextrenders the context to the givenHttpServletResponse- Specified by:
renderin interfaceIFormRenderContext- 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- Specified by:
getUserProfilein interfaceIFormRenderContext
-
setUserProfile
Deprecated.get profile fromIUser- Specified by:
setUserProfilein interfaceIFormRenderContext
-
setUserGroups
Deprecated.User groups should be determined by the user. UsesetUserModel(IUser)with a user that has user groups instead.- Specified by:
setUserGroupsin interfaceIFormRenderContext
-
getSessionAttributes
Deprecated.- Specified by:
getSessionAttributesin interfaceIFormRenderContext
-
setSessionAttributes
Deprecated.- Specified by:
setSessionAttributesin interfaceIFormRenderContext
-
getRequestParameters
Deprecated.- Specified by:
getRequestParametersin interfaceIFormRenderContext
-
setRequestParameters
Deprecated.- Specified by:
setRequestParametersin interfaceIFormRenderContext
-
getUrlParamMap
Deprecated.- Specified by:
getUrlParamMapin interfaceIFormRenderContext
-
getMandantJsResources
Deprecated.- Specified by:
getMandantJsResourcesin interfaceIFormRenderContext
-
setMandantJsResources
Deprecated.- Specified by:
setMandantJsResourcesin interfaceIFormRenderContext
-
getMandantCssResources
Deprecated.- Specified by:
getMandantCssResourcesin interfaceIFormRenderContext
-
setMandantCssResources
Deprecated.- Specified by:
setMandantCssResourcesin interfaceIFormRenderContext
-
getProjektJsResources
Deprecated.- Specified by:
getProjektJsResourcesin interfaceIFormRenderContext
-
setProjektJsResources
Deprecated.- Specified by:
setProjektJsResourcesin interfaceIFormRenderContext
-
getProjektCssResources
Deprecated.- Specified by:
getProjektCssResourcesin interfaceIFormRenderContext
-
setProjektCssResources
Deprecated.- Specified by:
setProjektCssResourcesin interfaceIFormRenderContext
-
getSystemPluginJsResources
Deprecated.- Specified by:
getSystemPluginJsResourcesin interfaceIFormRenderContext
-
setSystemPluginJsResources
Deprecated.- Specified by:
setSystemPluginJsResourcesin interfaceIFormRenderContext
-
getSystemPluginCssResources
Deprecated.- Specified by:
getSystemPluginCssResourcesin interfaceIFormRenderContext
-
setSystemPluginCssResources
Deprecated.- Specified by:
setSystemPluginCssResourcesin interfaceIFormRenderContext
-
getMandantPluginJsResources
Deprecated.- Specified by:
getMandantPluginJsResourcesin interfaceIFormRenderContext
-
setMandantPluginJsResources
Deprecated.- Specified by:
setMandantPluginJsResourcesin interfaceIFormRenderContext
-
getMandantPluginCssResources
Deprecated.- Specified by:
getMandantPluginCssResourcesin interfaceIFormRenderContext
-
setMandantPluginCssResources
Deprecated.- Specified by:
setMandantPluginCssResourcesin interfaceIFormRenderContext
-