Package com.itextpdf.forms.form.element

Class SignatureFieldAppearance

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer

com.itextpdf.layout.element.AbstractElement

com.itextpdf.forms.form.element.FormField<SignatureFieldAppearance>

com.itextpdf.forms.form.element.SignatureFieldAppearance

All Implemented Interfaces:

IFormField, IAbstractElement, IBlockElement, IElement, IPropertyContainer, IAccessibleElement

       public class SignatureFieldAppearance extends FormField<SignatureFieldAppearance>
      

Extension of the FormField class representing a signature field in PDF.

Field Summary

Fields inherited from class com.itextpdf.forms.form.element.FormField

tagProperties

Fields inherited from class com.itextpdf.layout.element.AbstractElement

childElements, nextRenderer, styles

Fields inherited from class com.itextpdf.layout.ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor	Description
SignatureFieldAppearance(String id)	Creates a new SignatureFieldAppearance instance.

Method Summary

Modifier and Type	Method	Description
AccessibilityProperties	getAccessibilityProperties()	Gets the accessibility properties.
List<IElement>	getContentElements()	Gets the final content for this signature.
String	getId()	Gets the id.
SignedAppearanceText	getSignedAppearanceText()	Gets the SignedAppearanceText instance for this signature.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.
SignatureFieldAppearance	setContent(SignedAppearanceText description)	Sets the content for this signature.
SignatureFieldAppearance	setContent(SignedAppearanceText description, ImageData image)	Sets the content for this signature.
SignatureFieldAppearance	setContent(ImageData image)	Sets the content for this signature.
SignatureFieldAppearance	setContent(Div data)	Sets the content for this signature.
SignatureFieldAppearance	setContent(String description)	Sets the content for this signature.
SignatureFieldAppearance	setContent(String signerName, SignedAppearanceText description)	Sets the content for this signature.
SignatureFieldAppearance	setContent(String description, ImageData image)	Sets the content for this signature.
SignatureFieldAppearance	setContent(String signerName, String description)	Sets the content for this signature.
void	setSignerName(String signerName)	Replaces the signer name for this signature if it was set by setContent(com.itextpdf.forms.fields.properties.SignedAppearanceText).

Methods inherited from class com.itextpdf.forms.form.element.FormField

getDefaultProperty, setAlternativeDescription, setHeight, setInteractive, setSize, setValue, setWidth

Methods inherited from class com.itextpdf.layout.element.AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, setAction, setNextRenderer, setPageNumber

Methods inherited from class com.itextpdf.layout.ElementPropertyContainer

deleteOwnProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getTransparentStrokeColor, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDashPattern, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeColor, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing, simulateBold, simulateItalic

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.itextpdf.layout.element.IAbstractElement

getChildren

Methods inherited from interface com.itextpdf.layout.element.IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface com.itextpdf.layout.IPropertyContainer

deleteOwnProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Constructor Details

SignatureFieldAppearance

             public SignatureFieldAppearance
             (String id)
            

Creates a new SignatureFieldAppearance instance.

Parameters:

id - signature field name if you use this SignatureFieldAppearance in pure layout for the new interactive signature field creation. ID will be ignored if this SignatureFieldAppearance is used for signing or for existing signature field

Method Details

setContent

             public SignatureFieldAppearance setContent
             (SignedAppearanceText description)
            

Sets the content for this signature.

Parameters:

description - SignedAppearanceText instance representing the signature text identifying the signer.

Returns:

this same SignatureFieldAppearance instance.

setContent

             public SignatureFieldAppearance setContent
             (String description)
            

Sets the content for this signature.

Parameters:

description - the signature text identifying the signer.

Returns:

this same SignatureFieldAppearance instance.

setContent

             public SignatureFieldAppearance setContent
             (SignedAppearanceText description, ImageData image)
            

Sets the content for this signature.

Parameters:

description - SignedAppearanceText instance representing the signature text identifying the signer.

image - the Image object to render.

Returns:

this same SignatureFieldAppearance instance.

setContent

             public SignatureFieldAppearance setContent
             (String description, ImageData image)
            

Sets the content for this signature.

Parameters:

description - the signature text identifying the signer.

image - the Image object to render.

Returns:

this same SignatureFieldAppearance instance.

setContent

             public SignatureFieldAppearance setContent
             (ImageData image)
            

Sets the content for this signature.

Parameters:

image - the Image object to render.

Returns:

this same SignatureFieldAppearance instance.

setContent

             public SignatureFieldAppearance setContent
             (String signerName, SignedAppearanceText description)
            

Sets the content for this signature.

Parameters:

signerName - the name of the signer from the certificate.

description - SignedAppearanceText instance representing the signature text identifying the signer.

Returns:

this same SignatureFieldAppearance instance.

setContent

             public SignatureFieldAppearance setContent
             (String signerName, String description)
            

Sets the content for this signature.

Parameters:

signerName - the name of the signer from the certificate.

description - the signature text identifying the signer.

Returns:

this same SignatureFieldAppearance instance.

setContent

             public SignatureFieldAppearance setContent
             (Div data)
            

Sets the content for this signature.

Parameters:

data - the custom signature data which will be rendered.

Returns:

this same SignatureFieldAppearance instance.

getContentElements

             public List<IElement> getContentElements()
            

Gets the final content for this signature.

Returns:

collection of the layout elements which will be rendered as a signature content.

getSignedAppearanceText

             public SignedAppearanceText getSignedAppearanceText()
            

Gets the SignedAppearanceText instance for this signature.

Returns:

SignedAppearanceText instance if it was set by setContent(com.itextpdf.forms.fields.properties.SignedAppearanceText), null otherwise.

setSignerName

             public void setSignerName
             (String signerName)
            

Replaces the signer name for this signature if it was set by setContent(com.itextpdf.forms.fields.properties.SignedAppearanceText).

Parameters:

signerName - signer name to set.

getId

             public String getId()
            

Gets the id.

Specified by:

getId in interface IFormField

Overrides:

getId in class FormField<SignatureFieldAppearance>

Returns:

the id

getAccessibilityProperties

             public AccessibilityProperties getAccessibilityProperties()
            

Gets the accessibility properties. See also IAccessibleElement.

Returns:

an interface that allows to specify properties of a tagged element in Tagged PDF.

makeNewRenderer

             protected IRenderer makeNewRenderer()
            

Creates a new renderer instance.

Specified by:

makeNewRenderer in class AbstractElement<SignatureFieldAppearance>

Returns:

new IRenderer