org.kie.server.services.jbpm.ui.form.render

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 and Description
static class	AbstractFormRenderer.DocumentItem

Field Summary

Fields

Modifier and Type	Field and Description
static String	CASE_LAYOUT_TEMPLATE
static String	FORM_GROUP_LAYOUT_TEMPLATE
static String	HEADER_LAYOUT_TEMPLATE
static String	MAIN_LAYOUT_TEMPLATE
static String	PROCESS_LAYOUT_TEMPLATE
static String	TABLE_LAYOUT_TEMPLATE
static String	TASK_LAYOUT_TEMPLATE

Constructor Summary

Constructors

Constructor and Description
AbstractFormRenderer(String serverPath, String resources)

Method Summary

Modifier and Type	Method and Description
protected String	appendExtractionExpression(String type, String name, String id, String jsType)
protected void	appendFieldJSON(StringBuilder jsonTemplate, String type, String name, String id, String jsType)
protected void	appendRoleAssignment(org.jbpm.casemgmt.api.model.CaseDefinition caseDefinition, StringBuilder jsonTemplate)
protected String	buildFunctionWithBody(String name, String body)
protected String	buildScriptData(List<String> scriptDataList)
void	configure(String serverPath, String resources)
protected String	getDocumentPath()
protected String	getEndpointSuffix() Additional (and optional) suffix to be added to an endpoint (used when starting process or case or interacting with user task)
protected String	getExtractionValue(String jsType)
protected String	getFieldType(String type)
protected String	getServerEndpointPath()
protected String	getValidationPatternByType(String type)
protected void	handleMultiSubForm(FormInstance topLevelForm, FormField field, Map<String,Object> inputs, Map<String,Object> outputs, String layoutTemplate, StringBuilder jsonTemplate, List<String> scriptDataList, StringBuilder content)
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)
protected void	loadTemplate(String templateId, InputStream stream)
protected void	loadTemplate(freemarker.cache.StringTemplateLoader loader, String templateId, InputStream stream)
protected abstract void	loadTemplates()
protected String	nonNull(String value)
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)
protected String	read(InputStream input)
String	renderCase(String containerId, org.jbpm.casemgmt.api.model.CaseDefinition caseDefinition, FormInstance form)
String	renderProcess(String containerId, org.jbpm.services.api.model.ProcessDefinition processDesc, FormInstance form)
String	renderTask(String containerId, org.kie.api.task.model.Task task, FormInstance form, Map<String,Object> inputs, Map<String,Object> outputs)
protected String	renderTemplate(freemarker.template.Configuration cfg, String templateName, Map<String,Object> parameters)
protected String	renderTemplate(String templateName, Map<String,Object> parameters)
protected String	wrapEndFieldType(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

Constructor Detail

AbstractFormRenderer

public AbstractFormRenderer(String serverPath,
                            String resources)

Method Detail

configure

public void configure(String serverPath,
                      String resources)

Specified by:

configure in interface FormRenderer

renderCase

public String renderCase(String containerId,
                         org.jbpm.casemgmt.api.model.CaseDefinition caseDefinition,
                         FormInstance form)

Specified by:

renderCase in interface FormRenderer

renderProcess

public String renderProcess(String containerId,
                            org.jbpm.services.api.model.ProcessDefinition processDesc,
                            FormInstance form)

Specified by:

renderProcess in interface FormRenderer

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:

renderTask in interface FormRenderer

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 mechanism

form - - form being currently processed - could be top level (on first iteration) or nested (on subsequent iterations)

inputs - - data inputs or empty list

outputs - - data outputs or empty list

layoutTemplate - - layout template to be applied when processing form content

jsonTemplate - - JSON template on how to retrieve data from rendered form - it's constantly updated by each form being processed

wrapJson - - indicates if complex type information should be wrapped with type - usually it's set to true only multi subforms change it to false

scriptDataList - - 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)

getFieldType

protected String getFieldType(String type)

wrapEndFieldType

protected String wrapEndFieldType(String type)

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)

buildFunctionWithBody

protected String buildFunctionWithBody(String name,
                                       String body)

buildScriptData

protected String buildScriptData(List<String> scriptDataList)

getExtractionValue

protected String getExtractionValue(String jsType)

getValidationPatternByType

protected String getValidationPatternByType(String type)

nonNull

protected String nonNull(String value)

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()