Form fields
In addition to the graphical components, VDoc offers a whole set of objects named "fields" enabling to quickly develop screens via a XML description. These fields are available to build process documents forms (customization) and screens defined in the screens XML definition file.
Two notes about the description of these fields:
- Shortcuts are available only in the forms customization context.
- The "name" attribute that identifies a screen field is called "property" in the forms customization context.
The most of Java classes displayed in this section respect the same convention. For one Java class named XXXField, there is one Java class named CltXXX (graphical component: widget). A XXXField class is in fact a Clt XXX element linked to a document by an internal events mechanism .
Reminder: In the case of screens defined in the definition file, fields are linked to a GenericDocument-type document. In the case of customization forms, fields are linked to a CoreDocument-type process document.
Some examples of links between a field and a graphical component
| Field |
Graphical component |
| TextBoxField |
CtlTextBox |
| PasswordField |
CtlPassword |
| DateField |
CtlDate |
| DateTimeField |
CtlDateTime |
| PeriodDateField |
CtlPeriodDate |
| PeriodDateTimeField |
CtlPeriodTimeDate |
| CheckBoxField |
CtlCheckBox |
| CheckBoxGroupField |
CtlCheckBoxGroup |
| ComboBoxField |
CtlComboBox |
| RadioGroupField |
CtlGroupField |
| TextAreaFieldField |
CtlTextArea |
See the description of the fields types below : LongField, FloatField, DoubleField, DateField, DateTimeField, TimeField, PeriodDateField, PeriodTimeField, TextBoxField PasswordField, TextAreaField, RadioGroupField, CheckBoxGroupField, CheckBoxField, ComboBoxField, SelectListField, MultipleFileField SingleDirectoryField, MultipleDirectoryField, ScreenEmbedderField, SelectorField, FCKEditorField, EnhancedUrlField
| Name |
LongField |
| Description |
Enables to enter an integer |
| Component |
Com.axemble.vdp.ui.core.document.fields.LongField |
| Shortcut |
long |
| Java type |
java.lang.Long |
| Storage table |
- |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldLong label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.LongField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser size = "medium" "veryshort" "short" "long" "auto" long-value="7" /> |
| Name |
FloatField |
| Description |
Enables to enter a decimal |
| Component |
com.axemble.vdp.ui.core.document.fields.FloatField |
| Shortcut |
float |
| Java type |
java.lang.Float |
| Storage table |
vdp_float_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldFloat label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.FloatField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser size = "medium" "veryshort" "short" "long" "auto" long-value="7.86" /> |
| Name |
DoubleField |
| Description |
Enables to enter a decimal |
| Component |
com.axemble.vdp.ui.core.document.fields.DoubleField |
| Shortcut |
double |
| Java type |
java.lang.Double |
| Storage table |
- |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldDouble label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.DoubleField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser size = "medium" "veryshort" "short" "long" "auto" /> |
| Name |
DateField |
| Description |
Date input field |
| Component |
com.axemble.vdp.ui.core.document.fields.DateField |
| Shortcut |
date |
| Java type |
java.util.Date |
| Storage type |
java.sql.Timestamp |
| Storage table |
vdp_timestamp_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldDate label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.DateField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser /> |
| Name |
DateTimeField |
| Description |
Enables to enter a date with a time |
| Component |
com.axemble.vdp.ui.core.document.DateTimeField |
| Shortcut |
datetime |
| Java type |
java.util.Date |
| Storage type |
java.sql.Timestamp |
| Storage table |
vdp_timestamp_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldDateTime label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.DateTimeField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser hour-format = "24" /> |
| Name |
TimeField |
| Description |
Enables to enter a time |
| Component |
com.axemble.vdp.ui.core.document.TimeField |
| Shortcut |
time |
| Java type |
java.lang.Long |
| Storage type |
java.lang.Long |
| Storage table |
dp_long_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldTime label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.TimeField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser hour-format = "24" /> |
| Name |
PeriodDateField |
| Description |
Enables to enter a period |
| Component |
com.axemble.vdp.ui.core.document.PeriodDateField |
| Shortcut |
dateperiod |
| Java type |
com.axemble.vdp.information.structures.Period |
| Storage type |
com.axemble.vdp.information.structures.Period |
| Storage table |
vdp_period_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldPeriodDate label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.PeriodDateField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser /> |
| Name |
PeriodTimeField |
| Description |
Enables to enter a time slot |
| Component |
com.axemble.vdp.ui.core.document.fields.PeriodTimeField |
| Shortcut |
datetimeperiod |
| Java type |
com.axemble.vdp.information.structures.Period |
| Storage type |
com.axemble.vdp.information.structures.Period |
| Storage table |
vdp_period_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldPeriodTime label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.PeriodTimeField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser /> |
| Name |
TextBoxField |
| Description |
Enables to enter a character string |
| Class |
Com.axemble.vdp.ui.core.document.fields.TextBoxField |
| Shortcut |
text |
| Java type |
java.lang.String |
| Storage table |
vdp_string_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.TextBoxField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser size = "medium" "veryshort" "short" "long" "auto" /> |
| Name |
PasswordField |
| Description |
Enables to enter a password with validation |
| Class |
Com.axemble.vdp.ui.core.document.fields.PasswordField |
| Shortcut |
password |
| Java type |
java.lang.String |
| Storage table |
- |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_PASSWORD ctrl = "com.axemble.vdp.ui.core.document.fields.PasswordField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control change size = "medium" "veryshort" "short" "long" "auto" - set the size authentication-class = "?" - the class used to validate field input (implements com.axemble.vdp.ui.core.document.fields.IDirectoryAuthentication). com.axemble.vdp.ui.core.document.fields.classes.DefaultAuthentication is the default authentication class for both Websphere and Portal environments. /> /> |
| Name |
TextAreaField |
| Description |
Enables to enter a character string on several lines |
| Class |
Com.axemble.vdp.ui.core.document.fields.TextAreaField |
| Shortcut |
text |
| Java type |
java.lang.String |
| Storage table |
vdp_string_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_TEXT ctrl = "com.axemble.vdp.ui.core.document.fields.TextAreaField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser width = "medium" "veryshort" "short" "long" "auto" rows = "?" - number of rows size = "large" – allow to specify a large text area. If size attribute is used, rows and width will not work. /> |
| Name |
RadioGroupField |
| Description |
Enables to select an element contained in a group |
| Class |
Com.axemble.vdp.ui.core.document.fields.RadioGroupField |
| Shortcut |
radiogroup |
| Java type |
java.lang.String |
| Storage table |
- |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.RadioGroupField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes nbofcolumns = "1" "2" "3" ... - number of column used to display the options fillingmode = "vertical" "horizontal" - arrange options (left-right and top-bottom) or (top-bottom and left-right) list-from-list = "?" - name of an alternative property to get the list with property.getList() list-from-value= "?" - name of an alternative property to get the list with property.getValue() allowreset = "true" "false" - display a button to clear the selection, so the user will be able to select null summaryMode = "false" "true" - if true, in reading mode only the selected value are displayed and the list is not requested advance usage for definition.xml: force-get-list = "false" "true" - in reading mode force the getList to take advantage of key label difference. /> |
| Name |
CheckBoxGroupField |
| Description |
Enables to select several elements in a group |
| Class |
Com.axemble.vdp.ui.core.document.fields.CheckBoxGroupField |
| Shortcut |
checkboxgroup |
| Java type |
java.util.Collection |
| Storage table |
vdp_collection_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.CheckBoxGroupField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes nbofcolumns = "1" "2" "3" ... - number of column used to display the options fillingmode = "vertical" "horizontal" - arrange options (left-right and top-bottom) or (top-bottom and left-right) list-from-list = "?" - name of an alternative property to get the list with property.getList() list-from-value= "?" - name of an alternative property to get the list with property.getValue() allowreset = "true" "false" - display a button to clear the selection, so the user will be able to select null summaryMode = "false" "true" - if true, in reading mode only the selected value are displayed and the list is not requested advance usage for definition.xml: force-get-list = "false" "true" - in reading mode force the getList to take advantage of key label difference. /> |
| Name |
CheckBoxField |
| Description |
Enables to select an element |
| Class |
Com.axemble.vdp.ui.core.document.fields.CheckBoxField |
| Shortcut |
checkbox |
| Java type |
java.lang.Long |
| Storage table |
vdp_long_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.CheckBoxField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser /> |
| Name |
ComboBoxField |
| Description |
Enables to select an element |
| Class |
Com.axemble.vdp.ui.core.document.fields.ComboBoxField |
| Shortcut |
text |
| Java type |
java.lang.String |
| Storage table |
vdp_string_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.ComboBoxField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes nbofcolumns = "1" "2" "3" ... - number of column used to display the options fillingmode = "vertical" "horizontal" - arrange options (left-right and top-bottom) or (top-bottom and left-right) list-from-list = "?" - name of an alternative property to get the list with property.getList() list-from-value= "?" - name of an alternative property to get the list with property.getValue() allowreset = "true" "false" - if (getValue()!=null && allowreset==false ) the first null value will not be present, so the user will not be able to select null. advance usage for definition.xml: force-get-list = "false" "true" - in reading mode force the getList to take advantage of key label difference. /> |
| Name |
SelectListField |
| Description |
Enables to select several elements in a list |
| Class |
Com.axemble.vdp.ui.core.document.fields.SelectListField |
| Shortcut |
textselectlistmultiple |
| Java type |
java.util.Collection |
| Storage table |
vdp_collection_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldSelectList label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.SelectListField mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes list-from-list = "?" - name of an alternative property to get the list with property.getList() list-from-value= "?" - name of an alternative property to get the list with property.getValue() advance usage for definition.xml: force-get-list = "false" "true" - in reading mode force the getList to take advantage of key label difference. /> |
| Name |
MultipleFileField |
| Description |
Enables to add attachments |
| Class |
Com.axemble.vdp.ui.core.document.fields.MultipleFileField |
| Shortcut |
file_multiple |
| Java type |
java.util.Collection |
| Storage table |
vdp_collection_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.MultipleFileField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes min-file-number = ? default 0 max-file-number = ? default Integer.MAX_VALUE min-file-size = ? default 0 max-file-size = ? default read the max file size in the Organization configuration or 2 Go min-total-size = ? default 0 max-total-size = ? default Long.MAX_VALUE max-file-name-length = ? default 250 supported-extensions = ? default read in the Organization configuration "*" mean all extensions ".txt;.xml;.doc" mean accept only .txt .xml .doc /> |
| Name |
SingleDirectoryField |
| Description |
Enables to select an element in the directory |
| Class |
Com.axemble.vdp.ui.core.document.fields.SingleDirectoryField |
| Shortcut |
ser_browser, group_browser, localization_browser, organization_browser. If the shortcut is used, the type attribute won't be necessary. |
| Java type |
com.axemble.vdp.information.structures.DirectoryElement |
| Storage table |
vdp_directory_element_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.SingleDirectoryField mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes /> Example for a selector of FileCenter elements <field> name="fldFilecenter" label="SingleFilecenter" type="filecenter" ctrl="com.axemble.vdp.ui.core.document.fields.SingleDirectoryField" /> |
| Name |
MultipleDirectoryField |
| Description |
Enables to select several elements in the directory |
| Class |
Com.axemble.vdp.ui.core.document.fields.MultipleDirectoryField |
| Shortcut |
user_browser_multiple, group_browser_multiple, localization_browser_multiple, organization_browser_multiple |
| Java type |
java.util.Collection |
| Storage table |
vdp_collection_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMultipleDirectory label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.SingleDirectoryField mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes /> |
| Name |
ScreenEmbedderField |
| Description |
Enables to embed new screens |
| Class |
Com.axemble.vdp.ui.core.document.fields.ScreenEmbedderField |
| Shortcut |
screen_embedder |
| Java type |
java.util.Map |
| Storage table |
vdp_byte_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.ScreenEmbedderField mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes screen = "?" - name of the screen method = "?" - name of the method shared-document-key = "?" – key of the shared document entry shared-field-key = "?" – key of the shared field entry /> |
| Name |
SelectorField |
| Description |
Enables to bring a single or multiple selector |
| Class |
Com.axemble.vdp.ui.core.document.fields.SelectorField |
| Shortcut |
screen_embedder |
| Java type |
java.lang.String (simple) ou java.util.Collection (multiple) |
| Storage table |
vdp_string_values or vdp_collection_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.SelectorField mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes screen = "?" - name of the screen method = "?" - name of the method /> |
| Name |
FCKEditorField |
| Description |
Enables to enter text in the WYSIWYG editor (FCK Editor) |
| Class |
Com.axemble.vdp.ui.core.document.fields.FCKEditorField |
| Shortcut |
fckeditor |
| Java type |
Byte[] |
| Storage table |
vdp_byte_values |
| Using format |
<field name = "?" - name of the IAbstractField, ex: fldFCKEditor label = "?" - label of the control, ex: LG_MODE ctrl = "com.axemble.vdp.ui.core.document.fields.FCKEditorField" mode = "write" "read" - set editable or not mandatory = "false" "true" - set mandatory or not throw-events = "false" "true" - throw events from the webbrowser when the control changes /> |
| Name |
EnhancedUrlField |
| Description |
Enables to display a URL field |
| Class |
Com.axemble.vdp.ui.core.document.fields.EnhancedUrlField |
| Shortcut |
- |
| Java type |
java.lang.String (ei. url¤title¤params) |
| Storage table |
vdp_string_values |
| Using format |
The value of such a field is a concatenation of three or four text values: url¤title¤params(¤description). The separator character is ‘¤’. <field name = "?" - name of the IAbstractField, ex: fldMode label = "?" - label of the control, ex: LG_MODE ctrl = " com.axemble.vdoc.sdk.document.fields.EnhancedUrlField" mode = "write" mandatory = "false" throw-events = "false" title = "?" - set the field title params = "width, height, resizable, scrollbars, status, toolbar" ("0" show-url = "false" show-title = "false" show-description = "false" show-params = "false" /> |
