public class TMLFormInfo extends java.lang.Object implements FormInfo
Modifier and Type | Class and Description |
---|---|
static class |
TMLFormInfo.FormValidation |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EDIT_MODE |
static java.lang.String |
HTMLINPUT_FALSE |
static java.lang.String |
HTMLINPUT_IGNORE |
static java.lang.String |
HTMLINPUT_TRUE |
static java.lang.String |
READONLY_MODE |
static java.lang.String |
VIEW_MODE |
Constructor and Description |
---|
TMLFormInfo(java.lang.String formId,
java.lang.String htmlInputMode,
boolean persistent,
de.innovationgate.wga.common.beans.csconfig.v1.Version complianceVersion) |
Modifier and Type | Method and Description |
---|---|
void |
addCustomField(TMLFormField field) |
void |
addFormValidation(java.lang.String validation,
java.lang.String message,
java.util.List ifnoerrorList,
java.util.List cleariferrorList) |
void |
addHashedPasswordField(TMLFormField field) |
void |
addOrMergeFieldReg(FieldReg fieldReg) |
void |
clearLastRenderedFormFields() |
boolean |
containsFieldRegistration(java.lang.String fieldname) |
java.lang.String |
getContentClass()
Returns the content class of documents created and edited with this form.
|
java.util.Map<java.lang.String,TMLFormField> |
getCustomFields() |
java.lang.String |
getDefaultAction() |
java.lang.String |
getDefinitionDatabase() |
java.lang.String |
getDefinitionModule() |
FieldReg |
getFieldRegistration(java.lang.String fieldname) |
java.util.Collection<FieldReg> |
getFieldRegistrations() |
java.lang.String |
getFormId()
Returns the ID of the WebTML form
|
java.util.HashMap |
getFormValidations() |
TMLFormField |
getHashedPasswordField(java.lang.String fieldname) |
java.lang.String |
getHtmlInput() |
java.util.Set<java.lang.String> |
getLastRenderedFormFields() |
java.lang.String |
getMode()
Returns the display mode of the WebTML form
|
java.lang.String |
getProcessId() |
ScopeObjectRegistry |
getScopeObjectRegistry() |
java.lang.String |
getSource()
Returns the data source of the WebTML form
|
java.lang.String |
getTargetContextPath() |
de.innovationgate.wga.common.beans.csconfig.v1.Version |
getVersionCompliance() |
boolean |
importFormInfo(TMLFormInfo formInfo)
merge given forminfo with this
|
boolean |
isCorrectMode(java.lang.String mode) |
boolean |
isHtmlInput()
Returns if the created form will accept plain HTML input fields
|
boolean |
isPersistent()
Returns if the created form is to be stored persistently on the user session
|
boolean |
isSyncFiles() |
boolean |
isTrim()
Returns if the created form is to automatically trim field contents
|
boolean |
isValidated() |
boolean |
keepOnValidate() |
void |
optimize()
removes all fields which where rendered in the last request from customFields,
to avoid these fields to be submitted twice (with FormInfo AND with standard formfield)
This method should be called, before the formInfo is serialized.
|
void |
removeCustomField(java.lang.String fieldname) |
void |
removeFieldReg(java.lang.String fieldname) |
void |
reset() |
void |
setContentClass(java.lang.String contentclass)
Sets the content class of documents created and edited with this form.
|
void |
setDefaultAction(java.lang.String defaultAction) |
void |
setDefinition(Design design)
Sets the form definition information to the base reference of the given design
|
void |
setDefinitionDatabase(java.lang.String definitionDatabase) |
void |
setDefinitionModule(java.lang.String definitionModule) |
void |
setFormId(java.lang.String formId)
Sets the ID of the WebTML form.
|
void |
setHtmlInput(boolean input) |
void |
setKeepOnValidate(boolean keepOnValidate) |
void |
setMode(java.lang.String mode)
Sets the display mode of the WebTML form
|
void |
setPersistent(boolean persistent) |
void |
setProcessId(java.lang.String processId) |
void |
setSource(java.lang.String source)
Sets the data source of the WebTML form
|
void |
setSyncFiles(boolean syncFiles) |
void |
setTargetContextPath(java.lang.String targetContextPath) |
void |
setTrim(boolean trim)
Sets if the created form is to automatically trim field contents
|
void |
setValidated(boolean validated) |
public static final java.lang.String EDIT_MODE
public static final java.lang.String VIEW_MODE
public static final java.lang.String READONLY_MODE
public static final java.lang.String HTMLINPUT_IGNORE
public static final java.lang.String HTMLINPUT_TRUE
public static final java.lang.String HTMLINPUT_FALSE
public TMLFormInfo(java.lang.String formId, java.lang.String htmlInputMode, boolean persistent, de.innovationgate.wga.common.beans.csconfig.v1.Version complianceVersion)
public java.lang.String getSource()
FormInfo
public void setSource(java.lang.String source)
FormInfo
public void addOrMergeFieldReg(FieldReg fieldReg)
public void removeFieldReg(java.lang.String fieldname)
public java.util.Collection<FieldReg> getFieldRegistrations()
public FieldReg getFieldRegistration(java.lang.String fieldname)
public boolean containsFieldRegistration(java.lang.String fieldname)
public void reset()
public boolean importFormInfo(TMLFormInfo formInfo)
formInfo
- public boolean isTrim()
FormInfo
public void setTrim(boolean trim)
FormInfo
public java.util.HashMap getFormValidations()
public void addFormValidation(java.lang.String validation, java.lang.String message, java.util.List ifnoerrorList, java.util.List cleariferrorList)
public java.util.Set<java.lang.String> getLastRenderedFormFields()
public void clearLastRenderedFormFields()
public java.lang.String getFormId()
FormInfo
public void setFormId(java.lang.String formId)
FormInfo
public java.lang.String getHtmlInput()
public boolean isHtmlInput()
FormInfo
isHtmlInput
in interface FormInfo
public void setHtmlInput(boolean input)
public java.lang.String getMode()
FormInfo
public void setMode(java.lang.String mode) throws java.lang.IllegalArgumentException
FormInfo
public boolean isPersistent()
FormInfo
isPersistent
in interface FormInfo
public boolean isCorrectMode(java.lang.String mode)
public void addCustomField(TMLFormField field)
public void removeCustomField(java.lang.String fieldname)
public java.util.Map<java.lang.String,TMLFormField> getCustomFields()
public void optimize()
public void addHashedPasswordField(TMLFormField field)
public TMLFormField getHashedPasswordField(java.lang.String fieldname)
public boolean isValidated()
public void setValidated(boolean validated)
public boolean keepOnValidate()
public void setKeepOnValidate(boolean keepOnValidate)
public java.lang.String getTargetContextPath()
public void setTargetContextPath(java.lang.String targetContextPath)
public java.lang.String getDefaultAction()
public void setDefaultAction(java.lang.String defaultAction)
public java.lang.String getContentClass()
FormInfo
getContentClass
in interface FormInfo
public void setContentClass(java.lang.String contentclass)
FormInfo
setContentClass
in interface FormInfo
contentclass
- The content classpublic java.lang.String getDefinitionModule()
public void setDefinitionModule(java.lang.String definitionModule)
public java.lang.String getDefinitionDatabase()
public void setDefinitionDatabase(java.lang.String definitionDatabase)
public java.lang.String getProcessId()
public void setProcessId(java.lang.String processId)
public de.innovationgate.wga.common.beans.csconfig.v1.Version getVersionCompliance()
public boolean isSyncFiles()
public void setSyncFiles(boolean syncFiles)
public void setPersistent(boolean persistent)
public void setDefinition(Design design)
FormInfo
setDefinition
in interface FormInfo
public ScopeObjectRegistry getScopeObjectRegistry()