com.ironsoftware.ironpdf.form

Class FormField

java.lang.Object

com.ironsoftware.ironpdf.form.FormField

Direct Known Subclasses:

CheckBoxField, ComboBoxField, TextField

public class FormField
extends Object

Generic base class from which all PDF Form fields are derived.

Constructor Summary

Constructors

Constructor and Description
FormField(int annotationIndex, String name, int pageIndex, FormFieldTypes type, double x, double y, double width, double height, String value, boolean readOnly) (INTERNAL) Please Get ComboBoxField from FormFieldsSet.getUnknownFields() from FormManager.getFields()

Method Summary

Modifier and Type	Method and Description
int	getAnnotationIndex() Gets annotation index.
double	getHeight() Gets form field height.
String	getName() Gets the ID name of this field.
int	getPageIndex() Gets page index.
FormFieldTypes	getType() Gets form field types.
String	getValue() Gets the value of the editable PDF field.
double	getWidth() Gets form field width.
double	getX() Gets form field x position.
double	getY() Gets form field y position.
boolean	isReadOnly() Is read only boolean.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormField

public FormField(int annotationIndex,
                 String name,
                 int pageIndex,
                 FormFieldTypes type,
                 double x,
                 double y,
                 double width,
                 double height,
                 String value,
                 boolean readOnly)

(INTERNAL) Please Get ComboBoxField from FormFieldsSet.getUnknownFields() from FormManager.getFields()

Parameters:

annotationIndex - the annotation index

name - the name

pageIndex - the page index

type - the type

x - the x

y - the y

width - the width

height - the height

value - the value

readOnly - the read only

Method Detail

getAnnotationIndex

public final int getAnnotationIndex()

Gets annotation index. Index of annotation associated with this form field

Returns:

the annotation index

getName

public final String getName()

Gets the ID name of this field.

Returns:

the name

getPageIndex

public final int getPageIndex()

Gets page index. Page index which contains this form field

Returns:

the page index

isReadOnly

public final boolean isReadOnly()

Is read only boolean. The permissions for users to fill-in current form field.

Returns:

the boolean

getType

public final FormFieldTypes getType()

Gets form field types.

Returns:

the type

getValue

public final String getValue()

Gets the value of the editable PDF field.

Returns:

the value

getWidth

public final double getWidth()

Gets form field width.

Returns:

the width

getHeight

public final double getHeight()

Gets form field height.

Returns:

the height

getX

public final double getX()

Gets form field x position.

Returns:

the x

getY

public final double getY()

Gets form field y position.

Returns:

the y