Package com.tom_roush.pdfbox.pdmodel.interactive.digitalsignature

Class SignatureOptions

java.lang.Object

com.tom_roush.pdfbox.pdmodel.interactive.digitalsignature.SignatureOptions

All Implemented Interfaces:

Closeable, AutoCloseable

public class SignatureOptions
extends Object
implements Closeable

TODO description needed

Constructor Summary

Constructors

Constructor	Description
SignatureOptions()	Creates the default signature options.

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the visual signature COSDocument, if any.
int	getPage()	Get the page number.
int	getPreferedSignatureSize()	Get the preferred size of the signature.
COSDocument	getVisualSignature()	Get the visual signature.
void	setPage(int pageNo)	Set the page number.
void	setPreferedSignatureSize(int size)	Set the preferred size of the signature.
void	setVisualSignature(PDVisibleSigProperties visSignatureProperties)	Reads the visual signature from the given visual signature properties
void	setVisualSignature(File file)	Reads the visual signature from the given file.
void	setVisualSignature(InputStream is)	Reads the visual signature from the given input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureOptions

public SignatureOptions()

Creates the default signature options.

Method Detail

setPage

public void setPage(int pageNo)

Set the page number.

Parameters:

pageNo - the page number

getPage

public int getPage()

Get the page number.

Returns:

the page number

setVisualSignature

public void setVisualSignature(File file)
                        throws IOException

Reads the visual signature from the given file.

Parameters:

file - the file containing the visual signature

Throws:

IOException - when something went wrong during parsing

setVisualSignature

public void setVisualSignature(InputStream is)
                        throws IOException

Reads the visual signature from the given input stream.

Parameters:

is - the input stream containing the visual signature

Throws:

IOException - when something went wrong during parsing

setVisualSignature

public void setVisualSignature(PDVisibleSigProperties visSignatureProperties)
                        throws IOException

Reads the visual signature from the given visual signature properties

Parameters:

visSignatureProperties - the PDVisibleSigProperties object containing the visual signature

Throws:

IOException - when something went wrong during parsing

getVisualSignature

public COSDocument getVisualSignature()

Get the visual signature.

Returns:

the visual signature

getPreferedSignatureSize

public int getPreferedSignatureSize()

Get the preferred size of the signature.

Returns:

the preferred size

setPreferedSignatureSize

public void setPreferedSignatureSize(int size)

Set the preferred size of the signature.

Parameters:

size - the size of the signature

close

public void close()
           throws IOException

Closes the visual signature COSDocument, if any.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if the document could not be closed