Package eu.europa.esig.dss.pades

Class SignatureImageParameters

  • public class SignatureImageParameters
extends Object
    Parameters for a visible signature creation

    • Constructor Detail

      • SignatureImageParameters

        public SignatureImageParameters()

    • Method Detail

      • 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

      • 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).