org.jbpm.formModeler.core.fieldTypes

Interface CustomFieldType

public interface CustomFieldType

Definition interface for custom fields

Method Summary

Modifier and Type	Method and Description
String	getDescription(Locale locale) This method returns a text definition for the custom type.
String	getInputHTML(Object value, String fieldName, String namespace, boolean required, boolean readonly, String... params) This method returns a String that contains the HTML code that will show the input view of the field.
String	getShowHTML(Object value, String fieldName, String namespace, boolean required, boolean readonly, String... params) This method returns a string that contains the HTML code that will be used to show the field value.
Object	getValue(Map requestParameters, Map requestFiles, String fieldName, String namespace, Object previousValue, boolean required, boolean readonly, String... params) This method is used to obtain the field value from the submitted form values.

Method Detail

getDescription

String getDescription(Locale locale)

This method returns a text definition for the custom type. This text will be shown on the UI to identify the CustomFieldType

Parameters:

locale - The current user locale

Returns:

A String that describes the field type on the specified locale.

getShowHTML

String getShowHTML(Object value,
                   String fieldName,
                   String namespace,
                   boolean required,
                   boolean readonly,
                   String... params)

This method returns a string that contains the HTML code that will be used to show the field value. shown on screen

Parameters:

value - The current field value

fieldName - The field name

namespace - The unique id for the rendered form, it should be used to generate identifiers inside the html code.

required - Determines if the field is required or not

readonly - Determines if the field must be shown on read only mode

params - A list of configuration params that can be set on the field configuration screen

Returns:

The HTML that will be used to show the field value

getInputHTML

String getInputHTML(Object value,
                    String fieldName,
                    String namespace,
                    boolean required,
                    boolean readonly,
                    String... params)

This method returns a String that contains the HTML code that will show the input view of the field. That will be used to set the field value.

Parameters:

value - The current field value

fieldName - The field name

namespace - The unique id for the rendered form, it should be used to generate identifiers inside the html code.

required - Determines if the field is required or not

readonly - Determines if the field must be shown on read only mode

params - A list of configuration params that can be set on the field configuration screen

Returns:

The HTML code that will be used to show the input view of the field.

getValue

Object getValue(Map requestParameters,
                Map requestFiles,
                String fieldName,
                String namespace,
                Object previousValue,
                boolean required,
                boolean readonly,
                String... params)

This method is used to obtain the field value from the submitted form values.

Parameters:

requestParameters - A Map containing the request parameters for the submitted form

requestFiles - A Map containing the java.io.Files uploaded on the request

fieldName - The field name

namespace - The unique id for the rendered form, it should be used to generate identifiers inside the html code.

previousValue - The previous value of the current field

required - Determines if the field is required or not

readonly - Determines if the field must be shown on read only mode

params - A list of configuration params that can be set on the field configuration screen

Returns:

The value of the field based on the submitted form values.