public class PDSignatureField extends PDTerminalField
Modifier and Type | Field and Description |
---|---|
private static org.apache.commons.logging.Log |
LOG |
Constructor and Description |
---|
PDSignatureField(PDAcroForm acroForm) |
PDSignatureField(PDAcroForm acroForm,
COSDictionary field,
PDNonTerminalField parent)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
(package private) void |
constructAppearances()
Constructs appearance streams and appearance dictionaries for all widget annotations.
|
private java.lang.String |
generatePartialName()
Generate a unique name for the signature.
|
PDSignature |
getDefaultValue()
Returns the default value, if any.
|
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.
|
PDSignature |
getSignature()
Get the signature dictionary.
|
PDSignature |
getValue()
Returns the signature contained in this field.
|
java.lang.String |
getValueAsString()
Returns a string representation of the "V" entry, or an empty string.
|
void |
setDefaultValue(PDSignature value)
Sets the default value of this field to be the given signature.
|
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.
|
void |
setSignature(PDSignature value)
Deprecated.
Use
setValue(PDSignature) instead. |
void |
setValue(PDSignature value)
Sets the value of this field to be the given signature.
|
void |
setValue(java.lang.String value)
This will throw an UnsupportedOperationException if used as the signature fields value
can't be set using a String
|
applyChange, exportFDF, getFieldFlags, getFieldType, getWidget, getWidgets, importFDF, setActions, setWidgets
findKid, fromDictionary, getAcroForm, getActions, getAlternateFieldName, getCOSObject, getFullyQualifiedName, getInheritableAttribute, getMappingName, getParent, getPartialName, isNoExport, isReadOnly, isRequired, setAlternateFieldName, setFieldFlags, setMappingName, setNoExport, setPartialName, setReadOnly, setRequired, toString
public PDSignatureField(PDAcroForm acroForm) throws java.io.IOException
acroForm
- The acroForm for this field.java.io.IOException
- If there is an error while resolving partial name for the signature field
or getting the widget object.PDTerminalField.PDTerminalField(PDAcroForm)
PDSignatureField(PDAcroForm acroForm, COSDictionary field, PDNonTerminalField parent)
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 createdprivate java.lang.String generatePartialName()
@Deprecated public void setSignature(PDSignature value) throws java.io.IOException
setValue(PDSignature)
instead.value
- is the PDSignatureFieldjava.io.IOException
public PDSignature getSignature()
public void setValue(PDSignature value) throws java.io.IOException
value
- is the PDSignatureFieldjava.io.IOException
public void setValue(java.lang.String value)
public void setDefaultValue(PDSignature value) throws java.io.IOException
value
- is the PDSignatureFieldjava.io.IOException
public PDSignature getValue()
public PDSignature getDefaultValue()
public java.lang.String getValueAsString()
PDField
getValueAsString
in class PDField
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.
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.
sv
- is the seed value dictionary as PDSeedValuevoid constructAppearances() throws java.io.IOException
PDTerminalField
PDTerminalField.applyChange()
.constructAppearances
in class PDTerminalField
java.io.IOException
- if the appearance couldn't be generated