com.technia.tvc.structurebrowser.form.def

Class FieldDef

java.lang.Object

com.technia.tvc.structurebrowser.form.def.Def

com.technia.tvc.structurebrowser.form.def.FormComponentDef

com.technia.tvc.structurebrowser.form.def.FieldDef

All Implemented Interfaces:

com.technia.tvc.structurebrowser.search.form.def.MultilingualLabelSupport

public abstract class FieldDef
extends com.technia.tvc.structurebrowser.form.def.FormComponentDef

Definition class for fields.

Since:

2010.1.0

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoComplete
protected java.lang.String	autoCompleteHandler
protected java.lang.String	autoCompleteSettings
protected int	chooserHeight
protected java.lang.String	chooserURL
protected int	chooserWidth
protected java.lang.String	customRendererClassName
protected java.lang.String	defaultValue
protected boolean	editable
protected java.lang.String	editableExpression
protected boolean	focusFirst
protected boolean	fromInterface
protected boolean	hasclearbutton
protected java.lang.String	helpHref
protected java.lang.String	labelstyle
protected java.lang.String	labelStyleExpression
protected boolean	locked
protected boolean	multiSelect
protected java.util.List<java.lang.String>	postProcesses
protected java.lang.String	rangeDisplay
protected com.technia.tvc.structurebrowser.form.rangeloader.RangeLoader	rangeLoader
protected java.lang.String	rangeSaveValue
protected java.lang.String	rangeSeparator
protected boolean	required
protected java.lang.String	requiredExpression
protected boolean	richText
protected java.lang.String	searchform
protected java.util.HashMap<java.lang.String,java.lang.String>	settings
protected java.lang.String	size
protected boolean	sortRangeValues
protected java.lang.String	symbolicName
protected boolean	templatable
protected java.lang.String	textfieldwidth
protected java.lang.String	tooltipContent
protected java.lang.String	tooltipLabel
protected java.lang.String	updaterClass
protected boolean	usesBusinessObject
protected com.technia.tvc.structurebrowser.form.def.ValidationDef	validationDef
protected boolean	visible
protected java.lang.String	visibleExpression

Fields inherited from class com.technia.tvc.structurebrowser.form.def.FormComponentDef

id, name, templateEnabled

Constructor Summary

Constructors

Constructor and Description
FieldDef()

Method Summary

Modifier and Type	Method and Description
void	addPostProcessor(java.lang.String postProcessor)
void	addSetting(java.lang.String name, java.lang.String value)
void	addVisibleIfValue(java.lang.String value)
abstract FormComponent	createFormComponent()
java.lang.String	getAutoCompleteHandler()
java.lang.String	getAutoCompleteSettings()
int	getChooserHeight()
java.lang.String	getChooserURL()
int	getChooserWidth()
java.lang.String	getCustomRendererClassName()
java.lang.String	getDefaultAutoCompleteHandler() Default AutoCompleteHandler for the field.
java.lang.String	getDefaultValue()
java.lang.String	getDefaultValueHandler()
java.lang.String	getEditableExpression()
java.lang.String	getHelpHref()
java.lang.String[]	getPostProcesses()
java.lang.String	getRangeDisplay()
com.technia.tvc.structurebrowser.form.rangeloader.RangeLoader	getRangeLoader()
java.lang.String	getRangeSaveValue()
java.lang.String	getRangeSeparator()
java.lang.String	getRequiredExpression()
java.lang.String	getSearchform()
java.util.HashMap<java.lang.String,java.lang.String>	getSettings()
java.lang.String	getSize()
java.lang.String	getSymbolicName()
java.lang.String	getTextfieldwidth()
java.lang.String	getTooltipContent()
java.lang.String	getTooltipLabel()
java.lang.String	getUpdaterClass()
com.technia.tvc.structurebrowser.form.def.ValidationDef	getValidationDef()
java.lang.String	getVisibleExpression()
java.util.List<java.lang.String>	getVisibleIf()
java.lang.String	getVisibleIfId()
void	initialize()
boolean	isAutoComplete()
boolean	isEditable()
boolean	isFocusFirst()
boolean	isFromInterface()
boolean	isHasclearbutton()
boolean	isLocked()
boolean	isMultiSelect()
boolean	isRequired()
boolean	isRichText()
boolean	isSortRangeValues()
boolean	isTemplatable()
boolean	isUsesBusinessObject()
boolean	isVisible()
boolean	isVisibleIfDef()
void	setAutoComplete(boolean autoComplete)
void	setAutoComplete(java.lang.String autoComplete)
void	setAutoCompleteHandler(java.lang.String handler)
void	setAutoCompleteSettings(java.lang.String settings)
void	setChooserHeight(int chooserHeight)
void	setChooserURL(java.lang.String chooserURL)
void	setChooserWidth(int chooserWidth)
void	setCustomRendererClassName(java.lang.String customRendererClassName)
void	setDefaultValue(java.lang.String defaultValue)
void	setDefaultValueHandler(java.lang.String defaultValueHandler)
void	setEditable(java.lang.String editable)
void	setFocusFirst(java.lang.String focusFirst)
void	setFromInterface(boolean fromInterface)
void	setHasclearbutton(java.lang.String hasClearButton)
void	setHelpHref(java.lang.String helpHref)
void	setLabelstyle(java.lang.String labelstyle)
void	setLabelStyleExpression(java.lang.String labelStyleExpression)
void	setLocked(boolean locked)
void	setMultiSelect(java.lang.String multiSelect)
void	setRangeDisplay(java.lang.String rangeDisplay)
void	setRangeLoader(java.lang.String rangeLoader)
void	setRangeSaveValue(java.lang.String rangeSaveValue)
void	setRangeSeparator(java.lang.String rangeSeparator)
void	setReadOnly(java.lang.String readonly)
void	setRequired(java.lang.String requiredExpression)
void	setRichText(java.lang.String 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(java.lang.String sortRangeValues)
void	setSymbolicName(java.lang.String symbolicName)
void	setTemplatable(java.lang.String templatable)
void	setTextfieldwidth(java.lang.String textfieldwidth)
void	setTooltipContent(java.lang.String tooltipContent)
void	setTooltipLabel(java.lang.String tooltipLabel)
void	setUpdaterClass(java.lang.String updaterClass)
void	setUsesBusinessObject(boolean usesBusinessObject)
void	setValidationDef(com.technia.tvc.structurebrowser.form.def.ValidationDef validationDef)
void	setVisible(java.lang.String visibleExpression)
void	setVisibleIfId(java.lang.String visibleForId)
java.lang.String	toString()

Methods inherited from class com.technia.tvc.structurebrowser.form.def.FormComponentDef

getId, getLabel, getLabel, getName, isTemplateEnabled, setId, setLabel, setLabel, setName, setTemplateEnabled

Methods inherited from class com.technia.tvc.structurebrowser.form.def.Def

ensureNotReadOnly, isReadOnly

Methods inherited from class java.lang.Object

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

Field Detail

autoComplete

protected boolean autoComplete

autoCompleteHandler

protected java.lang.String autoCompleteHandler

autoCompleteSettings

protected java.lang.String autoCompleteSettings

chooserHeight

protected int chooserHeight

chooserURL

protected java.lang.String chooserURL

chooserWidth

protected int chooserWidth

customRendererClassName

protected java.lang.String customRendererClassName

defaultValue

protected java.lang.String defaultValue

editable

protected boolean editable

editableExpression

protected java.lang.String editableExpression

hasclearbutton

protected boolean hasclearbutton

helpHref

protected java.lang.String helpHref

labelstyle

protected java.lang.String labelstyle

labelStyleExpression

protected java.lang.String labelStyleExpression

locked

protected boolean locked

multiSelect

protected boolean multiSelect

postProcesses

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

rangeDisplay

protected java.lang.String rangeDisplay

rangeLoader

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

rangeSaveValue

protected java.lang.String rangeSaveValue

rangeSeparator

protected java.lang.String rangeSeparator

required

protected boolean required

templatable

protected boolean templatable

requiredExpression

protected java.lang.String requiredExpression

richText

protected boolean richText

searchform

protected java.lang.String searchform

settings

protected java.util.HashMap<java.lang.String,java.lang.String> settings

size

protected java.lang.String size

symbolicName

protected java.lang.String symbolicName

textfieldwidth

protected java.lang.String textfieldwidth

tooltipContent

protected java.lang.String tooltipContent

tooltipLabel

protected java.lang.String tooltipLabel

updaterClass

protected java.lang.String updaterClass

usesBusinessObject

protected boolean usesBusinessObject

fromInterface

protected boolean fromInterface

validationDef

protected com.technia.tvc.structurebrowser.form.def.ValidationDef validationDef

visible

protected boolean visible

visibleExpression

protected java.lang.String visibleExpression

sortRangeValues

protected boolean sortRangeValues

focusFirst

protected boolean focusFirst

Constructor Detail

FieldDef

public FieldDef()

Method Detail

addPostProcessor

public void addPostProcessor(java.lang.String postProcessor)

addSetting

public void addSetting(java.lang.String name,
                       java.lang.String value)

createFormComponent

public abstract FormComponent createFormComponent()
                                           throws com.technia.tvc.structurebrowser.form.exception.FormException

Specified by:

createFormComponent in class com.technia.tvc.structurebrowser.form.def.FormComponentDef

Throws:

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

getAutoCompleteHandler

public java.lang.String getAutoCompleteHandler()

getAutoCompleteSettings

public java.lang.String getAutoCompleteSettings()

getChooserHeight

public int getChooserHeight()

getChooserURL

public java.lang.String getChooserURL()

getChooserWidth

public int getChooserWidth()

getCustomRendererClassName

public java.lang.String getCustomRendererClassName()

getDefaultValue

public java.lang.String getDefaultValue()

getDefaultValueHandler

public java.lang.String getDefaultValueHandler()

getDefaultAutoCompleteHandler

public java.lang.String getDefaultAutoCompleteHandler()

Default AutoCompleteHandler for the field. Used in case no specific handler is configured for the field. Specify either with short-name (e.g. type, user, dataset) or qualified name of java class (com.acme.somedomain.MyCustomAutoCompleteHandler).

Returns:

The default autocomplete handler

Since:

2015.1.0

getEditableExpression

public java.lang.String getEditableExpression()

getHelpHref

public java.lang.String getHelpHref()

getPostProcesses

public java.lang.String[] getPostProcesses()

getRangeDisplay

public java.lang.String getRangeDisplay()

getRangeLoader

public com.technia.tvc.structurebrowser.form.rangeloader.RangeLoader getRangeLoader()

getRangeSaveValue

public java.lang.String getRangeSaveValue()

getRangeSeparator

public java.lang.String getRangeSeparator()

getRequiredExpression

public java.lang.String getRequiredExpression()

getSearchform

public java.lang.String getSearchform()

getSettings

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

getSize

public java.lang.String getSize()

getSymbolicName

public java.lang.String getSymbolicName()

getTextfieldwidth

public java.lang.String getTextfieldwidth()

getTooltipContent

public java.lang.String getTooltipContent()

getTooltipLabel

public java.lang.String getTooltipLabel()

getUpdaterClass

public java.lang.String getUpdaterClass()

getValidationDef

public com.technia.tvc.structurebrowser.form.def.ValidationDef getValidationDef()

getVisibleExpression

public java.lang.String getVisibleExpression()

initialize

public void initialize()
                throws TVCException

Overrides:

initialize in class com.technia.tvc.structurebrowser.form.def.Def

Throws:

TVCException

isAutoComplete

public boolean isAutoComplete()

isEditable

public boolean isEditable()

isHasclearbutton

public boolean isHasclearbutton()

isLocked

public boolean isLocked()

isMultiSelect

public boolean isMultiSelect()

isRequired

public boolean isRequired()

isTemplatable

public boolean isTemplatable()

isRichText

public boolean isRichText()

isUsesBusinessObject

public boolean isUsesBusinessObject()

isFromInterface

public boolean isFromInterface()

isVisible

public boolean isVisible()

setAutoComplete

public void setAutoComplete(java.lang.String autoComplete)

setAutoComplete

public void setAutoComplete(boolean autoComplete)

setAutoCompleteHandler

public void setAutoCompleteHandler(java.lang.String handler)

setAutoCompleteSettings

public void setAutoCompleteSettings(java.lang.String settings)

setChooserHeight

public void setChooserHeight(int chooserHeight)

setChooserURL

public void setChooserURL(java.lang.String chooserURL)

setChooserWidth

public void setChooserWidth(int chooserWidth)

setCustomRendererClassName

public void setCustomRendererClassName(java.lang.String customRendererClassName)

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)
                     throws java.lang.Exception

Throws:

java.lang.Exception

setDefaultValueHandler

public void setDefaultValueHandler(java.lang.String defaultValueHandler)

setEditable

public void setEditable(java.lang.String editable)

setHasclearbutton

public void setHasclearbutton(java.lang.String hasClearButton)

setHelpHref

public void setHelpHref(java.lang.String helpHref)

setLabelstyle

public void setLabelstyle(java.lang.String labelstyle)

setLabelStyleExpression

public void setLabelStyleExpression(java.lang.String labelStyleExpression)

setLocked

public void setLocked(boolean locked)

setMultiSelect

public void setMultiSelect(java.lang.String multiSelect)

setRangeDisplay

public void setRangeDisplay(java.lang.String rangeDisplay)

setRangeLoader

public void setRangeLoader(java.lang.String rangeLoader)
                    throws java.lang.Exception

Throws:

java.lang.Exception

setRangeSaveValue

public void setRangeSaveValue(java.lang.String rangeSaveValue)

setRangeSeparator

public void setRangeSeparator(java.lang.String rangeSeparator)

setReadOnly

public void setReadOnly(java.lang.String readonly)

setRequired

public void setRequired(java.lang.String requiredExpression)

setTemplatable

public void setTemplatable(java.lang.String templatable)

setRichText

public void setRichText(java.lang.String 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)

setSymbolicName

public void setSymbolicName(java.lang.String symbolicName)

setTextfieldwidth

public void setTextfieldwidth(java.lang.String textfieldwidth)

setTooltipContent

public void setTooltipContent(java.lang.String tooltipContent)

setTooltipLabel

public void setTooltipLabel(java.lang.String tooltipLabel)

setUpdaterClass

public void setUpdaterClass(java.lang.String updaterClass)

setUsesBusinessObject

public void setUsesBusinessObject(boolean usesBusinessObject)

setFromInterface

public void setFromInterface(boolean fromInterface)

setValidationDef

public void setValidationDef(com.technia.tvc.structurebrowser.form.def.ValidationDef validationDef)

setVisible

public void setVisible(java.lang.String visibleExpression)

isSortRangeValues

public boolean isSortRangeValues()

setSortRangeValues

public void setSortRangeValues(java.lang.String sortRangeValues)

addVisibleIfValue

public void addVisibleIfValue(java.lang.String value)

getVisibleIf

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

isVisibleIfDef

public boolean isVisibleIfDef()

getVisibleIfId

public java.lang.String getVisibleIfId()

setVisibleIfId

public void setVisibleIfId(java.lang.String visibleForId)

isFocusFirst

public boolean isFocusFirst()

setFocusFirst

public void setFocusFirst(java.lang.String focusFirst)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object