Package de.xima.fc.pdf.form

Interface IPdfAcroField

All Known Subinterfaces:

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

public interface IPdfAcroField

A form field of a PDF AcroForm.

Since:

7.2.0

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IPdfAcroField.Button	An AcroForm button that can be pressed.
static interface	IPdfAcroField.Checkable	A selectable option, either a check box or a radio button.
static interface	IPdfAcroField.CheckBox	An AcroForm form field with a checkbox that can be enabled or disabled.
static interface	IPdfAcroField.Choice	An AcroForm form field for selecting values from a list of options.
static interface	IPdfAcroField.ComboBox	An AcroForm form field for selecting a value from a list of options.
static interface	IPdfAcroField.ListBox	An AcroForm form field for selecting one or more values from a list of options.
static interface	IPdfAcroField.RadioButton	An AcroForm form field with a radio button that can be enabled or disabled.
static interface	IPdfAcroField.Signature	An AcroForm form field for entering a signature.
static interface	IPdfAcroField.Text	An AcroForm free-text form field for entering plain text.

Method Summary

Modifier and Type	Method	Description
String	getFullyQualifiedName()
float	getHeight()
String	getSimpleName()
String	getTitle()
EPdfAcroFormType	getType()
float	getWidth()
float	getX()
float	getY()
int	getZeroBasedPageIndex()
boolean	isHidden()
boolean	isReadOnly()
boolean	isRequired()

Method Details

getFullyQualifiedName

String getFullyQualifiedName()

Returns:

The fully qualified name of the AcroForm field with all parent names included.

getHeight

float getHeight()

Returns:

The height of the form field.

getSimpleName

String getSimpleName()

Returns:

The simple name of the AcroForm field without parent names included.

getTitle

String getTitle()

Returns:

The (non-technical) title of the form field.

getType

EPdfAcroFormType getType()

Returns:

The type of AcroForm field.

getWidth

float getWidth()

Returns:

The width of the form field.

getX

float getX()

Returns:

The x coordinate of the bottom left corner of the form field.

getY

float getY()

Returns:

The y coordinate of the bottom left corner of the form field.

getZeroBasedPageIndex

int getZeroBasedPageIndex()

Returns:

The 0-based index of the page containing this field.

isHidden

boolean isHidden()

Returns:

Whether the element should be displayed.

isReadOnly

boolean isReadOnly()

Returns:

Whether the form field can be edited.

isRequired

boolean isRequired()

Returns:

Whether the field is required.