com.technia.tvc.structurebrowser.form.model

Class Field

java.lang.Object

com.technia.tvc.structurebrowser.form.model.FormComponent

com.technia.tvc.structurebrowser.form.model.Field

public abstract class Field
extends FormComponent

Super class for a form field with presentation layer

Field Summary

Fields

Modifier and Type	Field and Description
protected int	chooserHeight
protected java.lang.String	chooserURL
protected int	chooserWidth
static int	COLUMNS_DEFAULT
protected boolean	editable
protected FieldRenderer	fieldRenderer
protected java.lang.String	helpHref
static java.lang.String	HIDDEN
protected com.technia.tvc.structurebrowser.form.rangeloader.RangeLoader	rangeLoader
static java.lang.String	REQUEST_PARAM_DELIMITER
static int	ROWS_DEFAULT
protected java.lang.String	searchForm
protected java.util.List<java.lang.String>	visibleIf

Fields inherited from class com.technia.tvc.structurebrowser.form.model.FormComponent

ADDED, INPUT_ID_PREFIX, label, name, order, parent, postProcessEnabled, status, templateEnabled, TOBEREMOVED, UNCHANGED, UPDATED, validationErrors, validationStatus

Constructor Summary

Constructors

Constructor and Description
Field(com.technia.tvc.structurebrowser.form.def.FormComponentDef def) Default constructor

Method Summary

Modifier and Type	Method and Description
void	addButton(com.technia.tvc.structurebrowser.form.render.Button button)
void	appendSelectStatementToList(java.util.List<java.lang.String> list) If the form is being used in edit mode, this method is responsible for adding the required select statement(s) in order for the field to be populated.
void	evaluateEditableExpression(Form form)
void	evaluateLabelStyleExpression(Form form)
void	forceVisible(Form fc) Make a field visible forcefully
java.lang.String	getAutoCompleteHandler()
java.lang.String	getAutoCompleteSettings()
java.util.List<com.technia.tvc.structurebrowser.form.render.Button>	getButtons()
int	getChooserHeight()
java.lang.String	getChooserURL()
int	getChooserWidth()
java.lang.String	getDefaultValue()
java.lang.String	getDefaultValueHandler()
java.lang.String	getDisplayValue()
java.lang.String	getEditableExpression()
java.lang.String	getLabelStyle()
boolean	getLabelStyleExpressionEvaluated()
java.lang.String[]	getPostProcesses()
java.lang.String	getRangeDisplay()
java.util.List<RangeValue>	getRanges()
java.lang.String	getRangeSaveValue()
java.lang.String	getRangeSeparator()
com.technia.tvc.structurebrowser.form.render.field.FormComponentRenderer	getRenderer() Returns a new, or retrieved from cache, instance of a renderer
java.lang.String	getSearchForm()
java.lang.Boolean	getSetting(java.lang.String setting, boolean defaultValue)
java.lang.String	getSetting(java.lang.String setting, java.lang.String defaultValue)
java.util.HashMap<java.lang.String,java.lang.String>	getSettings()
java.lang.String	getSize()
java.lang.String	getSubFieldId(java.lang.String key)
java.lang.String	getTooltipContent()
java.lang.String	getTooltipLabel()
com.technia.tvc.structurebrowser.form.model.Validation	getValidation()
java.lang.String	getValue() Gets the field value
java.util.List<java.lang.String>	getVisibleIf()
java.lang.String	getVisibleIfId()
boolean	hasButtons()
boolean	hasRange()
boolean	hasRangeLoader()
void	init()
protected java.util.List<RangeValue>	invokeRangeLoader(Form fc) If an range loader class is present for the field, this class invokes the class and changes the ranges values.
boolean	isAutoComplete()
boolean	isChangeEventEnabled()
boolean	isDynamicField()
boolean	isEditable()
boolean	isEditableText() Deprecated. Since 2012.3.0, use isEditable() instead...
boolean	isFromInterface()
boolean	isLocked()
boolean	isRequired()
boolean	isRichText()
boolean	isSortRangeValues()
boolean	isTemplatable()
boolean	isUsesBusinessObject()
boolean	isVisibleIfValueField()
void	load(Form configuration) Initializes, or Restores, the field value(s) for this field
void	loadExistingValue(Form configuration, matrix.db.BusinessObjectWithSelect bows) This method puts business object select data into the fields value
void	loadExistingValue(Form configuration, matrix.db.RelationshipWithSelect rws) This method puts relationship select data into the fields value
void	populateValuesFromRequest(Form fc, javax.servlet.http.HttpServletRequest request) Populates the field itself from the corresponding request parameter
com.technia.tvc.structurebrowser.form.process.ProcessResultsLog	postProcess(Form fc, java.util.List<java.lang.String> oids) Override this method to add post process logic
void	read(XMLPointer pointer, Form form) Restores the state of this field from an XML structure.
java.lang.String	resolveDisplayExpressionFromObjectIds(java.lang.String displayExpression, java.util.Collection<java.lang.String> ids)
java.lang.String	resolveDisplayExpressionFromObjectIds(java.lang.String displayExpression, java.lang.String value)
protected java.lang.String	resolveDisplayValueFromObjectId(java.lang.String objectId)
java.lang.String	resolveDisplayValuesFromObjectIds(java.lang.String value)
static java.lang.String	resolveObjectNamesFromObjectIds(java.util.Collection<java.lang.String> ids)
java.lang.String	resolveObjectNamesFromObjectIds(java.lang.String value)
void	save(XMLWriter writer) Saves the state of this field into XML.
void	setAutoComplete(boolean autoComplete)
void	setAutoCompleteHandler(java.lang.String handler)
void	setAutoCompleteSettings(java.lang.String settings)
void	setChangeEventEnabled(boolean changeEventEnabled)
void	setChooserHeight(int chooserHeight)
void	setChooserURL(java.lang.String chooserURL)
void	setChooserWidth(int chooserWidth)
void	setDefaultValue(java.lang.String defaultValue)
void	setDefaultValueHandler(java.lang.String defaultValueHandler)
void	setDisplayValue(java.lang.String displayValue)
void	setDynamicField(boolean isDynamicField)
void	setEditable(boolean editable)
void	setEditableExpression(java.lang.String editableExpression)
void	setEditableText(boolean editableText) Deprecated. since 2012.3.0 Use setEditable() instead...
void	setFromInterface(boolean fromInterface)
void	setHelpHref(java.lang.String helpHref) Sets an URL value for where this field's user guide is located
void	setLabelStyle(java.lang.String labelStyle)
void	setLabelStyleExpression(java.lang.String labelStyleExpression)
void	setLocked(boolean locked)
void	setPostProcesses(java.lang.String[] postProcesses)
void	setRangeDisplay(java.lang.String rangeDisplay)
void	setRangeLoader(com.technia.tvc.structurebrowser.form.rangeloader.RangeLoader rangeLoader) Sets a class to used for loading a custom set of range values to a field.
void	setRanges(java.util.List<RangeValue> ranges)
void	setRangeSaveValue(java.lang.String rangeSaveValue)
void	setRangeSeparator(java.lang.String rangeSeparator)
void	setRequired(boolean required) Sets whether the field should be mandatory or not.
void	setRichText(boolean richText)
void	setSearchForm(java.lang.String searchForm)
void	setSettings(java.util.HashMap<java.lang.String,java.lang.String> settings)
void	setSize(java.lang.String size)
void	setSortRangeValues(boolean sortRangeValues)
void	setTemplatable(boolean templatable)
void	setTooltipContent(java.lang.String tooltipContent)
void	setTooltipLabel(java.lang.String tooltipLabel)
void	setUsesBusinessObject(boolean usesBusinessObject)
void	setValidation(com.technia.tvc.structurebrowser.form.model.Validation validation)
void	setValue(java.lang.String value) Sets the field value
void	setValue(java.lang.String displayValue, java.lang.String value)
void	setVisibleIfId(java.lang.String visibleIfId)
protected void	toggleVisibleIfFields(java.lang.String value, Form form)
java.lang.String	toString()
void	update(Form fc, java.lang.String value, boolean updateForm) Implement this method to implement update logic
void	updateEventAction(Form fc, java.lang.String key, java.lang.String value)
void	updateFieldValue(Form configuration, java.lang.String value, boolean skipValidation, boolean updateConfiguration) Updates the field value for this field
void	updateFieldValue(Form configuration, java.lang.String value, boolean skipValidation, boolean updateConfiguration, boolean updateStatus) Updates the field value for this field
java.lang.String	validate(Form fc, java.lang.String value) Implement this method to give the field custom validation logic
boolean	validateConfigurationInput(Form configuration) Validate parameters read from configuration xml.

Methods inherited from class com.technia.tvc.structurebrowser.form.model.FormComponent

addValidationError, addValidationError, addValidationError, addValidationWarning, addValidationWarning, addValidationWarning, clearValidationErrors, compareTo, evaluateRequiredExpression, evaluateVisibleExpression, getComponentDef, getFieldPostProcess, getId, getLabel, getMobileRendererClassName, getName, getOrder, getParent, getRendererClassName, getRequiredExpressionEvaluated, getStatus, getValidationActionErrors, getValidationErrors, getValidationStatus, getVisibilityExpressionEvaluated, isPostProcessEnabled, isTemplateEnabled, isVisible, setFieldPostProcess, setId, setLabel, setName, setOrder, setOrder, setParent, setPostProcessEnabled, setRendererClassName, setRequiredExpression, setStatus, setTemplateEnabled, setVisible, setVisibleExpression

Methods inherited from class java.lang.Object

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

Field Detail

COLUMNS_DEFAULT

public static final int COLUMNS_DEFAULT

See Also:

Constant Field Values

HIDDEN

public static final java.lang.String HIDDEN

See Also:

Constant Field Values

REQUEST_PARAM_DELIMITER

public static final java.lang.String REQUEST_PARAM_DELIMITER

See Also:

Constant Field Values

ROWS_DEFAULT

public static final int ROWS_DEFAULT

See Also:

Constant Field Values

chooserHeight

protected int chooserHeight

chooserURL

protected java.lang.String chooserURL

chooserWidth

protected int chooserWidth

editable

protected boolean editable

fieldRenderer

protected FieldRenderer fieldRenderer

helpHref

protected java.lang.String helpHref

rangeLoader

protected com.technia.tvc.structurebrowser.form.rangeloader.RangeLoader rangeLoader

searchForm

protected java.lang.String searchForm

visibleIf

protected java.util.List<java.lang.String> visibleIf

Constructor Detail

Field

public Field(com.technia.tvc.structurebrowser.form.def.FormComponentDef def)
      throws com.technia.tvc.structurebrowser.form.exception.FormException

Default constructor

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

Method Detail

addButton

public void addButton(com.technia.tvc.structurebrowser.form.render.Button button)

appendSelectStatementToList

public void appendSelectStatementToList(java.util.List<java.lang.String> list)
                                 throws com.technia.tvc.structurebrowser.form.exception.FormException

If the form is being used in edit mode, this method is responsible for adding the required select statement(s) in order for the field to be populated.

Parameters:

list - The list to add the statement(s) to

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

Since:

2010.1.0

evaluateEditableExpression

public void evaluateEditableExpression(Form form)
                                throws com.technia.tvc.structurebrowser.form.exception.FormException

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

evaluateLabelStyleExpression

public void evaluateLabelStyleExpression(Form form)
                                  throws com.technia.tvc.structurebrowser.form.exception.FormException

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

getAutoCompleteHandler

public java.lang.String getAutoCompleteHandler()

getAutoCompleteSettings

public java.lang.String getAutoCompleteSettings()

getButtons

public java.util.List<com.technia.tvc.structurebrowser.form.render.Button> getButtons()

getChooserHeight

public int getChooserHeight()

getChooserURL

public java.lang.String getChooserURL()

getChooserWidth

public int getChooserWidth()

getDefaultValue

public java.lang.String getDefaultValue()

getDefaultValueHandler

public java.lang.String getDefaultValueHandler()

getDisplayValue

public java.lang.String getDisplayValue()

getEditableExpression

public java.lang.String getEditableExpression()

getLabelStyle

public java.lang.String getLabelStyle()

getLabelStyleExpressionEvaluated

public boolean getLabelStyleExpressionEvaluated()

getPostProcesses

public java.lang.String[] getPostProcesses()

getRangeDisplay

public java.lang.String getRangeDisplay()

getRanges

public java.util.List<RangeValue> getRanges()

getRangeSaveValue

public java.lang.String getRangeSaveValue()

getRangeSeparator

public java.lang.String getRangeSeparator()

getRenderer

public com.technia.tvc.structurebrowser.form.render.field.FormComponentRenderer getRenderer()

Description copied from class: FormComponent

Returns a new, or retrieved from cache, instance of a renderer

Specified by:

getRenderer in class FormComponent

Returns:

Returns the renderer

getSearchForm

public java.lang.String getSearchForm()

getSettings

public java.util.HashMap<java.lang.String,java.lang.String> getSettings()

getSetting

public java.lang.String getSetting(java.lang.String setting,
                                   java.lang.String defaultValue)

getSetting

public java.lang.Boolean getSetting(java.lang.String setting,
                                    boolean defaultValue)

getSize

public java.lang.String getSize()

getSubFieldId

public java.lang.String getSubFieldId(java.lang.String key)

getTooltipContent

public java.lang.String getTooltipContent()

getTooltipLabel

public java.lang.String getTooltipLabel()

getValidation

public com.technia.tvc.structurebrowser.form.model.Validation getValidation()

getValue

public java.lang.String getValue()

Gets the field value

Returns:

Returns the value of the field as a String

hasButtons

public boolean hasButtons()

hasRange

public boolean hasRange()

hasRangeLoader

public boolean hasRangeLoader()

init

public void init()
          throws com.technia.tvc.structurebrowser.form.exception.FormException

Overrides:

init in class FormComponent

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

invokeRangeLoader

protected java.util.List<RangeValue> invokeRangeLoader(Form fc)
                                                throws com.technia.tvc.structurebrowser.form.exception.FormException

If an range loader class is present for the field, this class invokes the class and changes the ranges values.

Returns:

String[] with Range values from rangeloader

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

isAutoComplete

public boolean isAutoComplete()

isChangeEventEnabled

public boolean isChangeEventEnabled()

isDynamicField

public boolean isDynamicField()

isEditable

public boolean isEditable()

isEditableText

@Deprecated
public boolean isEditableText()

Deprecated. Since 2012.3.0, use isEditable() instead...

isLocked

public boolean isLocked()

isRequired

public boolean isRequired()

Returns:

true if the field is required

isTemplatable

public boolean isTemplatable()

isRichText

public boolean isRichText()

isUsesBusinessObject

public boolean isUsesBusinessObject()

Returns:

true if the field applies to a businessobject, false if it applies to a relationship

isFromInterface

public boolean isFromInterface()

Returns:

true if the field applies to a interface attribute, false otherwise

load

public void load(Form configuration)
          throws com.technia.tvc.structurebrowser.form.exception.FormException

Initializes, or Restores, the field value(s) for this field

Parameters:

configuration - The form itself

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

loadExistingValue

public void loadExistingValue(Form configuration,
                              matrix.db.BusinessObjectWithSelect bows)
                       throws com.technia.tvc.structurebrowser.form.exception.FormException

This method puts business object select data into the fields value

Parameters:

configuration - The form itself

bows - A BusinessObjectWithSelect

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

loadExistingValue

public void loadExistingValue(Form configuration,
                              matrix.db.RelationshipWithSelect rws)
                       throws com.technia.tvc.structurebrowser.form.exception.FormException

This method puts relationship select data into the fields value

Parameters:

configuration - The form itself

rws - A RelationshipWithSelect

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

populateValuesFromRequest

public void populateValuesFromRequest(Form fc,
                                      javax.servlet.http.HttpServletRequest request)

Populates the field itself from the corresponding request parameter

Parameters:

request -

postProcess

public com.technia.tvc.structurebrowser.form.process.ProcessResultsLog postProcess(Form fc,
                                                                                   java.util.List<java.lang.String> oids)
                                                                            throws java.lang.Exception

Override this method to add post process logic

Parameters:

fc - The form itself

oids - A list of object id's. These are the results of the form

Returns:

Returns a log that can contain information about what has happened

Throws:

java.lang.Exception

Since:

2010.1.0

read

public void read(XMLPointer pointer,
                 Form form)

Restores the state of this field from an XML structure.

Subclasses can (and should) override this method in order to restore the state of the Field correctly.

Overrides:

read in class FormComponent

Parameters:

pointer - A pointer from where you can read the state from.

Since:

2010.1.0

resolveDisplayValuesFromObjectIds

public java.lang.String resolveDisplayValuesFromObjectIds(java.lang.String value)
                                                   throws com.technia.tvc.structurebrowser.form.exception.FormException

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

resolveDisplayValueFromObjectId

protected java.lang.String resolveDisplayValueFromObjectId(java.lang.String objectId)
                                                    throws com.technia.tvc.structurebrowser.form.exception.FormException

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

resolveObjectNamesFromObjectIds

public java.lang.String resolveObjectNamesFromObjectIds(java.lang.String value)

resolveObjectNamesFromObjectIds

public static java.lang.String resolveObjectNamesFromObjectIds(java.util.Collection<java.lang.String> ids)
                                                        throws com.technia.tvc.structurebrowser.form.exception.FormException

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

resolveDisplayExpressionFromObjectIds

public java.lang.String resolveDisplayExpressionFromObjectIds(java.lang.String displayExpression,
                                                              java.lang.String value)

resolveDisplayExpressionFromObjectIds

public java.lang.String resolveDisplayExpressionFromObjectIds(java.lang.String displayExpression,
                                                              java.util.Collection<java.lang.String> ids)
                                                       throws com.technia.tvc.structurebrowser.form.exception.FormException

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

save

public void save(XMLWriter writer)

Saves the state of this field into XML.

Subclasses can (and should) override this method in order to save Field specific things. NOTE: Subclasses should not try to "add element attributes" directly without creating their own "elements" in the XML stream.

Overrides:

save in class FormComponent

Parameters:

writer - The writer that you should write the data into

Since:

2010.1.0

setAutoComplete

public void setAutoComplete(boolean autoComplete)

setAutoCompleteHandler

public void setAutoCompleteHandler(java.lang.String handler)

setAutoCompleteSettings

public void setAutoCompleteSettings(java.lang.String settings)

setChangeEventEnabled

public void setChangeEventEnabled(boolean changeEventEnabled)

setChooserHeight

public void setChooserHeight(int chooserHeight)

setChooserURL

public void setChooserURL(java.lang.String chooserURL)

setChooserWidth

public void setChooserWidth(int chooserWidth)

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

setDefaultValueHandler

public void setDefaultValueHandler(java.lang.String defaultValueHandler)

setDisplayValue

public void setDisplayValue(java.lang.String displayValue)

setDynamicField

public void setDynamicField(boolean isDynamicField)

setEditable

public void setEditable(boolean editable)

setEditableExpression

public void setEditableExpression(java.lang.String editableExpression)

setEditableText

@Deprecated
public void setEditableText(boolean editableText)

Deprecated. since 2012.3.0 Use setEditable() instead...

setHelpHref

public void setHelpHref(java.lang.String helpHref)

Sets an URL value for where this field's user guide is located

Parameters:

helpHref -

setLabelStyle

public void setLabelStyle(java.lang.String labelStyle)

setLabelStyleExpression

public void setLabelStyleExpression(java.lang.String labelStyleExpression)

setLocked

public void setLocked(boolean locked)

setPostProcesses

public void setPostProcesses(java.lang.String[] postProcesses)

setRangeDisplay

public void setRangeDisplay(java.lang.String rangeDisplay)

setRangeLoader

public void setRangeLoader(com.technia.tvc.structurebrowser.form.rangeloader.RangeLoader rangeLoader)

Sets a class to used for loading a custom set of range values to a field. When present, no schema ranges can be loaded.

Parameters:

rangeLoader -

setRanges

public void setRanges(java.util.List<RangeValue> ranges)

setRangeSaveValue

public void setRangeSaveValue(java.lang.String rangeSaveValue)

setRangeSeparator

public void setRangeSeparator(java.lang.String rangeSeparator)

setRequired

public void setRequired(boolean required)

Sets whether the field should be mandatory or not.

Parameters:

required -

setTemplatable

public void setTemplatable(boolean templatable)

setRichText

public void setRichText(boolean richText)

setSearchForm

public void setSearchForm(java.lang.String searchForm)

setSettings

public void setSettings(java.util.HashMap<java.lang.String,java.lang.String> settings)

setSize

public void setSize(java.lang.String size)

setTooltipContent

public void setTooltipContent(java.lang.String tooltipContent)

setTooltipLabel

public void setTooltipLabel(java.lang.String tooltipLabel)

setUsesBusinessObject

public void setUsesBusinessObject(boolean usesBusinessObject)

setFromInterface

public void setFromInterface(boolean fromInterface)

setValidation

public void setValidation(com.technia.tvc.structurebrowser.form.model.Validation validation)

setValue

public void setValue(java.lang.String value)

Sets the field value

Parameters:

value -

setValue

public void setValue(java.lang.String displayValue,
                     java.lang.String value)

update

public void update(Form fc,
                   java.lang.String value,
                   boolean updateForm)
            throws com.technia.tvc.structurebrowser.form.exception.FormException

Implement this method to implement update logic

Parameters:

fc - The form itself

value - The update value

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

Since:

2010.2.0

toggleVisibleIfFields

protected void toggleVisibleIfFields(java.lang.String value,
                                     Form form)
                              throws com.technia.tvc.structurebrowser.form.exception.FormException

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

updateEventAction

public void updateEventAction(Form fc,
                              java.lang.String key,
                              java.lang.String value)
                       throws com.technia.tvc.structurebrowser.form.exception.FormException

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

updateFieldValue

public void updateFieldValue(Form configuration,
                             java.lang.String value,
                             boolean skipValidation,
                             boolean updateConfiguration)

Updates the field value for this field

Parameters:

configuration -

updateFieldValue

public void updateFieldValue(Form configuration,
                             java.lang.String value,
                             boolean skipValidation,
                             boolean updateConfiguration,
                             boolean updateStatus)

Updates the field value for this field

Parameters:

configuration -

validate

public java.lang.String validate(Form fc,
                                 java.lang.String value)

Implement this method to give the field custom validation logic

Parameters:

fc - The form itself

value - he update value

Returns:

String containing a validation error message, or null if validation was ok

Since:

2010.2.0

validateConfigurationInput

public boolean validateConfigurationInput(Form configuration)
                                   throws com.technia.tvc.structurebrowser.form.exception.FormException

Validate parameters read from configuration xml.

Returns:

true if validation OK, else false

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

forceVisible

public void forceVisible(Form fc)
                  throws com.technia.tvc.structurebrowser.form.exception.FormException

Make a field visible forcefully

Parameters:

fc -

Throws:

com.technia.tvc.structurebrowser.form.exception.FormException

Since:

2016.3.0

isSortRangeValues

public boolean isSortRangeValues()

setSortRangeValues

public void setSortRangeValues(boolean sortRangeValues)

isVisibleIfValueField

public boolean isVisibleIfValueField()

getVisibleIfId

public java.lang.String getVisibleIfId()

setVisibleIfId

public void setVisibleIfId(java.lang.String visibleIfId)

getVisibleIf

public java.util.List<java.lang.String> getVisibleIf()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object