Class PDVisibleSigProperties
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.interactive.digitalsignature.visible.PDVisibleSigProperties
-
public class PDVisibleSigProperties extends java.lang.Object
This builder class is in order to create visible signature properties.
-
-
Field Summary
Fields Modifier and Type Field Description private int
page
private PDVisibleSignDesigner
pdVisibleSignature
private int
preferredSize
private java.lang.String
signatureReason
private java.lang.String
signerLocation
private java.lang.String
signerName
private java.io.InputStream
visibleSignature
private boolean
visualSignEnabled
-
Constructor Summary
Constructors Constructor Description PDVisibleSigProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
buildSignature()
start building of visible signatureint
getPage()
returns your pagePDVisibleSignDesigner
getPdVisibleSignature()
this method gets visible signature configuration objectint
getPreferredSize()
Gets the preferred signature size in bytes.java.lang.String
getSignatureReason()
gets reason of signingjava.lang.String
getSignerLocation()
Gets signer locationsjava.lang.String
getSignerName()
java.io.InputStream
getVisibleSignature()
returns visible signature configuration objectboolean
isVisualSignEnabled()
checks if we need to add visible signaturePDVisibleSigProperties
page(int page)
sets page numberPDVisibleSigProperties
preferredSize(int preferredSize)
Sets the preferred signature size in bytes.PDVisibleSigProperties
setPdVisibleSignature(PDVisibleSignDesigner pdVisibleSignature)
Sets visible signature configuration Objectvoid
setVisibleSignature(java.io.InputStream visibleSignature)
sets configuration object of visible signaturePDVisibleSigProperties
signatureReason(java.lang.String signatureReason)
sets reason of signingPDVisibleSigProperties
signerLocation(java.lang.String signerLocation)
Sets locationPDVisibleSigProperties
signerName(java.lang.String signerName)
Sets signer namePDVisibleSigProperties
visualSignEnabled(boolean visualSignEnabled)
sets visible signature to be added or not
-
-
-
Field Detail
-
signerName
private java.lang.String signerName
-
signerLocation
private java.lang.String signerLocation
-
signatureReason
private java.lang.String signatureReason
-
visualSignEnabled
private boolean visualSignEnabled
-
page
private int page
-
preferredSize
private int preferredSize
-
visibleSignature
private java.io.InputStream visibleSignature
-
pdVisibleSignature
private PDVisibleSignDesigner pdVisibleSignature
-
-
Method Detail
-
buildSignature
public void buildSignature() throws java.io.IOException
start building of visible signature- Throws:
java.io.IOException
- if the output could not be written
-
getSignerName
public java.lang.String getSignerName()
- Returns:
- - signer name
-
signerName
public PDVisibleSigProperties signerName(java.lang.String signerName)
Sets signer name- Parameters:
signerName
-- Returns:
- the visible signature properties.
-
getSignerLocation
public java.lang.String getSignerLocation()
Gets signer locations- Returns:
- - location
-
signerLocation
public PDVisibleSigProperties signerLocation(java.lang.String signerLocation)
Sets location- Parameters:
signerLocation
-- Returns:
- the visible signature properties.
-
getSignatureReason
public java.lang.String getSignatureReason()
gets reason of signing- Returns:
- the signing reason.
-
signatureReason
public PDVisibleSigProperties signatureReason(java.lang.String signatureReason)
sets reason of signing- Parameters:
signatureReason
-- Returns:
- the visible signature properties.
-
getPage
public int getPage()
returns your page- Returns:
- the page number.
-
page
public PDVisibleSigProperties page(int page)
sets page number- Parameters:
page
-- Returns:
- the visible signature properties.
-
getPreferredSize
public int getPreferredSize()
Gets the preferred signature size in bytes.- Returns:
- the signature's preferred size. A return value of 0 means to use default.
-
preferredSize
public PDVisibleSigProperties preferredSize(int preferredSize)
Sets the preferred signature size in bytes.- Parameters:
preferredSize
- The preferred signature size in bytes, or 0 to use default.- Returns:
- the visible signature properties.
-
isVisualSignEnabled
public boolean isVisualSignEnabled()
checks if we need to add visible signature- Returns:
- state if visible signature is needed.
-
visualSignEnabled
public PDVisibleSigProperties visualSignEnabled(boolean visualSignEnabled)
sets visible signature to be added or not- Parameters:
visualSignEnabled
-- Returns:
- the visible signature properties.
-
getPdVisibleSignature
public PDVisibleSignDesigner getPdVisibleSignature()
this method gets visible signature configuration object- Returns:
- the visible signature configuration.
-
setPdVisibleSignature
public PDVisibleSigProperties setPdVisibleSignature(PDVisibleSignDesigner pdVisibleSignature)
Sets visible signature configuration Object- Parameters:
pdVisibleSignature
-- Returns:
- the visible signature properties.
-
getVisibleSignature
public java.io.InputStream getVisibleSignature()
returns visible signature configuration object- Returns:
- the input stream representing the visible signature.
-
setVisibleSignature
public void setVisibleSignature(java.io.InputStream visibleSignature)
sets configuration object of visible signature- Parameters:
visibleSignature
-
-
-