com.technia.tvc.structurebrowser.form.model

Class FormComponent

java.lang.Object

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

Direct Known Subclasses:

Field

public abstract class FormComponent
extends java.lang.Object

Super class for a form component without presentation layer Intended to be extended by 'Tab', 'GroupHolder','FieldSeparator' and 'Field'

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADDED
protected java.lang.String	INPUT_ID_PREFIX
protected java.lang.String	label
protected java.lang.String	name
protected int	order
protected java.lang.String	parent
protected boolean	postProcessEnabled
protected int	status
protected boolean	templateEnabled
static int	TOBEREMOVED
static int	UNCHANGED
static int	UPDATED
protected com.technia.tvc.structurebrowser.form.model.ErrorSet	validationErrors
protected boolean	validationStatus

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addValidationError(java.lang.String errorMessage)
void	addValidationError(java.lang.String errorMessage, java.lang.Throwable e)
void	addValidationError(java.lang.Throwable e)
void	addValidationWarning(java.lang.String errorMessage)
void	addValidationWarning(java.lang.String errorMessage, java.lang.Throwable e) Adds a validation message without setting the validationstatus to false
void	addValidationWarning(java.lang.Throwable e)
void	clearValidationErrors()
int	compareTo(FormComponent field)
void	evaluateRequiredExpression(Form form)
void	evaluateVisibleExpression(Form form)
com.technia.tvc.structurebrowser.form.def.FormComponentDef	getComponentDef()
java.lang.String	getFieldPostProcess()
java.lang.String	getId()
java.lang.String	getLabel()
java.lang.String	getMobileRendererClassName() If the component has a mobile render, return the name of the class
java.lang.String	getName()
int	getOrder()
java.lang.String	getParent()
abstract com.technia.tvc.structurebrowser.form.render.field.FormComponentRenderer	getRenderer() Returns a new, or retrieved from cache, instance of a renderer
com.technia.tvc.structurebrowser.search.form.def.ClassRef	getRendererClassName() Returns a reference of the field renderer, or null if the default field renderer should be user.
boolean	getRequiredExpressionEvaluated()
int	getStatus() Get the current status of the field
com.technia.tvc.struts.action.ActionErrors	getValidationActionErrors()
com.technia.tvc.structurebrowser.form.model.ErrorSet	getValidationErrors()
boolean	getValidationStatus()
boolean	getVisibilityExpressionEvaluated()
void	init()
boolean	isPostProcessEnabled()
boolean	isTemplateEnabled()
boolean	isVisible()
void	read(XMLPointer pointer, Form form) Restores the state of this field from an XML structure.
void	save(XMLWriter writer) Saves the state of this field into XML.
void	setFieldPostProcess(java.lang.String fieldPostProcess)
void	setId(java.lang.String id)
void	setLabel(java.lang.String label) Sets the display label value for the field
void	setName(java.lang.String name) Sets the name for the field.
void	setOrder(int order)
void	setOrder(java.lang.String order) Sets the list order value for the field
void	setParent(java.lang.String parent)
void	setPostProcessEnabled(boolean postProcessEnabled)
void	setRendererClassName(java.lang.String rendererClassName) Sets the name of the renderer to be used.
void	setRequiredExpression(java.lang.String requiredExpression)
void	setStatus(int status) Set the status of the field
void	setTemplateEnabled(boolean templateEnabled)
void	setVisible(boolean visible) Set the field to be visible or invisible on the field.
void	setVisibleExpression(java.lang.String visibleExpression)

Methods inherited from class java.lang.Object

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

Field Detail

ADDED

public static final int ADDED

See Also:

Constant Field Values

TOBEREMOVED

public static final int TOBEREMOVED

See Also:

Constant Field Values

UNCHANGED

public static final int UNCHANGED

See Also:

Constant Field Values

UPDATED

public static final int UPDATED

See Also:

Constant Field Values

INPUT_ID_PREFIX

protected java.lang.String INPUT_ID_PREFIX

label

protected java.lang.String label

name

protected java.lang.String name

order

protected int order

parent

protected java.lang.String parent

postProcessEnabled

protected boolean postProcessEnabled

status

protected int status

templateEnabled

protected boolean templateEnabled

validationErrors

protected com.technia.tvc.structurebrowser.form.model.ErrorSet validationErrors

validationStatus

protected boolean validationStatus

Constructor Detail

FormComponent

public FormComponent(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

init

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

Throws:

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

addValidationError

public void addValidationError(java.lang.String errorMessage)

addValidationError

public void addValidationError(java.lang.String errorMessage,
                               java.lang.Throwable e)

addValidationError

public void addValidationError(java.lang.Throwable e)

addValidationWarning

public void addValidationWarning(java.lang.String errorMessage)

addValidationWarning

public void addValidationWarning(java.lang.String errorMessage,
                                 java.lang.Throwable e)

Adds a validation message without setting the validationstatus to false

Parameters:

errorMessage -

e -

addValidationWarning

public void addValidationWarning(java.lang.Throwable e)

clearValidationErrors

public void clearValidationErrors()

compareTo

public int compareTo(FormComponent field)

evaluateRequiredExpression

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

Throws:

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

evaluateVisibleExpression

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

Throws:

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

getFieldPostProcess

public java.lang.String getFieldPostProcess()

getId

public java.lang.String getId()

getLabel

public java.lang.String getLabel()

Returns:

display label value for the field

getMobileRendererClassName

public java.lang.String getMobileRendererClassName()

If the component has a mobile render, return the name of the class

Returns:

The class name of the mobile renderer

Since:

2012.3.0

getName

public java.lang.String getName()

Returns:

the name of the field

getOrder

public int getOrder()

Returns:

the order value

getParent

public java.lang.String getParent()

getRenderer

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

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

Returns:

Returns the renderer

Since:

2010.1.0

getRendererClassName

public com.technia.tvc.structurebrowser.search.form.def.ClassRef getRendererClassName()

Returns a reference of the field renderer, or null if the default field renderer should be user.

Since:

2010.1.0

getRequiredExpressionEvaluated

public boolean getRequiredExpressionEvaluated()

getStatus

public int getStatus()

Get the current status of the field

Returns:

Returns the field status. Can be one of the following: added, to be removed, updated or unchanged

getValidationActionErrors

public com.technia.tvc.struts.action.ActionErrors getValidationActionErrors()

getValidationErrors

public com.technia.tvc.structurebrowser.form.model.ErrorSet getValidationErrors()

getValidationStatus

public boolean getValidationStatus()

getVisibilityExpressionEvaluated

public boolean getVisibilityExpressionEvaluated()

isPostProcessEnabled

public boolean isPostProcessEnabled()

isTemplateEnabled

public boolean isTemplateEnabled()

isVisible

public boolean isVisible()

Returns:

true if the field is set visible, false otherwise

read

public void read(XMLPointer pointer,
                 Form form)

Restores the state of this field from an XML structure.

Parameters:

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

form -

Since:

2010.1.0

save

public void save(XMLWriter writer)

Saves the state of this field into XML.

Parameters:

writer - The XMLWriter that you should write the data into

setFieldPostProcess

public void setFieldPostProcess(java.lang.String fieldPostProcess)

setId

public void setId(java.lang.String id)

setLabel

public void setLabel(java.lang.String label)

Sets the display label value for the field

Parameters:

label -

setName

public void setName(java.lang.String name)

Sets the name for the field. This should in most cases correspond to an existing symbolic name in Matrix

Parameters:

name - The symbolic name

setOrder

public void setOrder(int order)

setOrder

public void setOrder(java.lang.String order)

Sets the list order value for the field

Parameters:

order - Numerical value

setParent

public void setParent(java.lang.String parent)

setPostProcessEnabled

public void setPostProcessEnabled(boolean postProcessEnabled)

setRendererClassName

public void setRendererClassName(java.lang.String rendererClassName)

Sets the name of the renderer to be used.

Parameters:

rendererClassName -

Since:

2010.1.0

setRequiredExpression

public void setRequiredExpression(java.lang.String requiredExpression)

setStatus

public void setStatus(int status)

Set the status of the field

Parameters:

status -

setTemplateEnabled

public void setTemplateEnabled(boolean templateEnabled)

setVisibleExpression

public void setVisibleExpression(java.lang.String visibleExpression)

setVisible

public void setVisible(boolean visible)

Set the field to be visible or invisible on the field. If invisible, the field is rendered as a hidden input field

Parameters:

visible -

getComponentDef

public com.technia.tvc.structurebrowser.form.def.FormComponentDef getComponentDef()