com.technia.tvc.structurebrowser.form.model

Class Form

java.lang.Object

com.technia.tvc.core.db.aef.env.BasicEnvironmentSupport

com.technia.tvc.structurebrowser.form.model.Form

All Implemented Interfaces:

EnvironmentSupport

public class Form
extends BasicEnvironmentSupport

This class represents a form.

Since:

2011.1.0

Field Summary

Fields inherited from class com.technia.tvc.core.db.aef.env.BasicEnvironmentSupport

env

Constructor Summary

Constructors

Constructor and Description
Form()

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(FormComponent field)
void	addFormError(java.lang.String errorMessage, java.lang.Exception e)
void	addFormWarning(java.lang.String errorMessage, java.lang.Exception e)
void	addTab(Tab tab)
void	changeType(java.lang.String typeName)
void	clearAllErrors()
void	clearFormErrors()
void	clearFormWarnings()
<T extends FormComponent> java.util.List<T>	findFields(java.lang.Class<T> clazz)
com.technia.tvc.struts.action.ActionErrors	getAllValidationWarnings()
AttributeField	getAttributeField(java.lang.String attributeName) Returns an AttributeField with the given attribute name
java.lang.String	getCategoryTreeMenuName()
java.lang.String	getConnectDirection()
java.lang.String	getConnectRelationship()
java.util.List<java.lang.String>	getCreatedObjects()
java.lang.String	getEditableExpression()
boolean	getEditableExpressionEvaluated()
<T extends FormComponent> T	getField(java.lang.Class<T> clazz)
FormComponent	getField(java.lang.String fieldName) Returns the component with the given name.
FormComponent	getField(java.lang.String fieldName, java.lang.Integer... status) Gets the component with a given name and a status.
<T> T	getFieldByClass(java.lang.Class<T> clazz)
java.util.List<Field>	getFields()
java.util.List<Field>	getFields(boolean sorted)
java.util.List<FormComponent>	getFields(java.lang.Class<? extends FormComponent> clazz)
java.util.List<FormComponent>	getFields(java.lang.Class<? extends FormComponent> clazz, boolean checkDerived)
java.util.List<FormComponent>	getFieldsWithStatus(int[] status)
Field	getFieldWithId(java.lang.String fieldId) This method finds the field with a specified id in the form
java.util.List<FormComponent>	getFormComponents()
java.util.List<FormComponent>	getFormComponents(boolean sorted)
java.lang.String[]	getFormErrors()
FormMode	getFormMode()
java.lang.String	getFormName()
java.lang.String[]	getFormPostProcesses()
java.lang.String	getFormProcessorClass()
java.lang.String	getFormWarning()
com.technia.tvc.struts.action.ActionErrors	getFormWarnings()
java.util.List<java.lang.String>	getGlobalJSFunctions()
java.lang.String	getGlobalValidation()
java.lang.String	getHeader()
java.lang.String	getHelpHref()
java.lang.String	getId()
java.util.List<Resource>	getJavascriptRefs()
MenuBar	getMenuBar()
int	getMultipleCreateValue()
java.lang.String	getNameFieldValue()
java.lang.String	getObjectId()
java.lang.String	getPolicyFieldValue()
java.util.List<ProcessResultsLog>	getProcessLogs()
FormProcessor	getProcessorClass()
java.lang.String	getRelationshipId()
java.lang.String	getReserveOnEditComment()
java.lang.String	getReserveOnEditExpiration()
java.lang.String	getRevisionFieldValue()
java.util.List<TableData>	getSelectedTableData()
boolean	getShowWarningForUnsavedForm()
java.util.Iterator<Tab>	getSortedTabsIterator()
java.util.List<Resource>	getStylesheetRefs()
java.lang.String	getSubHeader()
int	getTabIndex()
TableBean<?>	getTable()
java.util.List<Tab>	getTabs()
java.lang.String[]	getTemplates()
java.lang.String	getTypeFieldValue()
java.lang.String	getUserAccessMask()
java.lang.String	getUserFullName()
java.lang.String	getUserName()
com.technia.tvc.struts.action.ActionErrors	getValidationErrors()
java.lang.String	getVaultFieldValue()
protected java.util.List<Field>	getVisibleIfFields()
protected java.util.List<Field>	getVisibleIfReferenceFields()
boolean	hasFormErrors()
boolean	hasFormWarnings()
boolean	hasObjectId()
protected boolean	hasVisibleIfReference(Field f)
void	initHeaders(java.util.Map<java.lang.String,SimpleMultilingualText> header, java.util.Map<java.lang.String,SimpleMultilingualText> subHeader)
boolean	isAddToTable()
boolean	isAllowTemplates()
boolean	isCloseOnDone()
boolean	isDisplayPresetSelector()
boolean	isEditAllowed() This method checks if the form is editable by checking if the user has modify access and if there is an additional access expression or handler specified, also evaluates that.
boolean	isExecutePerSelection()
boolean	isReserveOnEdit()
boolean	isSaveHidden()
boolean	isSaveLocked()
boolean	isSaveReadonly()
boolean	isTemplatable(FormComponent component)
protected void	loadComponents(java.util.Collection<FormComponent> components, java.lang.String objectId, java.lang.String relId, TypeField typeField)
void	loadObject() Applies businessobject data onto the form fields based on objectId
void	onLoadFormFieldsEventAction() Initializes, or Restores, the field value for each field in this form configuration
void	populateProperties(Environment env)
void	populateProperties(javax.servlet.http.HttpServletRequest request)
void	removeField(FormComponent field) Removes a field from the form
void	resetFieldsStatus() This method resets all the fields' status
void	setAddToTable(boolean addToTable)
void	setAllowTemplates(boolean allowTemplates)
void	setCategoryTreeMenuName(java.lang.String categoryTreeMenuName)
void	setCloseOnDone(boolean closeOnDone)
void	setConnectDirection(java.lang.String connectDirection)
void	setConnectRelationship(java.lang.String connectRelationship)
void	setCreatedObjects(java.util.List<java.lang.String> createdObjects)
void	setDisplayPresetSelector(boolean displayPresetSelector)
void	setEditableExpression(java.lang.String editableExpression)
void	setEditableExpressionEvaluated(boolean editableExpressionEvaluated)
void	setExecutePerSelection(boolean executePerSelection)
void	setFormMode(FormMode formMode)
void	setFormName(java.lang.String formName)
void	setFormPostProcesses(java.lang.String[] formPostProcesses)
void	setFormProcessorClass(java.lang.String formProcessorClass)
void	setGlobalJSFunctions(java.util.List<java.lang.String> globalJSFunctions)
void	setGlobalValidation(java.lang.String globalValidation)
void	setHeader(java.lang.String header)
void	setHelpHref(java.lang.String helpHref)
void	setId(java.lang.String id)
void	setJavascriptRefs(java.util.List<Resource> javascriptRefs)
void	setMenuBar(MenuBar menuBar)
void	setObjectId(java.lang.String objectId)
void	setProcessLogs(java.util.List<ProcessResultsLog> processLogs)
void	setReserveOnEdit(boolean reserveOnEdit)
void	setReserveOnEditComment(java.lang.String reserveOnEditComment)
void	setReserveOnEditExpiration(java.lang.String reserveOnEditExpiration)
void	setSaveHidden(boolean saveHidden)
void	setSaveLocked(boolean saveLocked)
void	setSaveReadonly(boolean saveReadonly)
void	setSelectedTableData(java.util.List<TableData> selectedTableData)
void	setShowWarningForUnsavedForm(boolean showWarningForUnsavedForm)
void	setStylesheetRefs(java.util.List<Resource> stylesheetRefs)
void	setSubHeader(java.lang.String subHeader)
void	setTabIndex(int tabIndex)
void	setTable(TableBean<?> table)
void	setTemplates(java.lang.String[] templates)
void	setUserAccessMask(java.lang.String userAccessMask)
void	unload() This method is available to execute when the from is discarded, in order to perform cleanup actions, such as unreserving the associated businessobject, if form was in edit mode.
void	validate()
Response	validateGlobal() This method performs a global validation of the form, using either the configured response, or a response created in a java class, pointed out in the form configuration.

Methods inherited from class com.technia.tvc.core.db.aef.env.BasicEnvironmentSupport

getEnv, getEnv, setEnv

Methods inherited from class java.lang.Object

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

Constructor Detail

Form

public Form()
     throws TVCException

Throws:

TVCException

Method Detail

addField

public void addField(FormComponent field)

addFormError

public void addFormError(java.lang.String errorMessage,
                java.lang.Exception e)

addFormWarning

public void addFormWarning(java.lang.String errorMessage,
                  java.lang.Exception e)

addTab

public void addTab(Tab tab)

changeType

public void changeType(java.lang.String typeName)
                throws FormException

Throws:

FormException

clearAllErrors

public void clearAllErrors()

clearFormErrors

public void clearFormErrors()

clearFormWarnings

public void clearFormWarnings()

getAllValidationWarnings

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

getAttributeField

public AttributeField getAttributeField(java.lang.String attributeName)

Returns an AttributeField with the given attribute name

Parameters:

attributeName -

Since:

2010.1.0

getCategoryTreeMenuName

public java.lang.String getCategoryTreeMenuName()

getConnectDirection

public java.lang.String getConnectDirection()

getConnectRelationship

public java.lang.String getConnectRelationship()

getCreatedObjects

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

getEditableExpression

public java.lang.String getEditableExpression()

getEditableExpressionEvaluated

public boolean getEditableExpressionEvaluated()

getField

public <T extends FormComponent> T getField(java.lang.Class<T> clazz)

getField

public FormComponent getField(java.lang.String fieldName)

Returns the component with the given name. Usually used for fields that are given specific names in the XML configuration...

Parameters:

fieldName -

Since:

2010.1.0

getField

public FormComponent getField(java.lang.String fieldName,
                     java.lang.Integer... status)

Gets the component with a given name and a status.

Parameters:

fieldName - Name

status - Status the field must be of

Returns:

The component

Since:

2014.1.0

getFieldByClass

public <T> T getFieldByClass(java.lang.Class<T> clazz)

findFields

public <T extends FormComponent> java.util.List<T> findFields(java.lang.Class<T> clazz)

getFields

public java.util.List<Field> getFields()

getFields

public java.util.List<Field> getFields(boolean sorted)

getFields

public java.util.List<FormComponent> getFields(java.lang.Class<? extends FormComponent> clazz,
                                      boolean checkDerived)

getFields

public java.util.List<FormComponent> getFields(java.lang.Class<? extends FormComponent> clazz)

getFieldsWithStatus

public java.util.List<FormComponent> getFieldsWithStatus(int[] status)

getFieldWithId

public Field getFieldWithId(java.lang.String fieldId)

This method finds the field with a specified id in the form

Parameters:

fieldId -

Returns:

Returns the field with the given id

getFormComponents

public java.util.List<FormComponent> getFormComponents()

getFormComponents

public java.util.List<FormComponent> getFormComponents(boolean sorted)

getFormErrors

public java.lang.String[] getFormErrors()

getFormMode

public FormMode getFormMode()

getFormName

public java.lang.String getFormName()

getFormPostProcesses

public java.lang.String[] getFormPostProcesses()

getFormProcessorClass

public java.lang.String getFormProcessorClass()

getFormWarning

public java.lang.String getFormWarning()

getFormWarnings

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

getGlobalValidation

public java.lang.String getGlobalValidation()

getHeader

public java.lang.String getHeader()

getHelpHref

public java.lang.String getHelpHref()

getId

public java.lang.String getId()

getJavascriptRefs

public java.util.List<Resource> getJavascriptRefs()

getMenuBar

public MenuBar getMenuBar()

getMultipleCreateValue

public int getMultipleCreateValue()

getNameFieldValue

public java.lang.String getNameFieldValue()

getObjectId

public java.lang.String getObjectId()

getPolicyFieldValue

public java.lang.String getPolicyFieldValue()

getProcessLogs

public java.util.List<ProcessResultsLog> getProcessLogs()

getProcessorClass

public FormProcessor getProcessorClass()
                                throws FormException

Throws:

FormException

getRelationshipId

public java.lang.String getRelationshipId()

getReserveOnEditComment

public java.lang.String getReserveOnEditComment()

getReserveOnEditExpiration

public java.lang.String getReserveOnEditExpiration()

getRevisionFieldValue

public java.lang.String getRevisionFieldValue()

getSelectedTableData

public java.util.List<TableData> getSelectedTableData()

getSortedTabsIterator

public java.util.Iterator<Tab> getSortedTabsIterator()

getSubHeader

public java.lang.String getSubHeader()

getTable

public TableBean<?> getTable()

getTabs

public java.util.List<Tab> getTabs()

getTemplates

public java.lang.String[] getTemplates()

getTypeFieldValue

public java.lang.String getTypeFieldValue()
                                   throws FormException

Throws:

FormException

getUserAccessMask

public java.lang.String getUserAccessMask()

getUserFullName

public java.lang.String getUserFullName()

getUserName

public java.lang.String getUserName()

getTabIndex

public int getTabIndex()

getValidationErrors

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

getVaultFieldValue

public java.lang.String getVaultFieldValue()

hasFormErrors

public boolean hasFormErrors()

hasFormWarnings

public boolean hasFormWarnings()

hasObjectId

public boolean hasObjectId()

initHeaders

public void initHeaders(java.util.Map<java.lang.String,SimpleMultilingualText> header,
               java.util.Map<java.lang.String,SimpleMultilingualText> subHeader)

isAddToTable

public boolean isAddToTable()

isCloseOnDone

public boolean isCloseOnDone()

isAllowTemplates

public boolean isAllowTemplates()

isSaveReadonly

public boolean isSaveReadonly()

isSaveHidden

public boolean isSaveHidden()

isSaveLocked

public boolean isSaveLocked()

isTemplatable

public boolean isTemplatable(FormComponent component)

isDisplayPresetSelector

public boolean isDisplayPresetSelector()

isEditAllowed

public boolean isEditAllowed()

This method checks if the form is editable by checking if the user has modify access and if there is an additional access expression or handler specified, also evaluates that.

Returns:

True if form is editable, otherwise false

Since:

2012.3.0

isExecutePerSelection

public boolean isExecutePerSelection()

isReserveOnEdit

public boolean isReserveOnEdit()

getVisibleIfFields

protected java.util.List<Field> getVisibleIfFields()

getVisibleIfReferenceFields

protected java.util.List<Field> getVisibleIfReferenceFields()

hasVisibleIfReference

protected boolean hasVisibleIfReference(Field f)

loadObject

public void loadObject()
                throws FormException

Applies businessobject data onto the form fields based on objectId

Throws:

FormException

loadComponents

protected void loadComponents(java.util.Collection<FormComponent> components,
                  java.lang.String objectId,
                  java.lang.String relId,
                  TypeField typeField)
                       throws TVCException

Throws:

TVCException

onLoadFormFieldsEventAction

public void onLoadFormFieldsEventAction()
                                 throws FormException

Initializes, or Restores, the field value for each field in this form configuration

Throws:

FormException

removeField

public void removeField(FormComponent field)

Removes a field from the form

Parameters:

field -

resetFieldsStatus

public void resetFieldsStatus()

This method resets all the fields' status

setTabIndex

public void setTabIndex(int tabIndex)

setAddToTable

public void setAddToTable(boolean addToTable)

setCloseOnDone

public void setCloseOnDone(boolean closeOnDone)

setAllowTemplates

public void setAllowTemplates(boolean allowTemplates)

setSaveReadonly

public void setSaveReadonly(boolean saveReadonly)

setSaveHidden

public void setSaveHidden(boolean saveHidden)

setSaveLocked

public void setSaveLocked(boolean saveLocked)

setCategoryTreeMenuName

public void setCategoryTreeMenuName(java.lang.String categoryTreeMenuName)

setConnectDirection

public void setConnectDirection(java.lang.String connectDirection)

setConnectRelationship

public void setConnectRelationship(java.lang.String connectRelationship)

setCreatedObjects

public void setCreatedObjects(java.util.List<java.lang.String> createdObjects)

setDisplayPresetSelector

public void setDisplayPresetSelector(boolean displayPresetSelector)

setEditableExpression

public void setEditableExpression(java.lang.String editableExpression)

setEditableExpressionEvaluated

public void setEditableExpressionEvaluated(boolean editableExpressionEvaluated)

setExecutePerSelection

public void setExecutePerSelection(boolean executePerSelection)

setFormMode

public void setFormMode(FormMode formMode)

setFormName

public void setFormName(java.lang.String formName)

setFormPostProcesses

public void setFormPostProcesses(java.lang.String[] formPostProcesses)

setFormProcessorClass

public void setFormProcessorClass(java.lang.String formProcessorClass)

setGlobalValidation

public void setGlobalValidation(java.lang.String globalValidation)

setHeader

public void setHeader(java.lang.String header)

setHelpHref

public void setHelpHref(java.lang.String helpHref)

setId

public void setId(java.lang.String id)

setJavascriptRefs

public void setJavascriptRefs(java.util.List<Resource> javascriptRefs)

setMenuBar

public void setMenuBar(MenuBar menuBar)

setObjectId

public void setObjectId(java.lang.String objectId)
                 throws FormException

Throws:

FormException

setProcessLogs

public void setProcessLogs(java.util.List<ProcessResultsLog> processLogs)

setReserveOnEdit

public void setReserveOnEdit(boolean reserveOnEdit)

setReserveOnEditComment

public void setReserveOnEditComment(java.lang.String reserveOnEditComment)

setReserveOnEditExpiration

public void setReserveOnEditExpiration(java.lang.String reserveOnEditExpiration)

setSelectedTableData

public void setSelectedTableData(java.util.List<TableData> selectedTableData)

setSubHeader

public void setSubHeader(java.lang.String subHeader)

setTable

public void setTable(TableBean<?> table)

setTemplates

public void setTemplates(java.lang.String[] templates)

setUserAccessMask

public void setUserAccessMask(java.lang.String userAccessMask)

unload

public void unload()

This method is available to execute when the from is discarded, in order to perform cleanup actions, such as unreserving the associated businessobject, if form was in edit mode.

Since:

2011.3.0

validate

public void validate()
              throws TVCException

Throws:

TVCException

validateGlobal

public Response validateGlobal()
                        throws FormException

This method performs a global validation of the form, using either the configured response, or a response created in a java class, pointed out in the form configuration. Examples of configuration: warning:This is a warning message confirm:Are you sure you entered all info? java:com.technia.tvc.from.examples .MyValidation

Returns:

Response

Throws:

FormException

Since:

2011.3.0

getStylesheetRefs

public java.util.List<Resource> getStylesheetRefs()

setStylesheetRefs

public void setStylesheetRefs(java.util.List<Resource> stylesheetRefs)

getGlobalJSFunctions

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

setGlobalJSFunctions

public void setGlobalJSFunctions(java.util.List<java.lang.String> globalJSFunctions)

populateProperties

public void populateProperties(javax.servlet.http.HttpServletRequest request)

populateProperties

public void populateProperties(Environment env)

setShowWarningForUnsavedForm

public void setShowWarningForUnsavedForm(boolean showWarningForUnsavedForm)

getShowWarningForUnsavedForm

public boolean getShowWarningForUnsavedForm()