public class Form extends BasicEnvironmentSupport
env| Constructor and Description |
|---|
Form() |
| 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> |
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> |
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.
|
getEnv, getEnv, setEnvpublic Form()
throws TVCException
TVCExceptionpublic void addField(FormComponent field)
public void addFormError(java.lang.String errorMessage,
java.lang.Exception e)
public void addFormWarning(java.lang.String errorMessage,
java.lang.Exception e)
public void addTab(Tab tab)
public void changeType(java.lang.String typeName)
throws FormException
FormExceptionpublic void clearAllErrors()
public void clearFormErrors()
public void clearFormWarnings()
public com.technia.tvc.struts.action.ActionErrors getAllValidationWarnings()
public AttributeField getAttributeField(java.lang.String attributeName)
AttributeField with the given attribute
nameattributeName - public java.lang.String getCategoryTreeMenuName()
public java.lang.String getConnectDirection()
public java.lang.String getConnectRelationship()
public java.util.List<java.lang.String> getCreatedObjects()
public java.lang.String getEditableExpression()
public boolean getEditableExpressionEvaluated()
public <T extends FormComponent> T getField(java.lang.Class<T> clazz)
public FormComponent getField(java.lang.String fieldName)
component with the given name. Usually
used for fields that are given specific names in the XML configuration...fieldName - public FormComponent getField(java.lang.String fieldName, java.lang.Integer... status)
component with a given name and a status.fieldName - Namestatus - Status the field must be ofpublic <T> T getFieldByClass(java.lang.Class<T> clazz)
public <T extends FormComponent> java.util.List<T> findFields(java.lang.Class<T> clazz)
public java.util.List<Field> getFields()
public java.util.List<Field> getFields(boolean sorted)
public java.util.List<FormComponent> getFields(java.lang.Class<? extends FormComponent> clazz, boolean checkDerived)
public java.util.List<FormComponent> getFields(java.lang.Class<? extends FormComponent> clazz)
public java.util.List<FormComponent> getFieldsWithStatus(int[] status)
public Field getFieldWithId(java.lang.String fieldId)
fieldId - field with the given idpublic java.util.List<FormComponent> getFormComponents()
public java.util.List<FormComponent> getFormComponents(boolean sorted)
public java.lang.String[] getFormErrors()
public FormMode getFormMode()
public java.lang.String getFormName()
public java.lang.String[] getFormPostProcesses()
public java.lang.String getFormProcessorClass()
public java.lang.String getFormWarning()
public com.technia.tvc.struts.action.ActionErrors getFormWarnings()
public java.lang.String getGlobalValidation()
public java.lang.String getHeader()
public java.lang.String getHelpHref()
public java.lang.String getId()
public java.util.List<Resource> getJavascriptRefs()
public MenuBar getMenuBar()
public int getMultipleCreateValue()
public java.lang.String getNameFieldValue()
public java.lang.String getObjectId()
public java.lang.String getPolicyFieldValue()
public java.util.List<ProcessResultsLog> getProcessLogs()
public FormProcessor getProcessorClass()
throws FormException
FormExceptionpublic java.lang.String getRelationshipId()
public java.lang.String getReserveOnEditComment()
public java.lang.String getReserveOnEditExpiration()
public java.lang.String getRevisionFieldValue()
public java.util.List<TableData> getSelectedTableData()
public java.util.Iterator<Tab> getSortedTabsIterator()
public java.lang.String getSubHeader()
public TableBean<?> getTable()
public java.util.List<Tab> getTabs()
public java.lang.String[] getTemplates()
public java.lang.String getTypeFieldValue()
throws FormException
FormExceptionpublic java.lang.String getUserAccessMask()
public java.lang.String getUserFullName()
public java.lang.String getUserName()
public int getTabIndex()
public com.technia.tvc.struts.action.ActionErrors getValidationErrors()
public java.lang.String getVaultFieldValue()
public boolean hasFormErrors()
public boolean hasFormWarnings()
public boolean hasObjectId()
public void initHeaders(java.util.Map<java.lang.String,SimpleMultilingualText> header, java.util.Map<java.lang.String,SimpleMultilingualText> subHeader)
public boolean isAddToTable()
public boolean isCloseOnDone()
public boolean isAllowTemplates()
public boolean isSaveReadonly()
public boolean isSaveHidden()
public boolean isSaveLocked()
public boolean isTemplatable(FormComponent component)
public boolean isDisplayPresetSelector()
public boolean isEditAllowed()
public boolean isExecutePerSelection()
public boolean isReserveOnEdit()
protected java.util.List<Field> getVisibleIfFields()
protected java.util.List<Field> getVisibleIfReferenceFields()
protected boolean hasVisibleIfReference(Field f)
public void loadObject()
throws FormException
FormExceptionprotected void loadComponents(java.util.Collection<FormComponent> components, java.lang.String objectId, java.lang.String relId, TypeField typeField) throws TVCException
TVCExceptionpublic void onLoadFormFieldsEventAction()
throws FormException
FormExceptionpublic void removeField(FormComponent field)
field - public void resetFieldsStatus()
public void setTabIndex(int tabIndex)
public void setAddToTable(boolean addToTable)
public void setCloseOnDone(boolean closeOnDone)
public void setAllowTemplates(boolean allowTemplates)
public void setSaveReadonly(boolean saveReadonly)
public void setSaveHidden(boolean saveHidden)
public void setSaveLocked(boolean saveLocked)
public void setCategoryTreeMenuName(java.lang.String categoryTreeMenuName)
public void setConnectDirection(java.lang.String connectDirection)
public void setConnectRelationship(java.lang.String connectRelationship)
public void setCreatedObjects(java.util.List<java.lang.String> createdObjects)
public void setDisplayPresetSelector(boolean displayPresetSelector)
public void setEditableExpression(java.lang.String editableExpression)
public void setEditableExpressionEvaluated(boolean editableExpressionEvaluated)
public void setExecutePerSelection(boolean executePerSelection)
public void setFormMode(FormMode formMode)
public void setFormName(java.lang.String formName)
public void setFormPostProcesses(java.lang.String[] formPostProcesses)
public void setFormProcessorClass(java.lang.String formProcessorClass)
public void setGlobalValidation(java.lang.String globalValidation)
public void setHeader(java.lang.String header)
public void setHelpHref(java.lang.String helpHref)
public void setId(java.lang.String id)
public void setJavascriptRefs(java.util.List<Resource> javascriptRefs)
public void setMenuBar(MenuBar menuBar)
public void setObjectId(java.lang.String objectId)
throws FormException
FormExceptionpublic void setProcessLogs(java.util.List<ProcessResultsLog> processLogs)
public void setReserveOnEdit(boolean reserveOnEdit)
public void setReserveOnEditComment(java.lang.String reserveOnEditComment)
public void setReserveOnEditExpiration(java.lang.String reserveOnEditExpiration)
public void setSelectedTableData(java.util.List<TableData> selectedTableData)
public void setSubHeader(java.lang.String subHeader)
public void setTable(TableBean<?> table)
public void setTemplates(java.lang.String[] templates)
public void setUserAccessMask(java.lang.String userAccessMask)
public void unload()
public void validate()
throws TVCException
TVCExceptionpublic Response validateGlobal() throws FormException
FormExceptionpublic java.util.List<Resource> getStylesheetRefs()
public void setStylesheetRefs(java.util.List<Resource> stylesheetRefs)
public java.util.List<java.lang.String> getGlobalJSFunctions()
public void setGlobalJSFunctions(java.util.List<java.lang.String> globalJSFunctions)
public void populateProperties(javax.servlet.http.HttpServletRequest request)
public void populateProperties(Environment env)
public void setShowWarningForUnsavedForm(boolean showWarningForUnsavedForm)
public boolean getShowWarningForUnsavedForm()
Copyright ? Technia AB. All Rights Reserved.