Package de.xima.fc.pdf.form

Interface IPdfAcroField.Text

All Superinterfaces:

IPdfAcroField

Enclosing interface:

IPdfAcroField

public static interface IPdfAcroField.Text
extends IPdfAcroField

An AcroForm free-text form field for entering plain text.

Since:

7.2.0

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested classes/interfaces inherited from interface de.xima.fc.pdf.form.IPdfAcroField

IPdfAcroField.Button, IPdfAcroField.Checkable, IPdfAcroField.CheckBox, IPdfAcroField.Choice, IPdfAcroField.ComboBox, IPdfAcroField.ListBox, IPdfAcroField.RadioButton, IPdfAcroField.Signature, IPdfAcroField.Text

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()
int	getMaxLength()
default EPdfAcroFormType	getType()
boolean	isFileSelect()
boolean	isMultiline()
boolean	isObfuscated()

Methods inherited from interface de.xima.fc.pdf.form.IPdfAcroField

getFullyQualifiedName, getHeight, getSimpleName, getTitle, getWidth, getX, getY, getZeroBasedPageIndex, isHidden, isReadOnly, isRequired

Method Details

getDefaultValue

String getDefaultValue()

Returns:

Default value for the field when none is set.

getMaxLength

int getMaxLength()

Returns:

The maximum size of the input's value. -1 when no max length is available.

getType

default EPdfAcroFormType getType()

Specified by:

getType in interface IPdfAcroField

Returns:

The type of AcroForm field.

isFileSelect

boolean isFileSelect()

Returns:

Whether the input allows the user to select a file.

isMultiline

boolean isMultiline()

Returns:

Whether the input field is multi-line (=HTML text area)

isObfuscated

boolean isObfuscated()

Returns:

Whether the entered text should be obfuscated when displayed, usually used for password inputs.