eu.europa.esig.dss.pades.SignatureImageParameters

public class SignatureImageParameters
extends Object

Parameters for a visible signature creation

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SignatureImageParameters.VisualSignatureAlignmentHorizontal`	Visual signature horizontal position on the pdf page
`static class`	`SignatureImageParameters.VisualSignatureAlignmentVertical`	Visual signature vertical position on the pdf page
`static class`	`SignatureImageParameters.VisualSignatureRotation`	Rotation support

Field Summary

Fields

Modifier and Type Field Description

static int DEFAULT_PAGE

static int NO_SCALING
Constructor Summary

Constructors

Constructor Description

SignatureImageParameters()

Method Summary

Modifier and Type	Method	Description
`Color`	`getBackgroundColor()`	Returns a specified background color for the signature field
`Integer`	`getDpi()`	Returns a defined DPI value Note: can be null
`int`	`getHeight()`	Returns a specified height of the signature field
`DSSDocument`	`getImage()`	Returns a `DSSDocument` image defined for displaying on the signature field
`int`	`getPage()`	Returns a page number where the signature field must be placed
`SignatureImageParameters.VisualSignatureRotation`	`getRotation()`	Returns rotation value for a signature field
`float`	`getScaleFactor()`	Returns a coefficient applying to a signature field width/height calculation
`SignatureImageTextParameters`	`getTextParameters()`	Returns text parameters
`SignatureImageParameters.VisualSignatureAlignmentHorizontal`	`getVisualSignatureAlignmentHorizontal()`	Returns a horizontal alignment value of the signature field
`SignatureImageParameters.VisualSignatureAlignmentVertical`	`getVisualSignatureAlignmentVertical()`	Returns a vertical alignment value of the signature field
`int`	`getWidth()`	Returns a specified width of the signature field
`float`	`getxAxis()`	Returns an absolute margin of the signature field by X axis
`float`	`getyAxis()`	Returns an absolute margin of the signature field by Y axis
`int`	`getZoom()`	Returns the defined Zoom value in percentage
`void`	`setAlignmentHorizontal(SignatureImageParameters.VisualSignatureAlignmentHorizontal alignmentHorizontal)`	Sets a horizontal alignment respectively to a page of the signature field
`void`	`setAlignmentVertical(SignatureImageParameters.VisualSignatureAlignmentVertical alignmentVertical)`	Sets a vertical alignment respectively to a page of the signature field
`void`	`setBackgroundColor(Color backgroundColor)`	Sets the background color for the signature field
`void`	`setDpi(Integer dpi)`	Sets an expected DPI value.
`void`	`setHeight(int height)`	Defines a custom height for the signature field in pixels
`void`	`setImage(DSSDocument image)`	Allows to set a custom image to display on a signature field
`void`	`setPage(int page)`	Defines a number of page in the document where the signature field must be placed.
`void`	`setRotation(SignatureImageParameters.VisualSignatureRotation rotation)`	Sets a rotation value for the signature field.
`void`	`setTextParameters(SignatureImageTextParameters textParameters)`	Sets text parameters
`void`	`setWidth(int width)`	Defines a custom width for the signature field in pixels
`void`	`setxAxis(float xAxis)`	Allows specifying of an absolute margin for the signature field by X axis
`void`	`setyAxis(float yAxis)`	Allows specifying of an absolute margin for the signature field by Y axis
`void`	`setZoom(int zoom)`	Defines the signature field zoom in percentage (default value = 100)

Methods inherited from class java.lang.Object

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

Field Details
- DEFAULT_PAGE
  
  public static final int DEFAULT_PAGE
  
  See Also:
  
  Constant Field Values
- NO_SCALING
  
  public static final int NO_SCALING
  
  See Also:
  
  Constant Field Values
Constructor Details
- SignatureImageParameters
  
  public SignatureImageParameters()
Method Details
- getImage
  
  public DSSDocument getImage()
  
  Returns a DSSDocument image defined for displaying on the signature field
  
  Returns:
  
  DSSDocument image
- setImage
  
  public void setImage(DSSDocument image)
  
  Allows to set a custom image to display on a signature field
  
  Parameters:
  
  image - DSSDocument
- getxAxis
  
  public float getxAxis()
  
  Returns an absolute margin of the signature field by X axis
  
  Returns:
  
  X axis float value
- setxAxis
  
  public void setxAxis(float xAxis)
  
  Allows specifying of an absolute margin for the signature field by X axis
  
  Parameters:
  
  xAxis - float margin
- getyAxis
  
  public float getyAxis()
  
  Returns an absolute margin of the signature field by Y axis
  
  Returns:
  
  Y axis float value
- setyAxis
  
  public void setyAxis(float yAxis)
  
  Allows specifying of an absolute margin for the signature field by Y axis
  
  Parameters:
  
  yAxis - float margin
- getZoom
  
  public int getZoom()
  
  Returns the defined Zoom value in percentage
  
  Returns:
  
  int zoom
- setZoom
  
  public void setZoom(int zoom)
  
  Defines the signature field zoom in percentage (default value = 100)
  
  Parameters:
  
  zoom - int zoom value
- getScaleFactor
  
  public float getScaleFactor()
  
  Returns a coefficient applying to a signature field width/height calculation
  
  Returns:
  
  float scale factor
- getPage
  
  public int getPage()
  
  Returns a page number where the signature field must be placed
  
  Returns:
  
  int page number
- setPage
  
  public void setPage(int page)
  
  Defines a number of page in the document where the signature field must be placed. The counting of pages starts from 1 (the first page) (default value = 1) NOTE: the page must exist in the document!
  
  Parameters:
  
  page - int page number
- getWidth
  
  public int getWidth()
  
  Returns a specified width of the signature field
  
  Returns:
  
  int width value
- setWidth
  
  public void setWidth(int width)
  
  Defines a custom width for the signature field in pixels
  
  Parameters:
  
  width - int width value
- getHeight
  
  public int getHeight()
  
  Returns a specified height of the signature field
  
  Returns:
  
  int height value
- setHeight
  
  public void setHeight(int height)
  
  Defines a custom height for the signature field in pixels
  
  Parameters:
  
  height - int height value
- getBackgroundColor
  
  public Color getBackgroundColor()
  
  Returns a specified background color for the signature field
  
  Returns:
  
  Color background color
- setBackgroundColor
  
  public void setBackgroundColor(Color backgroundColor)
  
  Sets the background color for the signature field
  
  Parameters:
  
  backgroundColor - Color to set
- getDpi
  
  public Integer getDpi()
  
  Returns a defined DPI value Note: can be null
  
  Returns:
  
  Integer dpi value
- setDpi
  
  public void setDpi(Integer dpi)
  
  Sets an expected DPI value. If NULL the default dpi of the provided image is applied. Note: images with a lower DPI will take more space on a PDF page
  
  Parameters:
  
  dpi - Integer dpi value
- getTextParameters
  
  public SignatureImageTextParameters getTextParameters()
  
  Returns text parameters
  
  Returns:
  
  SignatureImageTextParameters
- setTextParameters
  
  public void setTextParameters(SignatureImageTextParameters textParameters)
  
  Sets text parameters
  
  Parameters:
  
  textParameters - SignatureImageTextParameters
- getRotation
  
  public SignatureImageParameters.VisualSignatureRotation getRotation()
  
  Returns rotation value for a signature field
  
  Returns:
  
  SignatureImageParameters.VisualSignatureRotation
- setRotation
  
  public void setRotation(SignatureImageParameters.VisualSignatureRotation rotation)
  
  Sets a rotation value for the signature field.
  
  Parameters:
  
  rotation - SignatureImageParameters.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).
- getVisualSignatureAlignmentHorizontal
  
  public SignatureImageParameters.VisualSignatureAlignmentHorizontal getVisualSignatureAlignmentHorizontal()
  
  Returns a horizontal alignment value of the signature field
  
  Returns:
  
  SignatureImageParameters.VisualSignatureAlignmentHorizontal
- setAlignmentHorizontal
  
  public void setAlignmentHorizontal(SignatureImageParameters.VisualSignatureAlignmentHorizontal alignmentHorizontal)
  
  Sets a horizontal alignment respectively to a page of the signature field
  
  Parameters:
  
  alignmentHorizontal - SignatureImageParameters.VisualSignatureAlignmentHorizontal
- getVisualSignatureAlignmentVertical
  
  public SignatureImageParameters.VisualSignatureAlignmentVertical getVisualSignatureAlignmentVertical()
  
  Returns a vertical alignment value of the signature field
  
  Returns:
  
  SignatureImageParameters.VisualSignatureAlignmentVertical
- setAlignmentVertical
  
  public void setAlignmentVertical(SignatureImageParameters.VisualSignatureAlignmentVertical alignmentVertical)
  
  Sets a vertical alignment respectively to a page of the signature field
  
  Parameters:
  
  alignmentVertical - SignatureImageParameters.VisualSignatureAlignmentVertical

Class SignatureImageParameters

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details