Package eu.europa.esig.dss.pades

Class SignatureFieldParameters

java.lang.Object

eu.europa.esig.dss.pades.SignatureFieldParameters

All Implemented Interfaces:

Serializable

public class SignatureFieldParameters
extends Object
implements Serializable

Parameters which allow to create a new signature field in a PDF document

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SignatureFieldParameters()	Default constructor instantiating object with null values

Method Summary

Modifier and Type	Method	Description
String	getFieldId()	Gets signature field id
float	getHeight()	Gets a height of the signature field
float	getOriginX()	Gets an upper left X coordinate
float	getOriginY()	Gets a upper left Y coordinate
int	getPage()	Gets a page where the signature should be placed
VisualSignatureRotation	getRotation()	Returns rotation value for a signature field relatively the PDF page
float	getWidth()	Gets a width of the signature field
void	setFieldId(String fieldId)	Sets a signature field id/name to place a signature into
void	setHeight(float height)	Sets a height of the signature field
void	setOriginX(float originX)	Sets a upper left X coordinate of the signature field
void	setOriginY(float originY)	Sets a upper left Y coordinate of the signature field
void	setPage(int page)	Sets a page number where the signature field should be placed NOTE: the counting starts from 1 (one) for the first page of the document
void	setRotation(VisualSignatureRotation rotation)	Sets a rotation value for the signature field relatively the PDF page
void	setWidth(float width)	Sets a width of the signature field
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SignatureFieldParameters

public SignatureFieldParameters()

Default constructor instantiating object with null values

Method Details

getFieldId

public String getFieldId()

Gets signature field id

Returns:

String signature field id

setFieldId

public void setFieldId(String fieldId)

Sets a signature field id/name to place a signature into

Parameters:

fieldId - String signature field id/name

getPage

public int getPage()

Gets a page where the signature should be placed

Returns:

page number

setPage

public void setPage(int page)

Sets a page number where the signature field should be placed NOTE: the counting starts from 1 (one) for the first page of the document

Parameters:

page - where the signature field should be placed

getOriginX

public float getOriginX()

Gets an upper left X coordinate

Returns:

upper left X coordinate

setOriginX

public void setOriginX(float originX)

Sets a upper left X coordinate of the signature field

Parameters:

originX - upper left X coordinate

getOriginY

public float getOriginY()

Gets a upper left Y coordinate

Returns:

upper left Y coordinate

setOriginY

public void setOriginY(float originY)

Sets a upper left Y coordinate of the signature field

Parameters:

originY - upper left Y coordinate

getWidth

public float getWidth()

Gets a width of the signature field

Returns:

width

setWidth

public void setWidth(float width)

Sets a width of the signature field

Parameters:

width - of the signature field

getHeight

public float getHeight()

Gets a height of the signature field

Returns:

height

setHeight

public void setHeight(float height)

Sets a height of the signature field

Parameters:

height - of the signature field

getRotation

public VisualSignatureRotation getRotation()

Returns rotation value for a signature field relatively the PDF page

Returns:

VisualSignatureRotation

setRotation

public void setRotation(VisualSignatureRotation rotation)

Sets a rotation value for the signature field relatively the PDF page

Parameters:

rotation - VisualSignatureRotation. The following values can be used: NONE (DEFAULT value. No rotation is applied. The origin of coordinates begins from the top left corner of a page); AUTOMATIC (Rotates a signature field respectively to the page's rotation. Rotates the signature field on the same value as a defined in a PDF page); ROTATE_90 (Rotates a signature field for a 90° clockwise. Coordinates' origin begins from top right page corner); ROTATE_180 (Rotates a signature field for a 180° clockwise. Coordinates' origin begins from the bottom right page corner); ROTATE_270 (Rotates a signature field for a 270° clockwise. Coordinates' origin begins from the bottom left page corner).

toString

public String toString()

Overrides:

toString in class Object