Package eu.europa.esig.dss.pades

Class SignatureImageTextParameters

java.lang.Object

eu.europa.esig.dss.pades.SignatureImageTextParameters

public class SignatureImageTextParameters
extends Object

This class allows to custom text generation in the PAdES visible signature

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SignatureImageTextParameters.SignerTextHorizontalAlignment	Enum to define the more line text horizontal alignment
static class	SignatureImageTextParameters.SignerTextPosition	Enum to define where to add a signer text inside a signature field relatively to an image
static class	SignatureImageTextParameters.SignerTextVerticalAlignment	Enum to define image from text vertical alignment in connection with the image

Constructor Summary

Constructors

Constructor	Description
SignatureImageTextParameters()

Method Summary

Modifier and Type	Method	Description
Color	getBackgroundColor()	Returns background color for the text's area
DSSFont	getFont()	Returns specified text font
float	getPadding()	Returns padding between text and its area
SignatureImageTextParameters.SignerTextHorizontalAlignment	getSignerTextHorizontalAlignment()	Returns a signer text horizontal alignment value
SignatureImageTextParameters.SignerTextPosition	getSignerTextPosition()	Returns a signer text position respectively to an image
SignatureImageTextParameters.SignerTextVerticalAlignment	getSignerTextVerticalAlignment()	Returns a signer text vertical alignment value
String	getText()	Returns defines text content
Color	getTextColor()	Returns text color parameter
void	setBackgroundColor(Color backgroundColor)	Sets the provided background color for a test's area
void	setFont(DSSFont dssFont)	Sets a text font
void	setPadding(float padding)	Sets a padding between text and its area
void	setSignerTextHorizontalAlignment(SignatureImageTextParameters.SignerTextHorizontalAlignment signerTextHorizontalAlignment)	Allows a horizontal alignment of a text with respect to its area
void	setSignerTextPosition(SignatureImageTextParameters.SignerTextPosition signerTextPosition)	Specifies a text position respectively to an image inside the signature field area
void	setSignerTextVerticalAlignment(SignatureImageTextParameters.SignerTextVerticalAlignment signerTextVerticalAlignment)	Defines a vertical alignment (positioning) of signer text inside the signature field
void	setSize(int size)	Sets a size for a text.
void	setText(String text)	Sets a text content parameter
void	setTextColor(Color textColor)	Sets color for the text

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureImageTextParameters

public SignatureImageTextParameters()

Method Detail

getSignerTextPosition

public SignatureImageTextParameters.SignerTextPosition getSignerTextPosition()

Returns a signer text position respectively to an image

Returns:

SignatureImageTextParameters.SignerTextPosition

setSignerTextPosition

public void setSignerTextPosition(SignatureImageTextParameters.SignerTextPosition signerTextPosition)

Specifies a text position respectively to an image inside the signature field area

Parameters:

signerTextPosition - SignatureImageTextParameters.SignerTextPosition (TOP, BOTTOM, RIGHT, LEFT)

getSignerTextVerticalAlignment

public SignatureImageTextParameters.SignerTextVerticalAlignment getSignerTextVerticalAlignment()

Returns a signer text vertical alignment value

Returns:

SignatureImageTextParameters.SignerTextVerticalAlignment

setSignerTextVerticalAlignment

public void setSignerTextVerticalAlignment(SignatureImageTextParameters.SignerTextVerticalAlignment signerTextVerticalAlignment)

Defines a vertical alignment (positioning) of signer text inside the signature field

Parameters:

signerTextVerticalAlignment - SignatureImageTextParameters.SignerTextVerticalAlignment (TOP, MIDDLE, BOTTOM)

getSignerTextHorizontalAlignment

public SignatureImageTextParameters.SignerTextHorizontalAlignment getSignerTextHorizontalAlignment()

Returns a signer text horizontal alignment value

Returns:

SignatureImageTextParameters.SignerTextHorizontalAlignment

setSignerTextHorizontalAlignment

public void setSignerTextHorizontalAlignment(SignatureImageTextParameters.SignerTextHorizontalAlignment signerTextHorizontalAlignment)

Allows a horizontal alignment of a text with respect to its area

Parameters:

signerTextHorizontalAlignment - SignatureImageTextParameters.SignerTextHorizontalAlignment (LEFT, CENTER, RIGHT)

getFont

public DSSFont getFont()

Returns specified text font

Returns:

DSSFont

setFont

public void setFont(DSSFont dssFont)

Sets a text font

Parameters:

dssFont - DSSFont

getPadding

public float getPadding()

Returns padding between text and its area

Returns:

float padding value

setPadding

public void setPadding(float padding)

Sets a padding between text and its area

Parameters:

padding - float padding value

getTextColor

public Color getTextColor()

Returns text color parameter

Returns:

Color

setTextColor

public void setTextColor(Color textColor)

Sets color for the text

Parameters:

textColor - Color to set

getBackgroundColor

public Color getBackgroundColor()

Returns background color for the text's area

Returns:

Color of the text area background

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

Sets the provided background color for a test's area

Parameters:

backgroundColor - Color to set

getText

public String getText()

Returns defines text content

Returns:

String text

setText

public void setText(String text)

Sets a text content parameter

Parameters:

text - String text to display

setSize

public void setSize(int size)

Sets a size for a text. Note: overrides values defined in setFont(DSSFont dssFont) method!

Parameters:

size - int size