Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible

public Class PDVisibleSigProperties

extends Object
Class Inheritance
Imports
java.io.IOException, .InputStream
This builder class is in order to create visible signature properties.
Author
Vakhtang Koroghlishvili

Field Summary

Modifier and TypeField and Description
private int
page

private PDVisibleSignDesigner
pdVisibleSignature

private int
preferredSize

private String
signatureReason

private String
signerLocation

private String
signerName

private InputStream
visibleSignature

private boolean
visualSignEnabled

Constructor Summary

AccessConstructor and Description
public
PDVisibleSigProperties()

Method Summary

Modifier and TypeMethod and Description
public void
buildSignature()

start building of visible signature

public int

Returns:

the page number (1-based).
getPage()

returns your page

public PDVisibleSignDesigner

Returns:

the visible signature configuration.
getPdVisibleSignature()

this method gets visible signature configuration object

public int

Returns:

the signature's preferred size. A return value of 0 means to use default.
getPreferredSize()

Gets the preferred signature size in bytes.

public String

Returns:

the signing reason.
getSignatureReason()

gets reason of signing

public String

Returns:

- location
getSignerLocation()

Gets signer location

public String

Returns:

- signer name
getSignerName()

public InputStream

Returns:

the input stream representing the visible signature.
getVisibleSignature()

returns visible signature configuration object

public boolean

Returns:

state if visible signature is needed.
isVisualSignEnabled()

checks if we need to add visible signature

public PDVisibleSigProperties

Returns:

the visible signature properties.
page(int
page the signature should be placed on (1-based)
page)

sets page number

public PDVisibleSigProperties

Returns:

the visible signature properties.
preferredSize(int
The preferred signature size in bytes, or 0 to use default.
preferredSize)

Sets the preferred signature size in bytes.

public PDVisibleSigProperties

Returns:

the visible signature properties.
setPdVisibleSignature(PDVisibleSignDesigner
the new visible signature configuration
pdVisibleSignature)

Sets visible signature configuration Object

public void
setVisibleSignature(InputStream
the stream of the visible signature
visibleSignature)

sets configuration object of visible signature

public PDVisibleSigProperties

Returns:

the visible signature properties.
signatureReason(String
the reason of signing
signatureReason)

sets reason of signing

public PDVisibleSigProperties

Returns:

the visible signature properties.
signerLocation(String
the new signer location
signerLocation)

Sets location

public PDVisibleSigProperties

Returns:

the visible signature properties.
signerName(String
the signer name
signerName)

Sets signer name

public PDVisibleSigProperties

Returns:

the visible signature properties.
visualSignEnabled(boolean
if true the visible signature is added
visualSignEnabled)

sets visible signature to be added or not

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

pageback to summary
private int page
pdVisibleSignatureback to summary
private PDVisibleSignDesigner pdVisibleSignature
preferredSizeback to summary
private int preferredSize
signatureReasonback to summary
private String signatureReason
signerLocationback to summary
private String signerLocation
signerNameback to summary
private String signerName
visibleSignatureback to summary
private InputStream visibleSignature
visualSignEnabledback to summary
private boolean visualSignEnabled

Constructor Detail

PDVisibleSigPropertiesback to summary
public PDVisibleSigProperties()

Method Detail

buildSignatureback to summary
public void buildSignature() throws IOException

start building of visible signature

Exceptions
IOException:
if the output could not be written
getPageback to summary
public int getPage()

returns your page

Returns:int

the page number (1-based).

getPdVisibleSignatureback to summary
public PDVisibleSignDesigner getPdVisibleSignature()

this method gets visible signature configuration object

Returns:PDVisibleSignDesigner

the visible signature configuration.

getPreferredSizeback to summary
public int getPreferredSize()

Gets the preferred signature size in bytes.

Returns:int

the signature's preferred size. A return value of 0 means to use default.

getSignatureReasonback to summary
public String getSignatureReason()

gets reason of signing

Returns:String

the signing reason.

getSignerLocationback to summary
public String getSignerLocation()

Gets signer location

Returns:String

- location

getSignerNameback to summary
public String getSignerName()
Returns:String

- signer name

getVisibleSignatureback to summary
public InputStream getVisibleSignature()

returns visible signature configuration object

Returns:InputStream

the input stream representing the visible signature.

isVisualSignEnabledback to summary
public boolean isVisualSignEnabled()

checks if we need to add visible signature

Returns:boolean

state if visible signature is needed.

pageback to summary
public PDVisibleSigProperties page(int page)

sets page number

Parameters
page:int

page the signature should be placed on (1-based)

Returns:PDVisibleSigProperties

the visible signature properties.

preferredSizeback to summary
public PDVisibleSigProperties preferredSize(int preferredSize)

Sets the preferred signature size in bytes.

Parameters
preferredSize:int

The preferred signature size in bytes, or 0 to use default.

Returns:PDVisibleSigProperties

the visible signature properties.

setPdVisibleSignatureback to summary
public PDVisibleSigProperties setPdVisibleSignature(PDVisibleSignDesigner pdVisibleSignature)

Sets visible signature configuration Object

Parameters
pdVisibleSignature:PDVisibleSignDesigner

the new visible signature configuration

Returns:PDVisibleSigProperties

the visible signature properties.

setVisibleSignatureback to summary
public void setVisibleSignature(InputStream visibleSignature)

sets configuration object of visible signature

Parameters
visibleSignature:InputStream

the stream of the visible signature

signatureReasonback to summary
public PDVisibleSigProperties signatureReason(String signatureReason)

sets reason of signing

Parameters
signatureReason:String

the reason of signing

Returns:PDVisibleSigProperties

the visible signature properties.

signerLocationback to summary
public PDVisibleSigProperties signerLocation(String signerLocation)

Sets location

Parameters
signerLocation:String

the new signer location

Returns:PDVisibleSigProperties

the visible signature properties.

signerNameback to summary
public PDVisibleSigProperties signerName(String signerName)

Sets signer name

Parameters
signerName:String

the signer name

Returns:PDVisibleSigProperties

the visible signature properties.

visualSignEnabledback to summary
public PDVisibleSigProperties visualSignEnabled(boolean visualSignEnabled)

sets visible signature to be added or not

Parameters
visualSignEnabled:boolean

if true the visible signature is added

Returns:PDVisibleSigProperties

the visible signature properties.