FormField

All Known Subinterfaces:

CheckBoxField, ChoiceField, ComboField, ListField, PushButtonField, RadioButtonGroupField, SignatureField, TextField
```
public interface FormField
```
FormField is the abstract class that is being extended by all fields such as CheckBoxField, ChoiceField, ComboField, PushButtonField, RadioButtonGroupField, SignatureField and TextField.

Author:

Qoppa Software

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAltFieldName()` Returns the alternate field name for this field.
`java.lang.String`	`getFieldName()` Returns the name of this field.
`java.lang.String`	`getFieldTypeDesc()` Returns a description of the field type.
`java.lang.String`	`getFullFieldName()` Returns the full name of the fields.
`java.util.Vector`	`getKids()` Gets a list of fields from the kids array.
`java.lang.String`	`getMapFieldName()` Returns this field's mapping name.
`TriggerActions`	`getTriggerActions()` Gets the TriggerActions associated with the field.
`java.lang.String`	`getUserName()` Gets this field's user name.
`java.util.Vector`	`getWidgets()` Gets a list of any widgets associated with this field.
`boolean`	`isEmpty()` Returns true if the field is not filled.
`boolean`	`isNoExport()` Returns the value of the 'No Export' flag.
`boolean`	`isReadOnly()` Returns the value of the 'Read Only' flag.
`boolean`	`isRequired()` Returns the value of the 'Required' flag.
`void`	`reset()` Resets the field to its default value.
`void`	`setAltFieldName(java.lang.String altFieldName)` Sets the alternate field name.
`void`	`setFieldFlags(int fieldFlags)` Sets the field flags.
`void`	`setFieldName(java.lang.String fieldName)` Sets the field name.
`void`	`setHidden(boolean hidden)` Sets the HIDDEN flag.
`void`	`setMapFieldName(java.lang.String mapName)` Sets this field's mapping name.
`void`	`setNoExport(boolean noExport)` Sets the 'No Export' flag.
`void`	`setPrintable(boolean printable)` Sets the PRINTABLE flag for this field.
`void`	`setReadOnly(boolean readOnly)` Sets the value of the 'Read Only' flag.
`void`	`setRequired(boolean required)` Sets the value of the 'Required' flag.
`void`	`setTriggerActions(TriggerActions triggerActions)` Sets the TriggerActions for this field.
`void`	`setUserName(java.lang.String userName)` Sets this field's user name.

- Method Detail
  - getAltFieldName
```
java.lang.String getAltFieldName()
```
    Returns the alternate field name for this field.
    
    Returns:
    
    The alternate field name.
  - getFieldName
```
java.lang.String getFieldName()
```
    Returns the name of this field.
    
    Returns:
    
    The field's name.
  - getFieldTypeDesc
```
java.lang.String getFieldTypeDesc()
```
    Returns a description of the field type. "CheckBox" for CheckBoxField "ComboBox" for ComboBoxField "List" for ListField "PushButton" for PushButtonField "RadioButtonGroup" for RadioButtonGroupField "Signature" for SignatureField "TextField" for TextField
    
    Returns:
    
    A string describing the field type.
  - getFullFieldName
```
java.lang.String getFullFieldName()
```
    Returns the full name of the fields. If the field is hierarchical, the name will include the full path to the top parent. For instance "address.line1"
    
    Returns:
    
    The fully qualified field name.
  - getMapFieldName
```
java.lang.String getMapFieldName()
```
    Returns this field's mapping name.
    
    Returns:
    
    The field's mapping name.
  - getUserName
```
java.lang.String getUserName()
```
    Gets this field's user name.
    
    Returns:
    
    The field's user name.
  - isNoExport
```
boolean isNoExport()
```
    Returns the value of the 'No Export' flag.
    
    Returns:
    
    Value of the 'No Export' flag.
  - isReadOnly
```
boolean isReadOnly()
```
    Returns the value of the 'Read Only' flag.
    
    Returns:
    
    The value of the 'Read Only' flag.
  - isRequired
```
boolean isRequired()
```
    Returns the value of the 'Required' flag.
    
    Returns:
    
    The value of the 'Required' flag.
  - reset
```
void reset()
    throws PDFException
```
    Resets the field to its default value. If there is no default value then the value will be set to null.
    
    Throws:
    
    PDFException
  - setAltFieldName
```
void setAltFieldName(java.lang.String altFieldName)
```
    Sets the alternate field name.
    
    Parameters:
    
    altFieldName - The new alternate field name.
  - setFieldFlags
```
void setFieldFlags(int fieldFlags)
```
    Sets the field flags. The field flags are an or'ed combination of the following values:
    FF_READONLY
    FF_REQUIRED
    FF_NOEXPORT
    
    Parameters:
    
    fieldFlags - The new value for the flags.
  - setFieldName
```
void setFieldName(java.lang.String fieldName)
```
    Sets the field name.
    
    Parameters:
    
    fieldName - The new field name.
  - setMapFieldName
```
void setMapFieldName(java.lang.String mapName)
```
    Sets this field's mapping name.
    
    Parameters:
    
    mapName - The new mapping name.
  - setNoExport
```
void setNoExport(boolean noExport)
```
    Sets the 'No Export' flag. If this flag is set, the field value will not be exported to an external file.
    
    Parameters:
    
    noExport - The new value of the 'No Export' flag.
  - setReadOnly
```
void setReadOnly(boolean readOnly)
```
    Sets the value of the 'Read Only' flag. If this value is set, the fields value may not be changed.
    
    Parameters:
    
    readOnly - The new value of the 'Read Only' flag.
  - setRequired
```
void setRequired(boolean required)
```
    Sets the value of the 'Required' flag. If this flag is set, the value in this field is a required value.
    
    Parameters:
    
    required - The new value of the 'Required' flag.
  - setUserName
```
void setUserName(java.lang.String userName)
```
    Sets this field's user name.
    
    Parameters:
    
    userName - The new user name.
  - setPrintable
```
void setPrintable(boolean printable)
```
    Sets the PRINTABLE flag for this field. A hidden field will not be displayed on the screen and will not print.
    
    Parameters:
    
    printable - the new invisible setting.
  - setHidden
```
void setHidden(boolean hidden)
```
    Sets the HIDDEN flag. A hidden field will not be displayed on the screen and will not print.
    
    Parameters:
    
    hidden - the new hidden setting. True to hide, false to show the field.
  - getWidgets
```
java.util.Vector getWidgets()
```
    Gets a list of any widgets associated with this field. A field can have several widgets (components) that display or interact with its values, so the return value for this method is a Vector. The objects in the Vector are all derived from com.qoppa.pdf.annotations.Widget Note that these widgets are not accessible from jPDFViewerBean.
    
    Returns:
    
    List of widgets for this field.
  - isEmpty
```
boolean isEmpty()
```
    Returns true if the field is not filled. Some fields cannot be empty (Checkboxes, Signatures, Lists, Buttons) and will always return false
  - getKids
```
java.util.Vector getKids()
```
    Gets a list of fields from the kids array.
    
    Returns:
    
    List of child fields.
  - getTriggerActions
```
TriggerActions getTriggerActions()
```
    Gets the TriggerActions associated with the field.
    
    Returns:
    
    TriggerActions
  - setTriggerActions
```
void setTriggerActions(TriggerActions triggerActions)
```
    Sets the TriggerActions for this field.

Interface FormField

Method Summary

Method Detail

getAltFieldName

getFieldName

getFieldTypeDesc

getFullFieldName

getMapFieldName

getUserName

isNoExport

isReadOnly

isRequired

reset

setAltFieldName

setFieldFlags

setFieldName

setMapFieldName

setNoExport

setReadOnly

setRequired

setUserName

setPrintable

setHidden

getWidgets

isEmpty

getKids

getTriggerActions

setTriggerActions