org.sejda.sambox.pdmodel.interactive.form

Class PDTerminalField

java.lang.Object

org.sejda.sambox.pdmodel.common.PDDictionaryWrapper

org.sejda.sambox.pdmodel.interactive.form.PDField

org.sejda.sambox.pdmodel.interactive.form.PDTerminalField

All Implemented Interfaces:

COSObjectable

Direct Known Subclasses:

PDButton, PDSignatureField, PDVariableText

public abstract class PDTerminalField
extends PDField

A field in an interactive form. Fields may be one of four types: button, text, choice, or signature.

Author:

sug

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PDTerminalField(PDAcroForm acroForm) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addWidgetIfMissing(PDAnnotationWidget widget) Adds the given widget as child of this fields, only if not already present
void	applyChange() Applies a value change to the field.
int	getFieldFlags() This will get the flags for this field.
String	getFieldType() Get the FT entry of the field.
List<PDAnnotationWidget>	getWidgets() Returns the widget annotations associated with this field.
boolean	isTerminal()
void	setActions(PDFormFieldAdditionalActions actions) Set the actions of the field.
void	setWidgets(List<PDAnnotationWidget> children) Sets the field's widget annotations.

Methods inherited from class org.sejda.sambox.pdmodel.interactive.form.PDField

getAcroForm, getActions, getAlternateFieldName, getFullyQualifiedName, getInheritableAttribute, getMappingName, getParent, getPartialName, getValueAsString, isNoExport, isReadonly, isRequired, setAlternateFieldName, setFieldFlags, setMappingName, setNoExport, setPartialName, setReadonly, setRequired, setValue, toString

Methods inherited from class org.sejda.sambox.pdmodel.common.PDDictionaryWrapper

equals, getCOSObject, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PDTerminalField

protected PDTerminalField(PDAcroForm acroForm)

Constructor.

Parameters:

acroForm - The form that this field is part of.

Method Detail

setActions

public void setActions(PDFormFieldAdditionalActions actions)

Set the actions of the field.

Parameters:

actions - The field actions.

getFieldFlags

public int getFieldFlags()

Description copied from class: PDField

This will get the flags for this field.

Specified by:

getFieldFlags in class PDField

Returns:

flags The set of flags.

getFieldType

public String getFieldType()

Description copied from class: PDField

Get the FT entry of the field. This is a read only field and is set depending on the actual type. The field type is an inheritable attribute.

Specified by:

getFieldType in class PDField

Returns:

The Field type.

getWidgets

public List<PDAnnotationWidget> getWidgets()

Returns the widget annotations associated with this field.

Specified by:

getWidgets in class PDField

Returns:

The list of widget annotations.

addWidgetIfMissing

public void addWidgetIfMissing(PDAnnotationWidget widget)

Adds the given widget as child of this fields, only if not already present

Parameters:

widget -

setWidgets

public void setWidgets(List<PDAnnotationWidget> children)

Sets the field's widget annotations.

Parameters:

children - The list of widget annotations.

applyChange

public final void applyChange()
                       throws IOException

Applies a value change to the field. Generates appearances if required and raises events.

Throws:

IOException - if the appearance couldn't be generated

isTerminal

public boolean isTerminal()

Specified by:

isTerminal in class PDField