Package com.ebasetech.xi.api
Interface WebFormFieldOrColumn
- All Known Subinterfaces:
WebFormField
,WebFormTableColumn
public interface WebFormFieldOrColumn
The
WebFormFieldOrColumn
interface represents behaviour shared by both a web form field
and a web table column
including:
- list behaviour
- get/set methods for displayable texts
- access to display length properties
- Since:
- V4.4
-
Method Summary
Modifier and Type Method Description CustomList
createCustomList()
Creates and returns an empty list and associates the list with the form field.CustomList
createCustomList(java.lang.String[] entries)
Creates a list for the field and adds the passed entries.int
getDisplayLength()
Returns the size of the input box used for the form field when it is editable.java.lang.String
getDisplayType()
Returns the field's display type.Text
getHelpText()
Returns the helpText
for the form field for the current language.Text
getLabelText()
Returns the labelText
for the form field for the current language.FieldList
getList()
Returns the list associated with the form field or null if no list exists.int
getMaxDisplayLength()
Returns the maximum number of characters that can be entered by the user for the form field.boolean
isClientAccessible()
Returns true if the form field or table column is accessible via the client api, otherwise returns false.
-
Method Details
-
getList
FieldList getList()Returns the list associated with the form field or null if no list exists. The list can be one of three types:Dynamic List
- values are retrieved from a databaseStatic List
- supports multiple languages, values are defined using the Ebase Xi DesignerCustom List
- the list is created programmatically using thecreateCustomList()
method
- Returns:
- the list associated with the field, if any
- Since:
- V4.4
-
createCustomList
CustomList createCustomList()Creates and returns an empty list and associates the list with the form field. List entries can then be added to the list.Javascript example:
var list = fields.LIST_FIELD.createCustomList(); list.add("Line 1", 1); list.add("Line 2", 2); list.add("Line 3", 3);
- Returns:
- an empty custom list connected to the form field
- Since:
- V4.4
-
createCustomList
Creates a list for the field and adds the passed entries. The created custom list object is returned.Javascript example:
var list = fields.LIST_FIELD.createCustomList(["Line 1", "Line 2", "Line 3"]);
- Returns:
- custom list
- Since:
- V4.4
-
getLabelText
Text getLabelText()Returns the labelText
for the form field for the current language.- Returns:
- label text
- Since:
- V4.4
-
getHelpText
Text getHelpText()Returns the helpText
for the form field for the current language.- Returns:
- help text
- Since:
- V4.4
-
getDisplayLength
int getDisplayLength()Returns the size of the input box used for the form field when it is editable. This will be the value configured using the Display Length field property.- Returns:
- configured display length
- Since:
- V4.4
-
getMaxDisplayLength
int getMaxDisplayLength()Returns the maximum number of characters that can be entered by the user for the form field. This will be the value configured using the Max. length field validator.- Returns:
- configured maximum enterable length
- Since:
- V4.4
-
getDisplayType
java.lang.String getDisplayType()Returns the field's display type. Display type will be one of the following:Basic Types:
- CHECKBOX
- LABEL
- PASSWORD
- RADIO
- SELECT
- TEXT
- TEXTAREA
HTML5 Types:
- COLOR
- DATE
- DATETIME-LOCAL
- MONTH
- NUMBER
- RANGE
- SEARCH
- TEL
- TIME
- URL
- WEEK
- Returns:
- display type
- Since:
- V4.5.1
-
isClientAccessible
boolean isClientAccessible()Returns true if the form field or table column is accessible via the client api, otherwise returns false.- Since:
- V5.0
-