Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField

Modifier and Type	Field and Description
private static final Log	LOG

Access	Constructor and Description
public	PDSignatureField(PDAcroForm The acroForm for this field. acroForm)
pack-priv	PDSignatureField(PDAcroForm The form that this field is part of. acroForm, COSDictionary the PDF object to represent as a field. field, PDNonTerminalField the parent node of the node to be created parent) Constructor.

Method Summary

Modifier and Type	Method and Description
pack-priv void	constructAppearances() Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField.constructAppearances. Constructs appearance streams and appearance dictionaries for all widget annotations.
private String	Returns: the signature's unique name generatePartialName() Generate a unique name for the signature.
public PDSignature	Returns: A signature dictionary. getDefaultValue() Returns the default value, if any.
public PDSeedValue	Returns: the seed value dictionary as PDSeedValue getSeedValue() (Optional; PDF 1.5) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field.
public PDSignature	Returns: the signature dictionary getSignature() Get the signature dictionary.
public PDSignature	Returns: A signature dictionary. getValue() Returns the signature contained in this field.
public String	getValueAsString() Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDField.getValueAsString. Returns a string representation of the "V" entry, or an empty string.
public void	setDefaultValue(PDSignature is the PDSignatureField value) Sets the default value of this field to be the given signature.
public void	setSeedValue(PDSeedValue is the seed value dictionary as PDSeedValue sv) (Optional; PDF 1.) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field.
public void	setValue(PDSignature is the PDSignatureField value) Sets the value of this field to be the given signature.
public void	setValue(String the plain text value. value) Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDField.setValue. This will throw an UnsupportedOperationException if used as the signature fields value can't be set using a String

Inherited from org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField:: applyChange exportFDF getFieldFlags getFieldType getWidgets importFDF setActions setWidgets

Field Detail

LOG	back to summary
private static final Log LOG

Constructor Detail

PDSignatureField	back to summary
public PDSignatureField(PDAcroForm acroForm) Parameters acroForm:PDAcroForm The acroForm for this field. See Also `PDTerminalField#PDTerminalField(PDAcroForm)`

PDSignatureField	back to summary
pack-priv PDSignatureField(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent) Constructor. Parameters acroForm:PDAcroForm The form that this field is part of. field:COSDictionary the PDF object to represent as a field. parent:PDNonTerminalField the parent node of the node to be created

PDSignatureField

back to summary

pack-priv PDSignatureField(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent)

Constructor.

Parameters

acroForm:PDAcroForm: The form that this field is part of.
field:COSDictionary: the PDF object to represent as a field.
parent:PDNonTerminalField: the parent node of the node to be created

Method Detail

constructAppearances back to summary

constructAppearances	back to summary
pack-priv void constructAppearances() throws IOException Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField.constructAppearances. Doc from org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField.constructAppearances. Constructs appearance streams and appearance dictionaries for all widget annotations. Subclasses should not call this method directly but via `applyChange()`. Annotations @Override Exceptions IOException: if the appearance couldn't be generated

pack-priv void constructAppearances() throws IOException

Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField.constructAppearances.

Doc from org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField.constructAppearances.

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

Annotations

@Override

Exceptions

IOException:: if the appearance couldn't be generated

generatePartialName	back to summary
private String generatePartialName() Generate a unique name for the signature. Returns:String the signature's unique name

generatePartialName

back to summary

private String generatePartialName()

Generate a unique name for the signature.

Returns:String: the signature's unique name

getDefaultValue	back to summary
public PDSignature getDefaultValue() Returns the default value, if any. Returns:PDSignature A signature dictionary.

getDefaultValue

back to summary

public PDSignature getDefaultValue()

Returns the default value, if any.

Returns:PDSignature: A signature dictionary.

getSeedValue	back to summary
public PDSeedValue getSeedValue() (Optional; PDF 1.5) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field. Returns:PDSeedValue the seed value dictionary as PDSeedValue

getSeedValue

back to summary

public PDSeedValue getSeedValue()

(Optional; PDF 1.5) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field.

Returns:PDSeedValue: the seed value dictionary as PDSeedValue

getSignature	back to summary
public PDSignature getSignature() Get the signature dictionary. Returns:PDSignature the signature dictionary

getSignature

back to summary

public PDSignature getSignature()

Get the signature dictionary.

Returns:PDSignature: the signature dictionary

getValue	back to summary
public PDSignature getValue() Returns the signature contained in this field. Returns:PDSignature A signature dictionary.

getValue

back to summary

public PDSignature getValue()

Returns the signature contained in this field.

Returns:PDSignature: A signature dictionary.

getValueAsString	back to summary
public String getValueAsString() Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDField.getValueAsString. Doc from org.apache.pdfbox.pdmodel.interactive.form.PDField.getValueAsString. Returns a string representation of the "V" entry, or an empty string. Returns:String The list of widget annotations. Annotations @Override

getValueAsString

back to summary

public String getValueAsString()

Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDField.getValueAsString.

Doc from org.apache.pdfbox.pdmodel.interactive.form.PDField.getValueAsString.

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

Returns:String

The list of widget annotations.

Annotations

@Override

setDefaultValue	back to summary
public void setDefaultValue(PDSignature value) Sets the default value of this field to be the given signature. Parameters value:PDSignature is the PDSignatureField

setDefaultValue

back to summary

public void setDefaultValue(PDSignature value)

Sets the default value of this field to be the given signature.

Parameters

value:PDSignature: is the PDSignatureField

setSeedValue	back to summary
public void setSeedValue(PDSeedValue sv) (Optional; PDF 1.) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field. Parameters sv:PDSeedValue is the seed value dictionary as PDSeedValue

setSeedValue

back to summary

public void setSeedValue(PDSeedValue sv)

(Optional; PDF 1.) A seed value dictionary containing information that constrains the properties of a signature that is applied to the field.

Parameters

sv:PDSeedValue: is the seed value dictionary as PDSeedValue

setValue	back to summary
public void setValue(PDSignature value) throws IOException Sets the value of this field to be the given signature. Parameters value:PDSignature is the PDSignatureField Exceptions IOException: if the new value could not be applied

setValue

back to summary

public void setValue(PDSignature value) throws IOException

Sets the value of this field to be the given signature.

Parameters

value:PDSignature: is the PDSignatureField

Exceptions

IOException:: if the new value could not be applied

setValue	back to summary
public void setValue(String value) Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDField.setValue. This will throw an UnsupportedOperationException if used as the signature fields value can't be set using a String Parameters value:String the plain text value. Annotations @Override Exceptions UnsupportedOperationException: in all cases!

setValue

back to summary

public void setValue(String value)

Implements abstract org.apache.pdfbox.pdmodel.interactive.form.PDField.setValue.

This will throw an UnsupportedOperationException if used as the signature fields value can't be set using a String

Parameters

value:String: the plain text value.

Annotations

@Override

Exceptions

UnsupportedOperationException:: in all cases!

public Class PDSignatureField

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail