org.jbpm.formModeler.core.processing.fieldHandlers
Class InputTextFieldHandler

java.lang.Object
  org.jbpm.formModeler.core.processing.AbstractFieldHandler
      org.jbpm.formModeler.core.processing.DefaultFieldHandler
          org.jbpm.formModeler.core.processing.fieldHandlers.InputTextFieldHandler

All Implemented Interfaces:

FieldHandler

Direct Known Subclasses:

FreeText

@Named(value="org.jbpm.formModeler.core.processing.fieldHandlers.InputTextFieldHandler")
public class InputTextFieldHandler
extends DefaultFieldHandler

Handler for input text

Constructor Summary

InputTextFieldHandler()

Method Summary

boolean	acceptsPropertyName(String propName)
String[]	getCompatibleClassNames() Determine the list of class types this field can generate.
String	getPageToIncludeForDisplaying() When rendering a form, if field is handled by this handler, determine the page that renders the displaying of the value
String	getPageToIncludeForRendering() When rendering a form, if field is handled by this handler, determine the page that renders the input(s)
String	getPageToIncludeForSearching()
Map	getParamValue(String inputName, Object objectValue, String pattern) Determine the value as a parameter map for a given input value.
Object	getValue(org.jbpm.formModeler.api.model.Field field, String inputName, Map parametersMap, Map filesMap, String desiredClassName, Object previousValue) Read a parameter value (normally from a request), and translate it to an object with desired class (that must be one of the returned by this handler)
boolean	isEmpty(Object value)
void	setPageToIncludeForDisplaying(String pageToIncludeForDisplaying)
void	setPageToIncludeForRendering(String pageToIncludeForRendering)
void	setPageToIncludeForSearching(String pageToIncludeForSearching)

Methods inherited from class org.jbpm.formModeler.core.processing.DefaultFieldHandler

getFieldHandlersManager, getFormManager, getFormProcessor, getFormStatusManager, getFunctionsProvider, getName, getNamespaceManager, getReplacementManager, shouldPersist

Methods inherited from class org.jbpm.formModeler.core.processing.AbstractFieldHandler

checkBooleanParameter, getFieldName, getHumanName, initialize, isEvaluable

Methods inherited from class java.lang.Object

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

Constructor Detail

InputTextFieldHandler

public InputTextFieldHandler()

Method Detail

getCompatibleClassNames

public String[] getCompatibleClassNames()

Determine the list of class types this field can generate. That is, normally, a field can generate multiple outputs (an input text can generate Strings, Integers, ...)

Returns:

the set of class types that can be generated by this handler.

getValue

public Object getValue(org.jbpm.formModeler.api.model.Field field,
                       String inputName,
                       Map parametersMap,
                       Map filesMap,
                       String desiredClassName,
                       Object previousValue)
                throws Exception

Read a parameter value (normally from a request), and translate it to an object with desired class (that must be one of the returned by this handler)

Returns:

a object with desired class

Throws:

Exception

getParamValue

public Map getParamValue(String inputName,
                         Object objectValue,
                         String pattern)

Determine the value as a parameter map for a given input value. This is like the inverse operation of getValue()

Parameters:

objectValue - Object value to represent

pattern - Pattern to apply if any

Returns:

a Map representing the parameter values expected inside a request that would cause the form to generate given object value as a result.

getPageToIncludeForDisplaying

public String getPageToIncludeForDisplaying()

When rendering a form, if field is handled by this handler, determine the page that renders the displaying of the value

Specified by:

getPageToIncludeForDisplaying in interface FieldHandler

Overrides:

getPageToIncludeForDisplaying in class AbstractFieldHandler

Returns:

a page to include

isEmpty

public boolean isEmpty(Object value)

setPageToIncludeForDisplaying

public void setPageToIncludeForDisplaying(String pageToIncludeForDisplaying)

acceptsPropertyName

public boolean acceptsPropertyName(String propName)

getPageToIncludeForRendering

public String getPageToIncludeForRendering()

When rendering a form, if field is handled by this handler, determine the page that renders the input(s)

Specified by:

getPageToIncludeForRendering in interface FieldHandler

Overrides:

getPageToIncludeForRendering in class AbstractFieldHandler

Returns:

a page to include

setPageToIncludeForRendering

public void setPageToIncludeForRendering(String pageToIncludeForRendering)

getPageToIncludeForSearching

public String getPageToIncludeForSearching()

Specified by:

getPageToIncludeForSearching in interface FieldHandler

Overrides:

getPageToIncludeForSearching in class AbstractFieldHandler

setPageToIncludeForSearching

public void setPageToIncludeForSearching(String pageToIncludeForSearching)