FormField (HCL Domino API 1.0.27-SNAPSHOT API)

```
public interface FormField
```
Information read for a field in the database design

Author:

Karsten Lehmann

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Optional<ItemDataType>`	`getDataType()` Returns the field data type
`Optional<String>`	`getDefaultValueFormula()` Returns the decompiled default value formula or an empty value if not present
`String`	`getDescription()` Returns the content of "Help description" in the field properties
`String`	`getHtmlClassName()` Returns the HTML class name
`String`	`getHtmlExtraAttr()` Returns additional HTML attributes
`String`	`getHtmlId()` Returns the HTML element id
`String`	`getHtmlName()` Returns the HTML field name attribute
`String`	`getHtmlStyle()` Returns the HTML style attribute string
`String`	`getHtmlTitle()` Returns the HTML element title
`Optional<String>`	`getInputTranslationFormula()` Returns the decompiled default input translation formula or an empty value if not present
`Optional<String>`	`getInputValidityCheckFormula()` Returns the decompiled input validation formula or an empty value if not present
`Optional<String>`	`getKeywordFormula()` If the field is a textlist computed by a formula, this method returns the formula
`FieldListDisplayDelimiter`	`getListDispayDelimiter()` Returns the delimiter used when displaying multiple values.
`Set<FieldListDelimiter>`	`getListInputDelimiters()` Returns the selected delimiters for multiple values when the user enters.
`String`	`getName()` Returns the name if the field
`Optional<List<String>>`	`getTextListValues()` If the field is a static textlist, this method returns the text list values

- Method Detail
  - getDataType
```
Optional<ItemDataType> getDataType()
```
    Returns the field data type
    
    Returns:
    
    an Optional describing the data type, e.g. ItemDataType.TYPE_TEXT, or an empty one if not in ItemDataType.values() (unlikely)
  - getDefaultValueFormula
```
Optional<String> getDefaultValueFormula()
```
    Returns the decompiled default value formula or an empty value if not present
    
    Returns:
    
    formula
  - getInputTranslationFormula
```
Optional<String> getInputTranslationFormula()
```
    Returns the decompiled default input translation formula or an empty value if not present
    
    Returns:
    
    formula
  - getInputValidityCheckFormula
```
Optional<String> getInputValidityCheckFormula()
```
    Returns the decompiled input validation formula or an empty value if not present
    
    Returns:
    
    formula
  - getName
```
String getName()
```
    Returns the name if the field
    
    Returns:
    
    name
  - getDescription
```
String getDescription()
```
    Returns the content of "Help description" in the field properties
    
    Returns:
    
    description
  - getTextListValues
```
Optional<List<String>> getTextListValues()
```
    If the field is a static textlist, this method returns the text list values
    
    Returns:
    
    an Optional describing the text list values, or an empty one if that does not apply
  - getKeywordFormula
```
Optional<String> getKeywordFormula()
```
    If the field is a textlist computed by a formula, this method returns the formula
    
    Returns:
    
    formula or an empty value if not set
  - getHtmlId
```
String getHtmlId()
```
    Returns the HTML element id
    
    Returns:
    
    id or empty string
  - getHtmlClassName
```
String getHtmlClassName()
```
    Returns the HTML class name
    
    Returns:
    
    class name or empty string
  - getHtmlStyle
```
String getHtmlStyle()
```
    Returns the HTML style attribute string
    
    Returns:
    
    styles or empty string
  - getHtmlTitle
```
String getHtmlTitle()
```
    Returns the HTML element title
    
    Returns:
    
    title or empty string
  - getHtmlExtraAttr
```
String getHtmlExtraAttr()
```
    Returns additional HTML attributes
    
    Returns:
    
    attribute string or empty string
  - getHtmlName
```
String getHtmlName()
```
    Returns the HTML field name attribute
    
    Returns:
    
    name or empty string
  - getListInputDelimiters
```
Set<FieldListDelimiter> getListInputDelimiters()
```
    Returns the selected delimiters for multiple values when the user enters.
    
    Returns:
    
    a Set of FieldListDelimiter values
  - getListDispayDelimiter
```
FieldListDisplayDelimiter getListDispayDelimiter()
```
    Returns the delimiter used when displaying multiple values.
    
    Returns:
    
    the FieldListDisplayDelimiter for this field

Interface FormField

Method Summary

Method Detail

getDataType

getDefaultValueFormula

getInputTranslationFormula

getInputValidityCheckFormula

getName

getDescription

getTextListValues

getKeywordFormula

getHtmlId

getHtmlClassName

getHtmlStyle

getHtmlTitle

getHtmlExtraAttr

getHtmlName

getListInputDelimiters

getListDispayDelimiter