Improve PdfSigner signature appearance customization API

DEVSIX-7795

Author: AnhelinaM

forms/src/main/java/com/itextpdf/forms/fields/PdfFormAnnotation.java

@@ -36,7 +36,7 @@ This file is part of the iText (R) project.
 import com.itextpdf.forms.form.element.ListBoxField;
 import com.itextpdf.forms.form.element.Radio;
 import com.itextpdf.forms.form.element.SelectFieldItem;
-import com.itextpdf.forms.form.element.SigField;
+import com.itextpdf.forms.form.element.SignatureFieldAppearance;
 import com.itextpdf.forms.form.element.TextArea;
 import com.itextpdf.forms.form.renderer.checkboximpl.PdfCheckBoxRenderingStrategy;
 import com.itextpdf.forms.logs.FormsLogMessageConstants;
@@ -1102,29 +1102,29 @@ void createInputButton() {
     }
 
     void createSigField() {
-        if (!(formFieldElement instanceof SigField)) {
+        if (!(formFieldElement instanceof SignatureFieldAppearance)) {
             // Create it one time and re-set properties during each widget regeneration.
-            formFieldElement = new SigField(parent.getPartialFieldName().toUnicodeString());
+            formFieldElement = new SignatureFieldAppearance(parent.getPartialFieldName().toUnicodeString());
         }
 
         if (formFieldElement.<Object>getProperty(Property.FONT) == null) {
-            ((SigField) formFieldElement).setFont(getFont());
+            ((SignatureFieldAppearance) formFieldElement).setFont(getFont());
         }
         if (getColor() != null) {
-            ((SigField) formFieldElement).setFontColor(color);
+            ((SignatureFieldAppearance) formFieldElement).setFontColor(color);
         }
 
         PdfString reason = parent.getPdfObject().getAsString(PdfName.Reason);
         if (reason != null) {
-            ((SigField) formFieldElement).setReason(reason.toUnicodeString());
+            ((SignatureFieldAppearance) formFieldElement).setReason(reason.toUnicodeString());
         }
         PdfString location = parent.getPdfObject().getAsString(PdfName.Location);
         if (location != null) {
-            ((SigField) formFieldElement).setLocation(location.toUnicodeString());
+            ((SignatureFieldAppearance) formFieldElement).setLocation(location.toUnicodeString());
         }
         PdfString contact = parent.getPdfObject().getAsString(PdfName.ContactInfo);
         if (contact != null) {
-            ((SigField) formFieldElement).setContact(contact.toUnicodeString());
+            ((SignatureFieldAppearance) formFieldElement).setContact(contact.toUnicodeString());
         }
     }
 
@@ -1359,16 +1359,16 @@ private PdfFormXObject createTopLayer(float width, float height) {
      * @return n0 layer xObject.
      */
     private PdfFormXObject createN0Layer(float width, float height) {
-        if (((SigField) formFieldElement).getBackgroundLayer() != null) {
-            return ((SigField) formFieldElement).getBackgroundLayer();
+        if (((SignatureFieldAppearance) formFieldElement).getBackgroundLayer() != null) {
+            return ((SignatureFieldAppearance) formFieldElement).getBackgroundLayer();
         }
         // Create blank n0.
         PdfFormXObject n0LayerXObject = new PdfFormXObject(new Rectangle(0, 0, width, height));
         n0LayerXObject.makeIndirect(getDocument());
         PdfCanvas canvas = new PdfCanvas(n0LayerXObject, getDocument());
         canvas.writeLiteral("% DSBlank\n");
 
-        if (((SigField) formFieldElement).isReuseAppearance()) {
+        if (((SignatureFieldAppearance) formFieldElement).isReuseAppearance()) {
             // Reuse existed field appearance as a background
             PdfAcroForm acroForm = PdfFormCreator.getAcroForm(getDocument(), true);
             PdfFormField field = acroForm.getField(parent.getFieldName().toUnicodeString());
@@ -1377,7 +1377,7 @@ private PdfFormXObject createN0Layer(float width, float height) {
             if (oldAppearanceStream != null) {
                 n0LayerXObject = new PdfFormXObject(oldAppearanceStream);
             } else {
-                ((SigField) formFieldElement).setReuseAppearance(false);
+                ((SignatureFieldAppearance) formFieldElement).setReuseAppearance(false);
             }
         }
         return n0LayerXObject;
@@ -1397,8 +1397,8 @@ private PdfFormXObject createN0Layer(float width, float height) {
      * @return n2 layer xObject.
      */
     private PdfFormXObject createN2Layer(float width, float height) {
-        if (((SigField) formFieldElement).getSignatureAppearanceLayer() != null) {
-            return ((SigField) formFieldElement).getSignatureAppearanceLayer();
+        if (((SignatureFieldAppearance) formFieldElement).getSignatureAppearanceLayer() != null) {
+            return ((SignatureFieldAppearance) formFieldElement).getSignatureAppearanceLayer();
         }
         PdfFormXObject n2LayerXObject = new PdfFormXObject(new Rectangle(0, 0, width, height));
         Canvas n2LayerCanvas = new Canvas(n2LayerXObject, this.getDocument());

forms/src/main/java/com/itextpdf/forms/form/element/SigField.java renamed to forms/src/main/java/com/itextpdf/forms/form/element/SignatureFieldAppearance.java

@@ -23,21 +23,20 @@ This file is part of the iText (R) project.
 package com.itextpdf.forms.form.element;
 
 import com.itextpdf.commons.utils.DateTimeUtil;
-import com.itextpdf.forms.form.renderer.SigFieldRenderer;
+import com.itextpdf.forms.form.renderer.SignatureAppearanceRenderer;
 import com.itextpdf.io.image.ImageData;
 import com.itextpdf.kernel.pdf.xobject.PdfFormXObject;
 import com.itextpdf.layout.properties.BoxSizingPropertyValue;
 import com.itextpdf.layout.properties.Property;
 import com.itextpdf.layout.properties.UnitValue;
 import com.itextpdf.layout.renderer.IRenderer;
 
-import java.text.SimpleDateFormat;
 import java.util.Calendar;
 
 /**
  * Extension of the {@link FormField} class representing a signature field in PDF.
  */
-public class SigField extends FormField<SigField> {
+public class SignatureFieldAppearance extends FormField<SignatureFieldAppearance> {
     /**
      * Default paddings for the signature field.
      */
@@ -87,6 +86,7 @@ public class SigField extends FormField<SigField> {
      * Holds value of property signDate.
      */
     private Calendar signDate;
+    private boolean isSignDateSet = false;
 
     /**
      * The image that needs to be used for a visible signature.
@@ -130,11 +130,11 @@ public class SigField extends FormField<SigField> {
     private String idWithDots = null;
 
     /**
-     * Creates a new {@link SigField} instance.
+     * Creates a new {@link SignatureFieldAppearance} instance.
      *
      * @param id the id.
      */
-    public SigField(String id) {
+    public SignatureFieldAppearance(String id) {
         // We should support signing of existing fields with dots in name.
         super(id != null && id.contains(".") ? "" : id);
         if (id.contains(".")) {
@@ -162,9 +162,9 @@ public RenderingMode getRenderingMode() {
      *
      * @param renderingMode the rendering mode.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setRenderingMode(RenderingMode renderingMode) {
+    public SignatureFieldAppearance setRenderingMode(RenderingMode renderingMode) {
         this.renderingMode = renderingMode;
         return this;
     }
@@ -183,9 +183,9 @@ public String getReason() {
      *
      * @param reason signing reason.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setReason(String reason) {
+    public SignatureFieldAppearance setReason(String reason) {
         this.reason = reason;
         return this;
     }
@@ -195,9 +195,9 @@ public SigField setReason(String reason) {
      *
      * @param reasonCaption new signing reason caption.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setReasonCaption(String reasonCaption) {
+    public SignatureFieldAppearance setReasonCaption(String reasonCaption) {
         this.reasonCaption = reasonCaption;
         return this;
     }
@@ -216,9 +216,9 @@ public String getLocation() {
      *
      * @param location new signing location.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setLocation(String location) {
+    public SignatureFieldAppearance setLocation(String location) {
         this.location = location;
         return this;
     }
@@ -228,9 +228,9 @@ public SigField setLocation(String location) {
      *
      * @param locationCaption new signing location caption.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setLocationCaption(String locationCaption) {
+    public SignatureFieldAppearance setLocationCaption(String locationCaption) {
         this.locationCaption = locationCaption;
         return this;
     }
@@ -249,9 +249,9 @@ public String getSignatureCreator() {
      *
      * @param signatureCreator new name of the application signing a document.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setSignatureCreator(String signatureCreator) {
+    public SignatureFieldAppearance setSignatureCreator(String signatureCreator) {
         this.signatureCreator = signatureCreator;
         return this;
     }
@@ -270,9 +270,9 @@ public String getContact() {
      *
      * @param contact new signing contact.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setContact(String contact) {
+    public SignatureFieldAppearance setContact(String contact) {
         this.contact = contact;
         return this;
     }
@@ -291,9 +291,9 @@ public ImageData getSignatureGraphic() {
      *
      * @param signatureGraphic image rendered.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setSignatureGraphic(ImageData signatureGraphic) {
+    public SignatureFieldAppearance setSignatureGraphic(ImageData signatureGraphic) {
         this.signatureGraphic = signatureGraphic;
         return this;
     }
@@ -312,9 +312,9 @@ public boolean isReuseAppearance() {
      *
      * @param reuseAppearance is an appearances reusing flag value to set.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setReuseAppearance(boolean reuseAppearance) {
+    public SignatureFieldAppearance setReuseAppearance(boolean reuseAppearance) {
         this.reuseAppearance = reuseAppearance;
         return this;
     }
@@ -333,9 +333,9 @@ public ImageData getImage() {
      *
      * @param image the background image.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setImage(ImageData image) {
+    public SignatureFieldAppearance setImage(ImageData image) {
         this.image = image;
         return this;
     }
@@ -357,9 +357,9 @@ public float getImageScale() {
      *
      * @param imageScale the scaling to be applied to the background image.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setImageScale(float imageScale) {
+    public SignatureFieldAppearance setImageScale(float imageScale) {
         this.imageScale = imageScale;
         return this;
     }
@@ -370,9 +370,9 @@ public SigField setImageScale(float imageScale) {
      * @param text the signature text identifying the signer. If null or not set
      *             a standard description will be used.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setDescription(String text) {
+    public SignatureFieldAppearance setDescription(String text) {
         description = text;
         return this;
     }
@@ -393,9 +393,9 @@ public String getDescription(boolean generate) {
      *
      * @param signedBy name of the signer.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setSignedBy(String signedBy) {
+    public SignatureFieldAppearance setSignedBy(String signedBy) {
         this.signedBy = signedBy;
         return this;
     }
@@ -423,10 +423,11 @@ public java.util.Calendar getSignDate() {
      *
      * @param signDate new signature date.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setSignDate(java.util.Calendar signDate) {
+    public SignatureFieldAppearance setSignDate(java.util.Calendar signDate) {
         this.signDate = signDate;
+        this.isSignDateSet = true;
         return this;
     }
 
@@ -444,9 +445,9 @@ public PdfFormXObject getBackgroundLayer() {
      *
      * @param n0 layer xObject.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setBackgroundLayer(PdfFormXObject n0) {
+    public SignatureFieldAppearance setBackgroundLayer(PdfFormXObject n0) {
         this.n0 = n0;
         return this;
     }
@@ -466,9 +467,9 @@ public PdfFormXObject getSignatureAppearanceLayer() {
      *
      * @param n2 layer xObject.
      *
-     * @return this same {@link SigField} instance.
+     * @return this same {@link SignatureFieldAppearance} instance.
      */
-    public SigField setSignatureAppearanceLayer(PdfFormXObject n2) {
+    public SignatureFieldAppearance setSignatureAppearanceLayer(PdfFormXObject n2) {
         this.n2 = n2;
         return this;
     }
@@ -490,15 +491,15 @@ public String getId() {
      */
     @Override
     protected IRenderer makeNewRenderer() {
-        return new SigFieldRenderer(this);
+        return new SignatureAppearanceRenderer(this);
     }
 
     private String generateDescriptionText() {
         StringBuilder buf = new StringBuilder();
         if (!signedBy.isEmpty()) {
             buf.append("Digitally signed by ").append(signedBy);
         }
-        if (signDate != null) {
+        if (isSignDateSet) {
             buf.append('\n').append("Date: ").append(DateTimeUtil.dateToString(signDate));
         }
         if (reason != null) {