org.camunda.bpm.engine.impl.form.engine
Class HtmlFormEngine

java.lang.Object
  org.camunda.bpm.engine.impl.form.engine.HtmlFormEngine

All Implemented Interfaces:

FormEngine

public class HtmlFormEngine
extends Object
implements FormEngine

A simple FormEngine implementaiton which renders forms as HTML such that they can be used as embedded forms inside camunda Tasklist.

Author:

Daniel Meyer

Field Summary

protected static String	BUTTON_BUTTON_TYPE
protected static String	BUTTON_DEFAULT_CLASS
protected static String	BUTTON_ELEMENT
protected static String	CALENDAR_GLYPHICON
protected static String	CAM_BUSINESS_KEY_ATTRIBUTE
protected static String	CAM_SCRIPT_ATTRIBUTE
protected static String	CAM_VARIABLE_NAME_ATTRIBUTE
protected static String	CAM_VARIABLE_TYPE_ATTRIBUTE
protected static String	CHECKBOX_INPUT_TYPE
protected static String	CLASS_ATTRIBUTE
protected static String	DATE_ERROR_EXPRESSION
protected static String	DATE_ERROR_TYPE
protected static String	DATE_FIELD_OPENED_ATTRIBUTE
protected static String	DATE_FORMAT
protected static String	DATEPICKER_POPUP_ATTRIBUTE
protected static String	DIRTY_EXPRESSION
protected static String	DIV_ELEMENT
protected static String	ERROR_EXPRESSION
protected static String	FOR_ATTRIBUTE
protected static String	FORM_CONTROL_CLASS
protected static String	FORM_ELEMENT
protected static String	FORM_ELEMENT_SELECTOR
protected static String	FORM_GROUP_CLASS
protected static String	FORM_ROLE
protected static String	GENERATED_FORM_NAME
protected static String	HAS_ERROR_CLASS
protected static String	HELP_BLOCK_CLASS
protected static String	I_ELEMENT
protected static String	INPUT_ELEMENT
protected static String	INPUT_GROUP_BTN_CLASS
protected static String	INPUT_GROUP_CLASS
protected static String	INVALID_DATE_FIELD_MESSAGE
protected static String	INVALID_EXPRESSION
protected static String	IS_OPEN_ATTRIBUTE
protected static String	LABEL_ELEMENT
protected static String	NAME_ATTRIBUTE
protected static String	NG_CLICK_ATTRIBUTE
protected static String	NG_IF_ATTRIBUTE
protected static String	NG_SHOW_ATTRIBUTE
protected static String	OPEN_DATEPICKER_FUNCTION_SNIPPET
protected static String	OPEN_DATEPICKER_SNIPPET
protected static String	OPTION_ELEMENT
protected static String	REQUIRED_ERROR_EXPRESSION
protected static String	REQUIRED_ERROR_TYPE
protected static String	REQUIRED_FIELD_MESSAGE
protected static String	ROLE_ATTRIBUTE
protected static String	SCRIPT_ELEMENT
protected static String	SELECT_ELEMENT
protected static String	SELECTED_ATTRIBUTE
protected static String	SPAN_ELEMENT
protected static String	TEXT_FORM_SCRIPT_TYPE
protected static String	TEXT_INPUT_TYPE
protected static String	TYPE_ATTRIBUTE
protected static String	TYPE_ERROR_EXPRESSION
protected static String	TYPE_FIELD_MESSAGE
protected static String	VALUE_ATTRIBUTE

Constructor Summary

HtmlFormEngine()

Method Summary

protected void	addCommonFormFieldAttributes(FormField formField, HtmlElementWriter formControl)
protected HtmlElementWriter	createInputField(FormField formField)
String	getName()
protected boolean	isBoolean(FormField formField)
protected boolean	isDate(FormField formField)
protected boolean	isEnum(FormField formField)
protected boolean	isReadOnly(FormField formField)
protected void	renderDatePicker(FormField formField, HtmlDocumentBuilder documentBuilder)
protected String	renderFormData(FormData formData)
protected void	renderFormField(FormField formField, HtmlDocumentBuilder documentBuilder)
protected void	renderInputField(FormField formField, HtmlDocumentBuilder documentBuilder)
protected void	renderInvalidDateMessage(FormField formField, HtmlDocumentBuilder documentBuilder)
protected void	renderInvalidMessageElement(FormField formField, HtmlDocumentBuilder documentBuilder)
protected void	renderInvalidTypeMessage(FormField formField, HtmlDocumentBuilder documentBuilder)
protected void	renderInvalidValueMessage(FormField formField, HtmlDocumentBuilder documentBuilder)
protected void	renderSelectBox(FormField formField, HtmlDocumentBuilder documentBuilder)
protected void	renderSelectOptions(FormField formField, HtmlDocumentBuilder documentBuilder)
Object	renderStartForm(StartFormData startForm)
Object	renderTaskForm(TaskFormData taskForm)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FORM_ELEMENT

protected static final String FORM_ELEMENT

See Also:

Constant Field Values

DIV_ELEMENT

protected static final String DIV_ELEMENT

See Also:

Constant Field Values

SPAN_ELEMENT

protected static final String SPAN_ELEMENT

See Also:

Constant Field Values

LABEL_ELEMENT

protected static final String LABEL_ELEMENT

See Also:

Constant Field Values

INPUT_ELEMENT

protected static final String INPUT_ELEMENT

See Also:

Constant Field Values

BUTTON_ELEMENT

protected static final String BUTTON_ELEMENT

See Also:

Constant Field Values

SELECT_ELEMENT

protected static final String SELECT_ELEMENT

See Also:

Constant Field Values

OPTION_ELEMENT

protected static final String OPTION_ELEMENT

See Also:

Constant Field Values

I_ELEMENT

protected static final String I_ELEMENT

See Also:

Constant Field Values

SCRIPT_ELEMENT

protected static final String SCRIPT_ELEMENT

See Also:

Constant Field Values

NAME_ATTRIBUTE

protected static final String NAME_ATTRIBUTE

See Also:

Constant Field Values

CLASS_ATTRIBUTE

protected static final String CLASS_ATTRIBUTE

See Also:

Constant Field Values

ROLE_ATTRIBUTE

protected static final String ROLE_ATTRIBUTE

See Also:

Constant Field Values

FOR_ATTRIBUTE

protected static final String FOR_ATTRIBUTE

See Also:

Constant Field Values

VALUE_ATTRIBUTE

protected static final String VALUE_ATTRIBUTE

See Also:

Constant Field Values

TYPE_ATTRIBUTE

protected static final String TYPE_ATTRIBUTE

See Also:

Constant Field Values

SELECTED_ATTRIBUTE

protected static final String SELECTED_ATTRIBUTE

See Also:

Constant Field Values

IS_OPEN_ATTRIBUTE

protected static final String IS_OPEN_ATTRIBUTE

See Also:

Constant Field Values

DATEPICKER_POPUP_ATTRIBUTE

protected static final String DATEPICKER_POPUP_ATTRIBUTE

See Also:

Constant Field Values

CAM_VARIABLE_TYPE_ATTRIBUTE

protected static final String CAM_VARIABLE_TYPE_ATTRIBUTE

See Also:

Constant Field Values

CAM_VARIABLE_NAME_ATTRIBUTE

protected static final String CAM_VARIABLE_NAME_ATTRIBUTE

See Also:

Constant Field Values

CAM_SCRIPT_ATTRIBUTE

protected static final String CAM_SCRIPT_ATTRIBUTE

See Also:

Constant Field Values

CAM_BUSINESS_KEY_ATTRIBUTE

protected static final String CAM_BUSINESS_KEY_ATTRIBUTE

See Also:

Constant Field Values

NG_CLICK_ATTRIBUTE

protected static final String NG_CLICK_ATTRIBUTE

See Also:

Constant Field Values

NG_IF_ATTRIBUTE

protected static final String NG_IF_ATTRIBUTE

See Also:

Constant Field Values

NG_SHOW_ATTRIBUTE

protected static final String NG_SHOW_ATTRIBUTE

See Also:

Constant Field Values

FORM_GROUP_CLASS

protected static final String FORM_GROUP_CLASS

See Also:

Constant Field Values

FORM_CONTROL_CLASS

protected static final String FORM_CONTROL_CLASS

See Also:

Constant Field Values

INPUT_GROUP_CLASS

protected static final String INPUT_GROUP_CLASS

See Also:

Constant Field Values

INPUT_GROUP_BTN_CLASS

protected static final String INPUT_GROUP_BTN_CLASS

See Also:

Constant Field Values

BUTTON_DEFAULT_CLASS

protected static final String BUTTON_DEFAULT_CLASS

See Also:

Constant Field Values

HAS_ERROR_CLASS

protected static final String HAS_ERROR_CLASS

See Also:

Constant Field Values

HELP_BLOCK_CLASS

protected static final String HELP_BLOCK_CLASS

See Also:

Constant Field Values

TEXT_INPUT_TYPE

protected static final String TEXT_INPUT_TYPE

See Also:

Constant Field Values

CHECKBOX_INPUT_TYPE

protected static final String CHECKBOX_INPUT_TYPE

See Also:

Constant Field Values

BUTTON_BUTTON_TYPE

protected static final String BUTTON_BUTTON_TYPE

See Also:

Constant Field Values

TEXT_FORM_SCRIPT_TYPE

protected static final String TEXT_FORM_SCRIPT_TYPE

See Also:

Constant Field Values

CALENDAR_GLYPHICON

protected static final String CALENDAR_GLYPHICON

See Also:

Constant Field Values

GENERATED_FORM_NAME

protected static final String GENERATED_FORM_NAME

See Also:

Constant Field Values

FORM_ROLE

protected static final String FORM_ROLE

See Also:

Constant Field Values

REQUIRED_ERROR_TYPE

protected static final String REQUIRED_ERROR_TYPE

See Also:

Constant Field Values

DATE_ERROR_TYPE

protected static final String DATE_ERROR_TYPE

See Also:

Constant Field Values

FORM_ELEMENT_SELECTOR

protected static final String FORM_ELEMENT_SELECTOR

See Also:

Constant Field Values

INVALID_EXPRESSION

protected static final String INVALID_EXPRESSION

See Also:

Constant Field Values

DIRTY_EXPRESSION

protected static final String DIRTY_EXPRESSION

See Also:

Constant Field Values

ERROR_EXPRESSION

protected static final String ERROR_EXPRESSION

See Also:

Constant Field Values

DATE_ERROR_EXPRESSION

protected static final String DATE_ERROR_EXPRESSION

See Also:

Constant Field Values

REQUIRED_ERROR_EXPRESSION

protected static final String REQUIRED_ERROR_EXPRESSION

See Also:

Constant Field Values

TYPE_ERROR_EXPRESSION

protected static final String TYPE_ERROR_EXPRESSION

See Also:

Constant Field Values

DATE_FIELD_OPENED_ATTRIBUTE

protected static final String DATE_FIELD_OPENED_ATTRIBUTE

See Also:

Constant Field Values

OPEN_DATEPICKER_SNIPPET

protected static final String OPEN_DATEPICKER_SNIPPET

See Also:

Constant Field Values

OPEN_DATEPICKER_FUNCTION_SNIPPET

protected static final String OPEN_DATEPICKER_FUNCTION_SNIPPET

See Also:

Constant Field Values

DATE_FORMAT

protected static final String DATE_FORMAT

See Also:

Constant Field Values

REQUIRED_FIELD_MESSAGE

protected static final String REQUIRED_FIELD_MESSAGE

See Also:

Constant Field Values

TYPE_FIELD_MESSAGE

protected static final String TYPE_FIELD_MESSAGE

See Also:

Constant Field Values

INVALID_DATE_FIELD_MESSAGE

protected static final String INVALID_DATE_FIELD_MESSAGE

See Also:

Constant Field Values

Constructor Detail

HtmlFormEngine

public HtmlFormEngine()

Method Detail

getName

public String getName()

Specified by:

getName in interface FormEngine

renderStartForm

public Object renderStartForm(StartFormData startForm)

Specified by:

renderStartForm in interface FormEngine

renderTaskForm

public Object renderTaskForm(TaskFormData taskForm)

Specified by:

renderTaskForm in interface FormEngine

renderFormData

protected String renderFormData(FormData formData)

renderFormField

protected void renderFormField(FormField formField,
                               HtmlDocumentBuilder documentBuilder)

createInputField

protected HtmlElementWriter createInputField(FormField formField)

renderDatePicker

protected void renderDatePicker(FormField formField,
                                HtmlDocumentBuilder documentBuilder)

renderInputField

protected void renderInputField(FormField formField,
                                HtmlDocumentBuilder documentBuilder)

renderSelectBox

protected void renderSelectBox(FormField formField,
                               HtmlDocumentBuilder documentBuilder)

renderSelectOptions

protected void renderSelectOptions(FormField formField,
                                   HtmlDocumentBuilder documentBuilder)

renderInvalidMessageElement

protected void renderInvalidMessageElement(FormField formField,
                                           HtmlDocumentBuilder documentBuilder)

renderInvalidValueMessage

protected void renderInvalidValueMessage(FormField formField,
                                         HtmlDocumentBuilder documentBuilder)

renderInvalidTypeMessage

protected void renderInvalidTypeMessage(FormField formField,
                                        HtmlDocumentBuilder documentBuilder)

renderInvalidDateMessage

protected void renderInvalidDateMessage(FormField formField,
                                        HtmlDocumentBuilder documentBuilder)

addCommonFormFieldAttributes

protected void addCommonFormFieldAttributes(FormField formField,
                                            HtmlElementWriter formControl)

isEnum

protected boolean isEnum(FormField formField)

isDate

protected boolean isDate(FormField formField)

isBoolean

protected boolean isBoolean(FormField formField)

isReadOnly

protected boolean isReadOnly(FormField formField)