iaik.pdf.itext

Class SignatureAppearanceSetter

java.lang.Object

iaik.pdf.itext.SignatureAppearanceSetter

public class SignatureAppearanceSetter
extends java.lang.Object

Allows the manipulation of the signature appearance. Delegates the function calls to the com.itextpdf.text.pdf.PdfSignatureAppearance instance.

Constructor Summary

Constructors

Constructor and Description
SignatureAppearanceSetter(com.itextpdf.text.pdf.PdfSignatureAppearance sap) Creates a new signature appearance setter for the given signature appearance instance.

Method Summary

Modifier and Type	Method and Description
com.itextpdf.text.pdf.PdfTemplate	getAppearance() Gets the main appearance layer.
java.lang.String	getFieldName() Gets the field name.
com.itextpdf.text.Image	getImage() Gets the background image for the layer 2.
float	getImageScale() Gets the scaling to be applied to the background image.
com.itextpdf.text.pdf.PdfTemplate	getLayer(int layer) Gets a template layer to create a signature appearance.
com.itextpdf.text.Font	getLayer2Font() Gets the n2 and n4 layer font.
java.lang.String	getLayer2Text() Gets the signature text identifying the signer if set by setLayer2Text().
java.lang.String	getLayer4Text() Gets the text identifying the signature status if set by setLayer4Text().
java.lang.String	getNewSigName() Gets a new signature field name that doesn't clash with any existing name.
int	getPage() Gets the page number of the field.
com.itextpdf.text.Rectangle	getPageRect() Gets the rectangle that represent the position and dimension of the signature in the page.
com.itextpdf.text.Rectangle	getRect() Gets the rectangle representing the signature dimensions.
com.itextpdf.text.pdf.PdfSignatureAppearance.RenderingMode	getRenderingMode() Gets the rendering mode for this signature.
int	getRunDirection() Gets the run direction.
com.itextpdf.text.Image	getSignatureGraphic() Gets the Image object to render.
com.itextpdf.text.pdf.PdfTemplate	getTopLayer() Gets the template that aggregates all appearance layers.
boolean	isAcro6Layers() Gets the Acrobat 6.0 layer mode.
boolean	isInvisible() Gets the visibility status of the signature.
void	setAcro6Layers(boolean acro6Layers) Acrobat 6.0 and higher recommends that only layer n0 and n2 be present.
void	setImage(com.itextpdf.text.Image image) Sets the background image for the layer 2.
void	setImageScale(float imageScale) Sets the scaling to be applied to the background image.
void	setLayer2Font(com.itextpdf.text.Font layer2Font) Sets the n2 and n4 layer font.
void	setLayer2Text(java.lang.String text) Sets the signature text identifying the signer.
void	setLayer4Text(java.lang.String text) Sets the text identifying the signature status.
void	setRenderingMode(com.itextpdf.text.pdf.PdfSignatureAppearance.RenderingMode renderingMode) Sets the rendering mode for this signature.
void	setRunDirection(int runDirection) Sets the run direction in the n2 and n4 layer.
void	setSignatureGraphic(com.itextpdf.text.Image signatureGraphic) Sets the Image object to render when Render is set to RenderingMode.GRAPHIC or RenderingMode.GRAPHIC_AND_DESCRIPTION.
void	setVisibleSignature(com.itextpdf.text.Rectangle pageRect, int page, java.lang.String fieldName) Sets the signature to be visible.
void	setVisibleSignature(java.lang.String fieldName) Sets the signature to be visible.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignatureAppearanceSetter

public SignatureAppearanceSetter(com.itextpdf.text.pdf.PdfSignatureAppearance sap)

Creates a new signature appearance setter for the given signature appearance instance.

Parameters:

sap - the iText signature appearance instance

Method Detail

getFieldName

public java.lang.String getFieldName()

Gets the field name.

Returns:

the field name

getNewSigName

public java.lang.String getNewSigName()

Gets a new signature field name that doesn't clash with any existing name.

Returns:

a new signature field name

getPage

public int getPage()

Gets the page number of the field.

Returns:

the page number of the field

getRect

public com.itextpdf.text.Rectangle getRect()

Gets the rectangle representing the signature dimensions.

Returns:

the rectangle representing the signature dimensions. It may be null or have zero width or height for invisible signatures

getPageRect

public com.itextpdf.text.Rectangle getPageRect()

Gets the rectangle that represent the position and dimension of the signature in the page.

Returns:

the rectangle that represent the position and dimension of the signature in the page

isInvisible

public boolean isInvisible()

Gets the visibility status of the signature.

Returns:

the visibility status of the signature

setVisibleSignature

public void setVisibleSignature(com.itextpdf.text.Rectangle pageRect,
                                int page,
                                java.lang.String fieldName)

Sets the signature to be visible. It creates a new visible signature field.

Parameters:

pageRect - the position and dimension of the field in the page

page - the page to place the field. The fist page is 1

fieldName - the field name or null to generate automatically a new field name

setVisibleSignature

public void setVisibleSignature(java.lang.String fieldName)

Sets the signature to be visible. An empty signature field with the same name must already exist.

Parameters:

fieldName - the existing empty signature field name

getRenderingMode

public com.itextpdf.text.pdf.PdfSignatureAppearance.RenderingMode getRenderingMode()

Gets the rendering mode for this signature.

Returns:

the rendering mode for this signature

setRenderingMode

public void setRenderingMode(com.itextpdf.text.pdf.PdfSignatureAppearance.RenderingMode renderingMode)

Sets the rendering mode for this signature.

Parameters:

renderingMode - the rendering mode

getSignatureGraphic

public com.itextpdf.text.Image getSignatureGraphic()

Gets the Image object to render.

Returns:

the image image rendered. If null the mode is defaulted to RenderingMode.DESCRIPTION

setSignatureGraphic

public void setSignatureGraphic(com.itextpdf.text.Image signatureGraphic)

Sets the Image object to render when Render is set to RenderingMode.GRAPHIC or RenderingMode.GRAPHIC_AND_DESCRIPTION.

Parameters:

signatureGraphic -

isAcro6Layers

public boolean isAcro6Layers()

Gets the Acrobat 6.0 layer mode.

Returns:

the Acrobat 6.0 layer mode

setAcro6Layers

public void setAcro6Layers(boolean acro6Layers)

Acrobat 6.0 and higher recommends that only layer n0 and n2 be present. Use this method with value false if you want to ignore this recommendation.

Parameters:

acro6Layers - if true only the layers n0 and n2 will be present

getLayer

public com.itextpdf.text.pdf.PdfTemplate getLayer(int layer)

Gets a template layer to create a signature appearance. The layers can go from 0 to 4, but only layer 0 and 2 will be used if acro6Layers is true.

Parameters:

layer - the layer

Returns:

a template

getImage

public com.itextpdf.text.Image getImage()

Gets the background image for the layer 2.

Returns:

the background image for the layer 2

setImage

public void setImage(com.itextpdf.text.Image image)

Sets the background image for the layer 2.

Parameters:

image - the background image for the layer 2

getImageScale

public float getImageScale()

Gets the scaling to be applied to the background image.

Returns:

the scaling to be applied to the background image

setImageScale

public void setImageScale(float imageScale)

Sets the scaling to be applied to the background image. If it's zero the image will fully fill the rectangle. If it's less than zero the image will fill the rectangle but will keep the proportions. If it's greater than zero that scaling will be applied. In any of the cases the image will always be centered. It's zero by default.

Parameters:

imageScale - the scaling to be applied to the background image

setLayer2Text

public void setLayer2Text(java.lang.String text)

Sets the signature text identifying the signer.

Parameters:

text - the signature text identifying the signer. If null or not set a standard description will be used

getLayer2Text

public java.lang.String getLayer2Text()

Gets the signature text identifying the signer if set by setLayer2Text().

Returns:

the signature text identifying the signer

getLayer2Font

public com.itextpdf.text.Font getLayer2Font()

Gets the n2 and n4 layer font.

Returns:

the n2 and n4 layer font

setLayer2Font

public void setLayer2Font(com.itextpdf.text.Font layer2Font)

Sets the n2 and n4 layer font. If the font size is zero, auto-fit will be used.

Parameters:

layer2Font - the n2 and n4 font

setRunDirection

public void setRunDirection(int runDirection)

Sets the run direction in the n2 and n4 layer.

Parameters:

runDirection - the run direction

getRunDirection

public int getRunDirection()

Gets the run direction.

Returns:

the run direction

setLayer4Text

public void setLayer4Text(java.lang.String text)

Sets the text identifying the signature status. Will be ignored if acro6Layers is true.

Parameters:

text - the text identifying the signature status. If null or not set the description "Signature Not Verified" will be used

getLayer4Text

public java.lang.String getLayer4Text()

Gets the text identifying the signature status if set by setLayer4Text().

Returns:

the text identifying the signature status

getTopLayer

public com.itextpdf.text.pdf.PdfTemplate getTopLayer()

Gets the template that aggregates all appearance layers. This corresponds to the /FRM resource.

Returns:

the template that aggregates all appearance layers

getAppearance

public com.itextpdf.text.pdf.PdfTemplate getAppearance()
                                                throws com.itextpdf.text.DocumentException

Gets the main appearance layer.

Returns:

the main appearance layer

Throws:

com.itextpdf.text.DocumentException - on error