com.snowtide.pdf.forms

Class AcroTextField

java.lang.Object

com.snowtide.pdf.forms.AcroTextField

All Implemented Interfaces:

DocumentLocation, AcroFormField, FormField, Bounded

public class AcroTextField
extends java.lang.Object

Represents a text field in an interactive AcroForm.

Text fields can either be plain or 'rich'. Plain text fields return false from AcroTextField.hasRichTextValue(), and their getValue() function will return a simple String object. Rich text fields return true from AcroTextField.hasRichTextValue(), and their getValue() function will return an XHTML rich text string, as specified in Section 8.6.2 of the PDF document specification.

Version:

©2004-2014 Snowtide

Field Summary

Fields inherited from interface com.snowtide.pdf.forms.AcroFormField

FIELD_TYPE_BUTTON, FIELD_TYPE_CHOICE, FIELD_TYPE_OTHER, FIELD_TYPE_SIGNATURE, FIELD_TYPE_TEXT

Method Summary

Modifier and Type	Method and Description
boolean	canChangeValue() This function always returns true.
int	getMaxLength() Returns the maximum length of this field, as specified by this form field's /MaxLen entry.
java.lang.String	getRichTextValue() Returns the 'rich text' value for this field (XHTML that conforms to the XFA specification), if available.
boolean	hasRichTextValue() Returns true only if the value of this field is 'rich text' (XHTML that conforms to the XFA specification), which may be retrieved via the AcroTextField.getRichTextValue() function.
boolean	isFileSelection() Returns true if this is field is designated to hold the path of a user-selected file.
boolean	isMultiline() Returns true if this is a multiline text field.
boolean	isPasswordEntry() Returns true if this is a password-entry text field.
boolean	setValue(java.lang.String val) Sets the value of this text field.

Methods inherited from interface com.snowtide.pdf.forms.AcroFormField

getDefaultValue, getFullName, getLocalName, getMappingName, getType, getUIName, getValue, hasValueChanged, isReadOnly

Methods inherited from interface com.snowtide.pdf.forms.FormField

getName

Methods inherited from interface com.snowtide.pdf.DocumentLocation

pageNumber

Methods inherited from interface com.snowtide.pdf.layout.Bounded

bounds

Method Detail

setValue

public boolean setValue(java.lang.String val)

Sets the value of this text field. The provided String must not be null; otherwise, this function will throw an IllegalArgumentException. This function returns true only if the provided String value is different than the current value of the field.

Specified by:

setValue in interface AcroFormField

canChangeValue

public boolean canChangeValue()

This function always returns true.

Specified by:

canChangeValue in interface AcroFormField

getMaxLength

public int getMaxLength()

Returns the maximum length of this field, as specified by this form field's /MaxLen entry. This function will return -1 if the maximum length is undefined.

getRichTextValue

public java.lang.String getRichTextValue()

Returns the 'rich text' value for this field (XHTML that conforms to the XFA specification), if available. If this field does not contain a rich text value, then the field's value is available via the AcroFormField.getValue() function.

See Also:

AcroTextField.hasRichTextValue()

isMultiline

public boolean isMultiline()

Returns true if this is a multiline text field.

isPasswordEntry

public boolean isPasswordEntry()

Returns true if this is a password-entry text field.

isFileSelection

public boolean isFileSelection()

Returns true if this is field is designated to hold the path of a user-selected file.

hasRichTextValue

public boolean hasRichTextValue()

Returns true only if the value of this field is 'rich text' (XHTML that conforms to the XFA specification), which may be retrieved via the AcroTextField.getRichTextValue() function. If this function returns false, then the field's value is available via AcroFormField.getValue().

See Also:

AcroTextField.getRichTextValue()