Class AbstractFormRenderer
- java.lang.Object
-
- org.kie.server.services.jbpm.ui.form.render.AbstractFormRenderer
-
- All Implemented Interfaces:
FormRenderer
- Direct Known Subclasses:
BootstrapFormRenderer,PatternflyFormRenderer
public abstract class AbstractFormRenderer extends Object implements FormRenderer
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAbstractFormRenderer.DocumentItem
-
Field Summary
Fields Modifier and Type Field Description static StringCASE_LAYOUT_TEMPLATEstatic StringFORM_GROUP_LAYOUT_TEMPLATEstatic StringHEADER_LAYOUT_TEMPLATEstatic StringMAIN_LAYOUT_TEMPLATEstatic StringPROCESS_LAYOUT_TEMPLATEstatic StringTABLE_LAYOUT_TEMPLATEstatic StringTASK_LAYOUT_TEMPLATE
-
Constructor Summary
Constructors Constructor Description AbstractFormRenderer(String serverPath, String resources)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected StringappendExtractionExpression(String type, String name, String id, String jsType)protected voidappendFieldJSON(StringBuilder jsonTemplate, String type, String name, String id, String jsType)protected voidappendRoleAssignment(org.jbpm.casemgmt.api.model.CaseDefinition caseDefinition, StringBuilder jsonTemplate)protected StringbuildFunctionWithBody(String name, String body)protected StringbuildScriptData(List<String> scriptDataList)voidconfigure(String serverPath, String resources)protected StringgetDocumentPath()protected StringgetEndpointSuffix()Additional (and optional) suffix to be added to an endpoint (used when starting process or case or interacting with user task)protected StringgetExtractionValue(String jsType)protected StringgetJSFieldType(String type)protected StringgetServerEndpointPath()protected StringgetValidationPatternByType(String type)protected voidhandleMultiSubForm(FormInstance topLevelForm, FormField field, Map<String,Object> inputs, Map<String,Object> outputs, String layoutTemplate, StringBuilder jsonTemplate, List<String> scriptDataList, StringBuilder content)protected voidhandleSubForm(FormInstance topLevelForm, FormField field, Map<String,Object> inputs, Map<String,Object> outputs, String layoutTemplate, StringBuilder jsonTemplate, boolean wrapJson, List<String> scriptDataList, StringBuilder content)protected voidloadTemplate(freemarker.cache.StringTemplateLoader loader, String templateId, InputStream stream)protected voidloadTemplate(String templateId, InputStream stream)protected abstract voidloadTemplates()protected StringnonNull(String value)protected voidprocessFormLayout(FormInstance topLevelForm, FormInstance form, Map<String,Object> inputs, Map<String,Object> outputs, String layoutTemplate, StringBuilder jsonTemplate, boolean wrapJson, List<String> scriptDataList)Renders the entire form (including any subforms if found as nested forms)protected Stringread(InputStream input)StringrenderCase(String containerId, org.jbpm.casemgmt.api.model.CaseDefinition caseDefinition, FormInstance form)StringrenderProcess(String containerId, org.jbpm.services.api.model.ProcessDefinition processDesc, FormInstance form)StringrenderTask(String containerId, org.kie.api.task.model.Task task, FormInstance form, Map<String,Object> inputs, Map<String,Object> outputs)protected StringrenderTemplate(freemarker.template.Configuration cfg, String templateName, Map<String,Object> parameters)protected StringrenderTemplate(String templateName, Map<String,Object> parameters)protected StringwrapEndFieldType(String type)-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.kie.server.services.jbpm.ui.form.render.FormRenderer
getName
-
-
-
-
Field Detail
-
MAIN_LAYOUT_TEMPLATE
public static final String MAIN_LAYOUT_TEMPLATE
- See Also:
- Constant Field Values
-
HEADER_LAYOUT_TEMPLATE
public static final String HEADER_LAYOUT_TEMPLATE
- See Also:
- Constant Field Values
-
FORM_GROUP_LAYOUT_TEMPLATE
public static final String FORM_GROUP_LAYOUT_TEMPLATE
- See Also:
- Constant Field Values
-
CASE_LAYOUT_TEMPLATE
public static final String CASE_LAYOUT_TEMPLATE
- See Also:
- Constant Field Values
-
PROCESS_LAYOUT_TEMPLATE
public static final String PROCESS_LAYOUT_TEMPLATE
- See Also:
- Constant Field Values
-
TASK_LAYOUT_TEMPLATE
public static final String TASK_LAYOUT_TEMPLATE
- See Also:
- Constant Field Values
-
TABLE_LAYOUT_TEMPLATE
public static final String TABLE_LAYOUT_TEMPLATE
- See Also:
- Constant Field Values
-
-
Method Detail
-
configure
public void configure(String serverPath, String resources)
- Specified by:
configurein interfaceFormRenderer
-
renderCase
public String renderCase(String containerId, org.jbpm.casemgmt.api.model.CaseDefinition caseDefinition, FormInstance form)
- Specified by:
renderCasein interfaceFormRenderer
-
renderProcess
public String renderProcess(String containerId, org.jbpm.services.api.model.ProcessDefinition processDesc, FormInstance form)
- Specified by:
renderProcessin interfaceFormRenderer
-
renderTask
public String renderTask(String containerId, org.kie.api.task.model.Task task, FormInstance form, Map<String,Object> inputs, Map<String,Object> outputs)
- Specified by:
renderTaskin interfaceFormRenderer
-
processFormLayout
protected void processFormLayout(FormInstance topLevelForm, FormInstance form, Map<String,Object> inputs, Map<String,Object> outputs, String layoutTemplate, StringBuilder jsonTemplate, boolean wrapJson, List<String> scriptDataList)
Renders the entire form (including any subforms if found as nested forms)- Parameters:
topLevelForm- - the top level form to be rendered, if needed it should include all nested forms inside or lookup mechanismform- - form being currently processed - could be top level (on first iteration) or nested (on subsequent iterations)inputs- - data inputs or empty listoutputs- - data outputs or empty listlayoutTemplate- - layout template to be applied when processing form contentjsonTemplate- - JSON template on how to retrieve data from rendered form - it's constantly updated by each form being processedwrapJson- - indicates if complex type information should be wrapped with type - usually it's set to true only multi subforms change it to falsescriptDataList- - list of JS functions and code to be placed into the rendered html - at the end of the page
-
handleSubForm
protected void handleSubForm(FormInstance topLevelForm, FormField field, Map<String,Object> inputs, Map<String,Object> outputs, String layoutTemplate, StringBuilder jsonTemplate, boolean wrapJson, List<String> scriptDataList, StringBuilder content)
-
handleMultiSubForm
protected void handleMultiSubForm(FormInstance topLevelForm, FormField field, Map<String,Object> inputs, Map<String,Object> outputs, String layoutTemplate, StringBuilder jsonTemplate, List<String> scriptDataList, StringBuilder content)
-
loadTemplates
protected abstract void loadTemplates()
-
loadTemplate
protected void loadTemplate(String templateId, InputStream stream)
-
loadTemplate
protected void loadTemplate(freemarker.cache.StringTemplateLoader loader, String templateId, InputStream stream)
-
read
protected String read(InputStream input)
-
renderTemplate
protected String renderTemplate(String templateName, Map<String,Object> parameters)
-
renderTemplate
protected String renderTemplate(freemarker.template.Configuration cfg, String templateName, Map<String,Object> parameters)
-
appendFieldJSON
protected void appendFieldJSON(StringBuilder jsonTemplate, String type, String name, String id, String jsType)
-
appendExtractionExpression
protected String appendExtractionExpression(String type, String name, String id, String jsType)
-
appendRoleAssignment
protected void appendRoleAssignment(org.jbpm.casemgmt.api.model.CaseDefinition caseDefinition, StringBuilder jsonTemplate)
-
getServerEndpointPath
protected String getServerEndpointPath()
-
getEndpointSuffix
protected String getEndpointSuffix()
Additional (and optional) suffix to be added to an endpoint (used when starting process or case or interacting with user task)
-
getDocumentPath
protected String getDocumentPath()
-
-