com.snowtide.pdf.forms
Interface FormField

All Known Subinterfaces:

AcroFormField

All Known Implementing Classes:

com.snowtide.pdf.forms.BaseAcroFormField

public interface FormField

Base interface for objects representing fields within a Form.

Version:

©2004-2008 Snowtide Informatics Systems, Inc.

Method Summary

java.lang.String	getName() Returns the canonical name of this field.
java.lang.String	getUIName() Returns a user-friendly name for this field, typically used to identify the field to users or in extracts of form data.
java.lang.Object	getValue() Returns the current value of the field.

Method Detail

getName

public java.lang.String getName()

Returns the canonical name of this field. Only one FormField instance with a particular name should be available from a Form instance.

getUIName

public java.lang.String getUIName()

Returns a user-friendly name for this field, typically used to identify the field to users or in extracts of form data. This function may return null if a particular FormField does not specify a user-friendly name, or if a particular FormField implementation does not support the specification of a user-friendly name. In the latter case, the field's name is always available via getName().

getValue

public java.lang.Object getValue()

Returns the current value of the field. The type of the return value is dependant upon the type of this field, but is almost always a String.