Module org.sejda.sambox

Package org.sejda.sambox.pdmodel.interactive.form

Class PDSignatureField

java.lang.Object

org.sejda.sambox.pdmodel.common.PDDictionaryWrapper

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

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

org.sejda.sambox.pdmodel.interactive.form.PDSignatureField

All Implemented Interfaces:

COSObjectable

public class PDSignatureField
extends PDTerminalField

A signature field is a form field that contains a digital signature.

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
PDSignatureField(PDAcroForm acroForm)
PDSignatureField(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent)	Constructor.

Method Summary

Modifier and Type	Method	Description
(package private) void	constructAppearances()	Constructs appearance streams and appearance dictionaries for all widget annotations.
String	getValueAsString()	Returns a string representation of the "V" entry, or an empty string.
void	setValue(String value)	Sets the value of this field.

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

addWidgetIfMissing, applyChange, getFieldFlags, getFieldType, getWidgets, isTerminal, removeWidget, setActions, setWidgets

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

findKid, fromDictionary, getAcroForm, getActions, getAlternateFieldName, getFullyQualifiedName, getInheritableAttribute, getMappingName, getParent, getPartialName, isNoExport, isReadonly, isRequired, setAlternateFieldName, setFieldFlags, setMappingName, setNoExport, setPartialName, setReadonly, setRequired, 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

Field Details

LOG

private static final org.slf4j.Logger LOG

Constructor Details

PDSignatureField

public PDSignatureField(PDAcroForm acroForm)

Parameters:

acroForm - The acroForm for this field.

Throws:

IOException - If there is an error while resolving partial name for the signature field or getting the widget object.

See Also:

• PDTerminalField(PDAcroForm)

PDSignatureField

PDSignatureField(PDAcroForm acroForm,
 COSDictionary field,
 PDNonTerminalField parent)

Constructor.

Parameters:

acroForm - The form that this field is part of.

field - the PDF object to represent as a field.

parent - the parent node of the node to be created

Method Details

getValueAsString

public String getValueAsString()

Description copied from class: PDField

Returns a string representation of the "V" entry, or an empty string.

Specified by:

getValueAsString in class PDField

Returns:

A non-null string.

constructAppearances

void constructAppearances()

Description copied from class: PDTerminalField

Constructs appearance streams and appearance dictionaries for all widget annotations. Subclasses should not call this method directly but via PDTerminalField.applyChange().

Specified by:

constructAppearances in class PDTerminalField

setValue

public void setValue(String value)
              throws UnsupportedOperationException

Sets the value of this field. This will throw an UnsupportedOperationException if used as the signature fields value can't be set using a String</>

Specified by:

setValue in class PDField

Parameters:

value - the plain text value.

Throws:

UnsupportedOperationException - in all cases!