Package org.jopensignature.sign

Class SignatureContext

java.lang.Object

org.jopensignature.sign.SignatureContext

public class SignatureContext
extends java.lang.Object

A SignatureContext instance have to accompany a signature request at a Signer due to a call of the method Signer.startSigning(SignatureContext, SignatureListener).

It provides several necessary informations and constraints the Signer instance need to know to provide a successful signing request. The provided constraints are described in the javadoc of the constructor and the getter methods of this class.

Constructor Summary

Constructors

Constructor	Description
SignatureContext(java.io.InputStream is, MetaInfoField[] metaInfos, int pageNumber, Rectangle signRectangle, boolean required)
SignatureContext(javax.imageio.stream.ImageInputStream is, MetaInfoField[] metaInfos, int pageNumber, Rectangle signRectangle, boolean required)	Deprecated. use an inputstream instead of ImageInputStream

Method Summary

Modifier and Type	Method	Description
java.io.InputStream	getDocument()
javax.imageio.stream.ImageInputStream	getDocumentStream()
MetaInfoField[]	getMetaInfoFields()
int	getPageNumber()
java.lang.String	getSignatureIdentifier()
java.awt.Dimension	getSignatureImageSizeHint()	Returns the current signature image size hint.
Rectangle	getSignatureRectangle()
boolean	isAutofitSignature()
boolean	isRequired()
void	setAutofitSignature(boolean autofitSignature)
void	setSignatureIdentifier(java.lang.String signatureIdentifier)
void	setSignatureImageSizeHint(java.awt.Dimension signatureImageSizeHint)	Sets a signature image pixel size hint.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureContext

public SignatureContext(java.io.InputStream is,
                        MetaInfoField[] metaInfos,
                        int pageNumber,
                        Rectangle signRectangle,
                        boolean required)

Parameters:

is -

metaInfos -

pageNumber -

signRectangle -

required -

SignatureContext

@Deprecated
public SignatureContext(javax.imageio.stream.ImageInputStream is,
                        MetaInfoField[] metaInfos,
                        int pageNumber,
                        Rectangle signRectangle,
                        boolean required)

Deprecated.

use an inputstream instead of ImageInputStream

Instantiates a new Signature context.

Parameters:

is - the is

metaInfos - the meta infos

pageNumber - the page number

signRectangle - the sign rectangle

required - the required

Method Detail

getDocument

public java.io.InputStream getDocument()

getDocumentStream

public javax.imageio.stream.ImageInputStream getDocumentStream()

getMetaInfoFields

public MetaInfoField[] getMetaInfoFields()

getPageNumber

public int getPageNumber()

getSignatureRectangle

public Rectangle getSignatureRectangle()

isRequired

public boolean isRequired()

getSignatureIdentifier

public java.lang.String getSignatureIdentifier()

setSignatureIdentifier

public void setSignatureIdentifier(java.lang.String signatureIdentifier)

setAutofitSignature

public void setAutofitSignature(boolean autofitSignature)

isAutofitSignature

public boolean isAutofitSignature()

setSignatureImageSizeHint

public void setSignatureImageSizeHint(java.awt.Dimension signatureImageSizeHint)

Sets a signature image pixel size hint. This value is meant as an image pixel size hint for the Signer when updated signature renderings are produced. The initial value is null, which means that it is up to the Signer implementation to choose any particular image pixel size.

Even if this value has been set, the Signer may choose to ignore it and calculate the image size based on some internal logic.

Parameters:

signatureImageSizeHint - the signature image pixel size hint

getSignatureImageSizeHint

public java.awt.Dimension getSignatureImageSizeHint()

Returns the current signature image size hint. See setSignatureImageSizeHint(Dimension)

Returns:

the current signature image size hint