com.aspose.pdf

Class SignatureField

java.lang.Object

com.aspose.pdf.BaseParagraph

com.aspose.pdf.Annotation

com.aspose.pdf.WidgetAnnotation

com.aspose.pdf.Field

com.aspose.pdf.SignatureField

All Implemented Interfaces:

com.aspose.ms.System.Collections.ICollection, com.aspose.ms.System.Collections.IEnumerable, com.aspose.ms.System.ICloneable, Cloneable, Iterable

public final class SignatureField
extends Field

Represents signature form field.

Field Summary

Fields inherited from class com.aspose.pdf.Field

_FileSelect, _Password

Fields inherited from class com.aspose.pdf.Annotation

_disableUpdateAppearance

Constructor Summary

Constructors

Constructor and Description
SignatureField(IDocument doc, Rectangle rect) Initializes new instance of the SignatureField class.
SignatureField(Page page, Rectangle rect) Initializes new instance of the SignatureField class.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes signature object from field.
InputStream	extractCertificate() Extracts the single X.509 certificate in DER format as a stream.
InputStream	extractImage() Extracts signature's image.
Signature	getSignature() Gets signature object.
void	sign(Signature signature) Sign the document using this signature field.
void	sign(Signature signature, InputStream pfx, String pass) Signs the document using this signature field.

Methods inherited from class com.aspose.pdf.Field

copyTo, flatten, get_Item, get_Item, getAlternateName, getAnnotationIndex, getMappingName, getMaxFontSize, getPageIndex, getPartialName, getRect, getSyncRoot, getTabOrder, getValue, isFitIntoRectangle, isGroup, isSharedField, isSynchronized, iterator, recalculate, setAlternateName, setAnnotationIndex, setFitIntoRectangle, setMappingName, setMaxFontSize, setPartialName, setPosition, setRect, setSharedField, setTabOrder, setValue, size, updateAppearances

Methods inherited from class com.aspose.pdf.WidgetAnnotation

accept, getActions, getAnnotationType, getDefaultAppearance, getExportable, getHighlighting, getOnActivated, getParent, getReadOnly, getRequired, setDefaultAppearance, setExportable, setHighlighting, setOnActivated, setReadOnly, setRequired

Methods inherited from class com.aspose.pdf.Annotation

createAnnotation, getActiveState, getAlignment, getAppearance, getBorder, getCharacteristics, getColor, getContents, getEngineDict, getEngineObj, getFlags, getFullName, getHeight, getHorizontalAlignment_Annotation_New, getModified, getModifiedInternal, getName, getNormalAppearance, getPageIndex, getRectangle, getStates, getWidth, initialize, isUpdateAppearanceOnConvert, isUseFontSubset, setActiveState, setAlignment, setBorder, setColor, setContents, setFlags, setHeight, setHorizontalAlignment_Annotation_New, setModified, setModifiedInternal, setName, setUpdateAppearanceOnConvert, setUseFontSubset, setWidth

Methods inherited from class com.aspose.pdf.BaseParagraph

deepClone, getHorizontalAlignment, getHyperlink, getMargin, getZIndex, isFirstParagraphInColumn, isInLineParagraph, isInNewPage, isKeptWithNext, setFirstParagraphInColumn, setHorizontalAlignment, setHyperlink, setInLineParagraph, setInNewPage, setKeptWithNext, setMargin, setVerticalAlignment, setZIndex

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureField

public SignatureField(Page page,
              Rectangle rect)

Initializes new instance of the SignatureField class.

Parameters:

page - Page where signature field should be placed.

rect - Position and size of signature field.

SignatureField

public SignatureField(IDocument doc,
              Rectangle rect)

Initializes new instance of the SignatureField class.

Parameters:

doc - Page where signature field should be placed.

rect - Position and size of signature field.

Method Detail

getSignature

public Signature getSignature()

Gets signature object. This object contains signature data regarding public-key cryptographic standards. Classes PKCS1, PKCS7 and PKCS7Detached represent all supported types of signature objects.

Returns:

Signature object

sign

public void sign(Signature signature,
        InputStream pfx,
        String pass)

Signs the document using this signature field.

Parameters:

signature - Signature object, see PKCS1, PKCS7, PKCS7Detached.

pfx - Stream with certificate.

pass - Password to access private in the pfx.

sign

public void sign(Signature signature)

Sign the document using this signature field.

Parameters:

signature - Signature object, see PKCS1, PKCS7 and PKCS7Detached.

clear

public void clear()

Removes signature object from field.

extractImage

public InputStream extractImage()

Extracts signature's image.

Returns:

If image was successfully found than returns stream object; otherwise, null.

extractCertificate

public InputStream extractCertificate()

Extracts the single X.509 certificate in DER format as a stream.

Returns:

If certificate was found returns X.509 single certificate; otherwise, null.