com.cloupia.model.cIM

Class FormFieldDefinition

java.lang.Object

com.cloupia.model.cIM.FormFieldDefinition

public class FormFieldDefinition
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIELD_DEFAULT_TEXT_MAXLENGTH
static int	FIELD_SIZE_LARGE
static int	FIELD_SIZE_LARGE_MEDIUM
static int	FIELD_SIZE_LARGE_SMALL
static int	FIELD_SIZE_MEDIUM
static int	FIELD_SIZE_MEDIUM_LARGE
static int	FIELD_SIZE_MEDIUM_SMALL
static int	FIELD_SIZE_SMALL
static int	FIELD_SIZE_SMALL_LARGE
static int	FIELD_SIZE_SMALL_MEDIUM
static int	FIELD_TYPE_BOOLEAN
static int	FIELD_TYPE_BUTTON_PANEL
static int	FIELD_TYPE_BUTTON_PANEL_EXTERN
static int	FIELD_TYPE_COLORPICKER
static int	FIELD_TYPE_DATE Date selector.
static int	FIELD_TYPE_DATE_TIME Date and Time of the day selector.
static int	FIELD_TYPE_EMBEDDED_LOV for embedded LOV, source of the values is embedded into the field definition itself
static int	FIELD_TYPE_EMBEDDED_LOV_COMBO
static int	FIELD_TYPE_EMBEDDED_LOV_RADIO for embedded LOV, source of the values is embedded into the field definition itself: displayed as radio button(s)
static int	FIELD_TYPE_FILE_UPLOAD
static int	FIELD_TYPE_HTML_LABEL
static int	FIELD_TYPE_HTML_TEXT HTML text for large HTML only display windows.
static int	FIELD_TYPE_IMAGE_SELECT_LIST
static int	FIELD_TYPE_IPADDRESS
static int	FIELD_TYPE_LABEL
static int	FIELD_TYPE_LABEL_WITH_SPACE
static int	FIELD_TYPE_LARGE_FILE_UPLOAD
static int	FIELD_TYPE_LOV List of values and source of the list is back-end
static int	FIELD_TYPE_MULTI_SELECT_LIST
static int	FIELD_TYPE_NUMBER
static int	FIELD_TYPE_PASSWORD
static int	FIELD_TYPE_RULESET
static int	FIELD_TYPE_TABULAR
static int	FIELD_TYPE_TABULAR_NO_CHECKBOX
static int	FIELD_TYPE_TABULAR_POPUP
static int	FIELD_TYPE_TABULAR_POPUP_PAGINATION
static int	FIELD_TYPE_TEXT
static int	FIELD_TYPE_TEXT_LINE_NUMS
static int	FIELD_TYPE_TIME Time of the day selector.
static int	FIELD_TYPE_TREE
static int	FIELD_TYPE_TREE_ALT
static int	FIELD_TYPE_TREE_LIST
static int	FIELD_TYPE_WORKFLOW_PROGRESS
static java.lang.String	HELP_TEXT
static java.lang.String	HIDE_INLINE_DOC Used together with FIELD_TYPE_TEXT_LINE_NUMS! If onlineHelpTag of form field == HIDE_INLINE_DOC, then show/hide button in form field is disabled, by default it is always enabled.
static java.lang.String	LABEL

Constructor Summary

Constructors

Constructor and Description
FormFieldDefinition()
FormFieldDefinition(FormFieldDefinition orig) Copy constructor

Method Summary

Modifier and Type	Method and Description
static FormFieldDefinition	fromAnnotation(java.lang.String id, FormField ff)
java.lang.String	getAnnotation()
FormFieldCascadePopup	getCascadeFormPopup()
FormLOVPair[]	getEmbeddedLOVs()
java.lang.String	getFieldId()
int	getFieldSize()
int	getFieldType()
java.lang.String	getGroupLabel()
java.lang.String	getHelpText()
FormFieldHtmlPopup	getHtmlPopup()
java.lang.String	getLabel()
int	getMaxTextLength()
int	getMinTextLength()
java.lang.String	getOnlineHelpTag()
FormLOVPair[]	getRuleCoditions()
FormLOVPair[]	getRuleConditions()
FormLOVPair[]	getRuleNames()
java.lang.String	getSourceReportDisplayColumnId()
java.lang.String	getSourceReportName()
java.lang.String	getSourceReportSelectedColumnId()
FormTableActionBindings	getTableActions()
boolean	isEditable()
boolean	isHidden()
boolean	isLOVTranslatable()
boolean	isMandatory()
boolean	isMultiLine()
boolean	isRequireValidation()
void	setAnnotation(java.lang.String annotation)
void	setCascadeFormPopup(FormFieldCascadePopup cascadeFormPopup)
void	setEditable(boolean isEditable)
void	setEmbeddedLOVs(FormLOVPair[] embeddedLOVs)
void	setFieldId(java.lang.String fieldId)
void	setFieldSize(int fieldSize)
void	setFieldType(int fieldType)
void	setGroupLabel(java.lang.String groupLabel)
void	setHelpText(java.lang.String helpText)
void	setHidden(boolean isHidden)
void	setHtmlPopup(FormFieldHtmlPopup htmlPopup)
void	setLabel(java.lang.String label)
void	setLOVTranslatable(boolean isLOVTranslatable)
void	setMandatory(boolean isMandatory)
void	setMaxTextLength(int maxTextLength)
void	setMinTextLength(int minTextLength)
void	setMultiLine(boolean isMultiLine)
void	setOnlineHelpTag(java.lang.String onlineHelpTag)
void	setRequireValidation(boolean requireValidation)
void	setRuleCoditions(FormLOVPair[] ruleCoditions)
void	setRuleConditions(FormLOVPair[] ruleConditions)
void	setRuleNames(FormLOVPair[] ruleNames)
void	setSourceReportDisplayColumnId(java.lang.String sourceReportDisplayColumnId)
void	setSourceReportName(java.lang.String sourceReportName)
void	setSourceReportSelectedColumnId(java.lang.String sourceReportSelectedColumnId)
void	setTableActions(FormTableActionBindings tableActions)
FormFieldDefinition	withAnnotation(java.lang.String annotation)
FormFieldDefinition	withCascadeFormPopup(FormFieldCascadePopup cascadeFormPopup)
FormFieldDefinition	withEditable(boolean isEditable)
FormFieldDefinition	withEmbeddedLOVs(FormLOVPair[] embeddedLOVs)
FormFieldDefinition	withFieldId(java.lang.String fieldId)
FormFieldDefinition	withFieldSize(int fieldSize)
FormFieldDefinition	withFieldType(int fieldType)
FormFieldDefinition	withGroupLabel(java.lang.String groupLabel)
FormFieldDefinition	withHelpText(java.lang.String helpText)
FormFieldDefinition	withHidden(boolean isHidden)
FormFieldDefinition	withHtmlPopup(FormFieldHtmlPopup htmlPopup)
FormFieldDefinition	withLabel(java.lang.String label)
FormFieldDefinition	withLOVTranslatable(boolean isLOVTranslatable)
FormFieldDefinition	withMandatory(boolean isMandatory)
FormFieldDefinition	withMaxTextLength(int maxTextLength)
FormFieldDefinition	withMinTextLength(int minTextLength)
FormFieldDefinition	withMultiLineText(boolean isMultiLineInput)
FormFieldDefinition	withOnlineHelpTag(java.lang.String onlineHelpTag)
FormFieldDefinition	withRequireValidation(boolean requireValidation)
FormFieldDefinition	withRuleCoditions(FormLOVPair[] ruleCoditions)
FormFieldDefinition	withRuleNames(FormLOVPair[] ruleNames)
FormFieldDefinition	withSourceReportDisplayColumnId(java.lang.String sourceReportDisplayColumnId)
FormFieldDefinition	withSourceReportName(java.lang.String sourceReportName)
FormFieldDefinition	withSourceReportSelectedColumnId(java.lang.String sourceReportSelectedColumnId)
FormFieldDefinition	withTableActions(FormTableActionBindings tableActions)

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_TYPE_TEXT

public static final int FIELD_TYPE_TEXT

See Also:

Constant Field Values

FIELD_TYPE_NUMBER

public static final int FIELD_TYPE_NUMBER

See Also:

Constant Field Values

FIELD_TYPE_LOV

public static final int FIELD_TYPE_LOV

List of values and source of the list is back-end

See Also:

Constant Field Values

FIELD_TYPE_TABULAR

public static final int FIELD_TYPE_TABULAR

See Also:

Constant Field Values

FIELD_TYPE_BOOLEAN

public static final int FIELD_TYPE_BOOLEAN

See Also:

Constant Field Values

FIELD_TYPE_LABEL

public static final int FIELD_TYPE_LABEL

See Also:

Constant Field Values

FIELD_TYPE_EMBEDDED_LOV

public static final int FIELD_TYPE_EMBEDDED_LOV

for embedded LOV, source of the values is embedded into the field definition itself

See Also:

Constant Field Values

FIELD_TYPE_PASSWORD

public static final int FIELD_TYPE_PASSWORD

See Also:

Constant Field Values

FIELD_TYPE_RULESET

public static final int FIELD_TYPE_RULESET

See Also:

Constant Field Values

FIELD_TYPE_EMBEDDED_LOV_RADIO

public static final int FIELD_TYPE_EMBEDDED_LOV_RADIO

for embedded LOV, source of the values is embedded into the field definition itself: displayed as radio button(s)

See Also:

Constant Field Values

FIELD_TYPE_DATE

public static final int FIELD_TYPE_DATE

Date selector. Value is represented in long (millis, hours:mins:secs = 0:0:0)

See Also:

Constant Field Values

FIELD_TYPE_TIME

public static final int FIELD_TYPE_TIME

Time of the day selector. Value is represented in long (millis, year:month:day = today)

See Also:

Constant Field Values

FIELD_TYPE_DATE_TIME

public static final int FIELD_TYPE_DATE_TIME

Date and Time of the day selector. Value is represented in long (millis)

See Also:

Constant Field Values

FIELD_TYPE_HTML_TEXT

public static final int FIELD_TYPE_HTML_TEXT

HTML text for large HTML only display windows.

See Also:

Constant Field Values

FIELD_TYPE_MULTI_SELECT_LIST

public static final int FIELD_TYPE_MULTI_SELECT_LIST

See Also:

Constant Field Values

FIELD_TYPE_LABEL_WITH_SPACE

public static final int FIELD_TYPE_LABEL_WITH_SPACE

See Also:

Constant Field Values

FIELD_TYPE_IMAGE_SELECT_LIST

public static final int FIELD_TYPE_IMAGE_SELECT_LIST

See Also:

Constant Field Values

FIELD_TYPE_HTML_LABEL

public static final int FIELD_TYPE_HTML_LABEL

See Also:

Constant Field Values

FIELD_TYPE_FILE_UPLOAD

public static final int FIELD_TYPE_FILE_UPLOAD

See Also:

Constant Field Values

FIELD_TYPE_BUTTON_PANEL

public static final int FIELD_TYPE_BUTTON_PANEL

See Also:

Constant Field Values

FIELD_TYPE_TABULAR_POPUP

public static final int FIELD_TYPE_TABULAR_POPUP

See Also:

Constant Field Values

FIELD_TYPE_TREE

public static final int FIELD_TYPE_TREE

See Also:

Constant Field Values

FIELD_TYPE_TREE_ALT

public static final int FIELD_TYPE_TREE_ALT

See Also:

Constant Field Values

FIELD_TYPE_TABULAR_NO_CHECKBOX

public static final int FIELD_TYPE_TABULAR_NO_CHECKBOX

See Also:

Constant Field Values

FIELD_TYPE_EMBEDDED_LOV_COMBO

public static final int FIELD_TYPE_EMBEDDED_LOV_COMBO

See Also:

Constant Field Values

FIELD_TYPE_TREE_LIST

public static final int FIELD_TYPE_TREE_LIST

See Also:

Constant Field Values

FIELD_TYPE_TEXT_LINE_NUMS

public static final int FIELD_TYPE_TEXT_LINE_NUMS

See Also:

Constant Field Values

FIELD_TYPE_BUTTON_PANEL_EXTERN

public static final int FIELD_TYPE_BUTTON_PANEL_EXTERN

See Also:

Constant Field Values

FIELD_TYPE_LARGE_FILE_UPLOAD

public static final int FIELD_TYPE_LARGE_FILE_UPLOAD

See Also:

Constant Field Values

FIELD_TYPE_WORKFLOW_PROGRESS

public static final int FIELD_TYPE_WORKFLOW_PROGRESS

See Also:

Constant Field Values

FIELD_TYPE_COLORPICKER

public static final int FIELD_TYPE_COLORPICKER

See Also:

Constant Field Values

FIELD_TYPE_IPADDRESS

public static final int FIELD_TYPE_IPADDRESS

See Also:

Constant Field Values

FIELD_TYPE_TABULAR_POPUP_PAGINATION

public static final int FIELD_TYPE_TABULAR_POPUP_PAGINATION

See Also:

Constant Field Values

FIELD_SIZE_SMALL

public static final int FIELD_SIZE_SMALL

See Also:

Constant Field Values

FIELD_SIZE_MEDIUM

public static final int FIELD_SIZE_MEDIUM

See Also:

Constant Field Values

FIELD_SIZE_LARGE

public static final int FIELD_SIZE_LARGE

See Also:

Constant Field Values

FIELD_SIZE_MEDIUM_SMALL

public static final int FIELD_SIZE_MEDIUM_SMALL

See Also:

Constant Field Values

FIELD_SIZE_LARGE_SMALL

public static final int FIELD_SIZE_LARGE_SMALL

See Also:

Constant Field Values

FIELD_SIZE_SMALL_MEDIUM

public static final int FIELD_SIZE_SMALL_MEDIUM

See Also:

Constant Field Values

FIELD_SIZE_LARGE_MEDIUM

public static final int FIELD_SIZE_LARGE_MEDIUM

See Also:

Constant Field Values

FIELD_SIZE_SMALL_LARGE

public static final int FIELD_SIZE_SMALL_LARGE

See Also:

Constant Field Values

FIELD_SIZE_MEDIUM_LARGE

public static final int FIELD_SIZE_MEDIUM_LARGE

See Also:

Constant Field Values

FIELD_DEFAULT_TEXT_MAXLENGTH

public static final int FIELD_DEFAULT_TEXT_MAXLENGTH

See Also:

Constant Field Values

HIDE_INLINE_DOC

public static final java.lang.String HIDE_INLINE_DOC

Used together with FIELD_TYPE_TEXT_LINE_NUMS! If onlineHelpTag of form field == HIDE_INLINE_DOC, then show/hide button in form field is disabled, by default it is always enabled.

See Also:

Constant Field Values

LABEL

public static final java.lang.String LABEL

See Also:

Constant Field Values

HELP_TEXT

public static final java.lang.String HELP_TEXT

See Also:

Constant Field Values

Constructor Detail

FormFieldDefinition

public FormFieldDefinition()

FormFieldDefinition

public FormFieldDefinition(FormFieldDefinition orig)

Copy constructor

Method Detail

fromAnnotation

public static FormFieldDefinition fromAnnotation(java.lang.String id,
                                                 FormField ff)

getFieldId

public java.lang.String getFieldId()

Returns:

the fieldId

getLabel

public java.lang.String getLabel()

Returns:

the label

getHelpText

public java.lang.String getHelpText()

Returns:

the helpText

getFieldType

public int getFieldType()

Returns:

the fieldType

isHidden

public boolean isHidden()

Returns:

the isHidden

isEditable

public boolean isEditable()

Returns:

the isEditable

isMandatory

public boolean isMandatory()

Returns:

the isMandatory

isRequireValidation

public boolean isRequireValidation()

Returns:

the requireValidation

getSourceReportName

public java.lang.String getSourceReportName()

Returns:

the sourceReportName

getSourceReportSelectedColumnId

public java.lang.String getSourceReportSelectedColumnId()

Returns:

the sourceReportSelectedColumnId

getSourceReportDisplayColumnId

public java.lang.String getSourceReportDisplayColumnId()

Returns:

the sourceReportDisplayColumnId

setFieldId

public void setFieldId(java.lang.String fieldId)

Parameters:

fieldId - the fieldId to set

setLabel

public void setLabel(java.lang.String label)

Parameters:

label - the label to set

setHelpText

public void setHelpText(java.lang.String helpText)

Parameters:

helpText - the helpText to set

setFieldType

public void setFieldType(int fieldType)

Parameters:

fieldType - the fieldType to set

setHidden

public void setHidden(boolean isHidden)

Parameters:

isHidden - the isHidden to set

setEditable

public void setEditable(boolean isEditable)

Parameters:

isEditable - the isEditable to set

setMandatory

public void setMandatory(boolean isMandatory)

Parameters:

isMandatory - the isMandatory to set

setRequireValidation

public void setRequireValidation(boolean requireValidation)

Parameters:

requireValidation - the requireValidation to set

setSourceReportName

public void setSourceReportName(java.lang.String sourceReportName)

Parameters:

sourceReportName - the sourceReportName to set

setSourceReportSelectedColumnId

public void setSourceReportSelectedColumnId(java.lang.String sourceReportSelectedColumnId)

Parameters:

sourceReportSelectedColumnId - the sourceReportSelectedColumnId to set

setSourceReportDisplayColumnId

public void setSourceReportDisplayColumnId(java.lang.String sourceReportDisplayColumnId)

Parameters:

sourceReportDisplayColumnId - the sourceReportDisplayColumnId to set

withFieldId

public FormFieldDefinition withFieldId(java.lang.String fieldId)

Parameters:

fieldId - the fieldId to set

withLabel

public FormFieldDefinition withLabel(java.lang.String label)

Parameters:

label - the label to set

withHelpText

public FormFieldDefinition withHelpText(java.lang.String helpText)

Parameters:

helpText - the helpText to set

withAnnotation

public FormFieldDefinition withAnnotation(java.lang.String annotation)

Parameters:

annotation -

Returns:

withFieldType

public FormFieldDefinition withFieldType(int fieldType)

Parameters:

fieldType - the fieldType to set

withHidden

public FormFieldDefinition withHidden(boolean isHidden)

Parameters:

isHidden - the isHidden to set

withEditable

public FormFieldDefinition withEditable(boolean isEditable)

Parameters:

isEditable - the isEditable to set

withMandatory

public FormFieldDefinition withMandatory(boolean isMandatory)

Parameters:

isMandatory - the isMandatory to set

withRequireValidation

public FormFieldDefinition withRequireValidation(boolean requireValidation)

Parameters:

requireValidation - the requireValidation to set

withSourceReportName

public FormFieldDefinition withSourceReportName(java.lang.String sourceReportName)

Parameters:

sourceReportName - the sourceReportName to set

withFieldSize

public FormFieldDefinition withFieldSize(int fieldSize)

Parameters:

fieldSize - the fieldSize to set

withSourceReportSelectedColumnId

public FormFieldDefinition withSourceReportSelectedColumnId(java.lang.String sourceReportSelectedColumnId)

Parameters:

sourceReportSelectedColumnId - the sourceReportSelectedColumnId to set

withSourceReportDisplayColumnId

public FormFieldDefinition withSourceReportDisplayColumnId(java.lang.String sourceReportDisplayColumnId)

Parameters:

sourceReportDisplayColumnId - the sourceReportDisplayColumnId to set

getEmbeddedLOVs

public FormLOVPair[] getEmbeddedLOVs()

Returns:

the embeddedLOVs

setEmbeddedLOVs

public void setEmbeddedLOVs(FormLOVPair[] embeddedLOVs)

Parameters:

embeddedLOVs - the embeddedLOVs to set

withEmbeddedLOVs

public FormFieldDefinition withEmbeddedLOVs(FormLOVPair[] embeddedLOVs)

getFieldSize

public int getFieldSize()

Returns:

the fieldSize

setFieldSize

public void setFieldSize(int fieldSize)

Parameters:

fieldSize - the fieldSize to set

getRuleNames

public FormLOVPair[] getRuleNames()

Returns:

the ruleNames

setRuleNames

public void setRuleNames(FormLOVPair[] ruleNames)

Parameters:

ruleNames - the ruleNames to set

withRuleNames

public FormFieldDefinition withRuleNames(FormLOVPair[] ruleNames)

withMultiLineText

public FormFieldDefinition withMultiLineText(boolean isMultiLineInput)

withMaxTextLength

public FormFieldDefinition withMaxTextLength(int maxTextLength)

withMinTextLength

public FormFieldDefinition withMinTextLength(int minTextLength)

getRuleCoditions

public FormLOVPair[] getRuleCoditions()

Returns:

the ruleCoditions

setRuleCoditions

public void setRuleCoditions(FormLOVPair[] ruleCoditions)

Parameters:

ruleCoditions - the ruleCoditions to set

withRuleCoditions

public FormFieldDefinition withRuleCoditions(FormLOVPair[] ruleCoditions)

Parameters:

ruleCoditions - the ruleCoditions to set

getGroupLabel

public java.lang.String getGroupLabel()

Returns:

the groupLabel

getRuleConditions

public FormLOVPair[] getRuleConditions()

Returns:

the ruleConditions

setGroupLabel

public void setGroupLabel(java.lang.String groupLabel)

Parameters:

groupLabel - the groupLabel to set

withGroupLabel

public FormFieldDefinition withGroupLabel(java.lang.String groupLabel)

Parameters:

groupLabel - the groupLabel to set

setRuleConditions

public void setRuleConditions(FormLOVPair[] ruleConditions)

Parameters:

ruleConditions - the ruleConditions to set

isMultiLine

public boolean isMultiLine()

Returns:

the isMultiLine

getMaxTextLength

public int getMaxTextLength()

Returns:

the maxTextLength

getMinTextLength

public int getMinTextLength()

Returns:

the minTextLength

setMultiLine

public void setMultiLine(boolean isMultiLine)

Parameters:

isMultiLine - the isMultiLine to set

setMaxTextLength

public void setMaxTextLength(int maxTextLength)

Parameters:

maxTextLength - the maxTextLength to set

setMinTextLength

public void setMinTextLength(int minTextLength)

Parameters:

minTextLength - the minTextLength to set

getAnnotation

public java.lang.String getAnnotation()

Returns:

the annotation

setAnnotation

public void setAnnotation(java.lang.String annotation)

Parameters:

annotation - the annotation to set

getTableActions

public FormTableActionBindings getTableActions()

setTableActions

public void setTableActions(FormTableActionBindings tableActions)

withTableActions

public FormFieldDefinition withTableActions(FormTableActionBindings tableActions)

getHtmlPopup

public FormFieldHtmlPopup getHtmlPopup()

setHtmlPopup

public void setHtmlPopup(FormFieldHtmlPopup htmlPopup)

withHtmlPopup

public FormFieldDefinition withHtmlPopup(FormFieldHtmlPopup htmlPopup)

getCascadeFormPopup

public FormFieldCascadePopup getCascadeFormPopup()

setCascadeFormPopup

public void setCascadeFormPopup(FormFieldCascadePopup cascadeFormPopup)

withCascadeFormPopup

public FormFieldDefinition withCascadeFormPopup(FormFieldCascadePopup cascadeFormPopup)

getOnlineHelpTag

public java.lang.String getOnlineHelpTag()

setOnlineHelpTag

public void setOnlineHelpTag(java.lang.String onlineHelpTag)

withOnlineHelpTag

public FormFieldDefinition withOnlineHelpTag(java.lang.String onlineHelpTag)

isLOVTranslatable

public boolean isLOVTranslatable()

Returns:

the isLOVTranslatable

setLOVTranslatable

public void setLOVTranslatable(boolean isLOVTranslatable)

Parameters:

isLOVTranslatable - the isLOVTranslatable to set

withLOVTranslatable

public FormFieldDefinition withLOVTranslatable(boolean isLOVTranslatable)