Update appearance generating for push buttons

DEVSIX-2172

Autoported commit.
Original commit hash: [59d94f4ae]

Author: pavel-alay

itext.tests/itext.pdfa.tests/itext/pdfa/PdfAPushbuttonfieldTest.cs

@@ -0,0 +1,110 @@
+using System;
+using System.IO;
+using iText.Forms;
+using iText.Forms.Fields;
+using iText.Kernel.Font;
+using iText.Kernel.Geom;
+using iText.Kernel.Pdf;
+using iText.Kernel.Utils;
+using iText.Test;
+
+namespace iText.Pdfa {
+    public class PdfAPushbuttonfieldTest : ExtendedITextTest {
+        public static readonly String sourceFolder = iText.Test.TestUtil.GetParentProjectDirectory(NUnit.Framework.TestContext
+            .CurrentContext.TestDirectory) + "/resources/itext/pdfa/";
+
+        public static readonly String cmpFolder = iText.Test.TestUtil.GetParentProjectDirectory(NUnit.Framework.TestContext
+            .CurrentContext.TestDirectory) + "/resources/itext/pdfa/cmp/PdfAPushbuttonfieldTest/";
+
+        public static readonly String destinationFolder = NUnit.Framework.TestContext.CurrentContext.TestDirectory
+             + "/test/itext/pdfa/PdfAPushbuttonfieldTest/";
+
+        [NUnit.Framework.OneTimeSetUp]
+        public static void BeforeClass() {
+            CreateDestinationFolder(destinationFolder);
+        }
+
+        /// <exception cref="System.IO.IOException"/>
+        /// <exception cref="System.Exception"/>
+        [NUnit.Framework.Test]
+        public virtual void PdfA1bButtonAppearanceTest() {
+            String name = "pdfA1b_ButtonAppearanceTest";
+            String outPath = destinationFolder + name + ".pdf";
+            String cmpPath = cmpFolder + "cmp_" + name + ".pdf";
+            String diff = "diff_" + name + "_";
+            PdfWriter writer = new PdfWriter(outPath);
+            Stream @is = new FileStream(sourceFolder + "sRGB Color Space Profile.icm", FileMode.Open, FileAccess.Read);
+            PdfOutputIntent outputIntent = new PdfOutputIntent("Custom", "", "http://www.color.org", "sRGB IEC61966-2.1"
+                , @is);
+            PdfADocument doc = new PdfADocument(writer, PdfAConformanceLevel.PDF_A_1B, outputIntent);
+            doc.SetTagged();
+            doc.GetCatalog().SetLang(new PdfString("en-US"));
+            doc.AddNewPage();
+            PdfAcroForm form = PdfAcroForm.GetAcroForm(doc, true);
+            Rectangle rect = new Rectangle(36, 626, 100, 40);
+            PdfFont font = PdfFontFactory.CreateFont(sourceFolder + "FreeSans.ttf", "WinAnsi", true);
+            PdfFormField button = PdfFormField.CreatePushButton(doc, rect, "push button", "push", font, 12, PdfAConformanceLevel
+                .PDF_A_1B);
+            form.AddField(button);
+            doc.Close();
+            NUnit.Framework.Assert.IsNull(new CompareTool().CompareByContent(outPath, cmpPath, destinationFolder, diff
+                ));
+        }
+
+        /// <exception cref="System.IO.IOException"/>
+        /// <exception cref="System.Exception"/>
+        [NUnit.Framework.Test]
+        public virtual void PdfA1bButtonAppearanceRegenerateTest() {
+            String name = "pdfA1b_ButtonAppearanceRegenerateTest";
+            String outPath = destinationFolder + name + ".pdf";
+            String cmpPath = cmpFolder + "cmp_" + name + ".pdf";
+            String diff = "diff_" + name + "_";
+            PdfWriter writer = new PdfWriter(outPath);
+            Stream @is = new FileStream(sourceFolder + "sRGB Color Space Profile.icm", FileMode.Open, FileAccess.Read);
+            PdfOutputIntent outputIntent = new PdfOutputIntent("Custom", "", "http://www.color.org", "sRGB IEC61966-2.1"
+                , @is);
+            PdfADocument doc = new PdfADocument(writer, PdfAConformanceLevel.PDF_A_1B, outputIntent);
+            doc.SetTagged();
+            doc.GetCatalog().SetLang(new PdfString("en-US"));
+            doc.AddNewPage();
+            PdfAcroForm form = PdfAcroForm.GetAcroForm(doc, true);
+            Rectangle rect = new Rectangle(36, 626, 100, 40);
+            PdfFont font = PdfFontFactory.CreateFont(sourceFolder + "FreeSans.ttf", "WinAnsi", true);
+            PdfFormField button = PdfFormField.CreatePushButton(doc, rect, "push button", "push", font, 12, PdfAConformanceLevel
+                .PDF_A_1B);
+            button.RegenerateField();
+            form.AddField(button);
+            doc.Close();
+            NUnit.Framework.Assert.IsNull(new CompareTool().CompareByContent(outPath, cmpPath, destinationFolder, diff
+                ));
+        }
+
+        /// <exception cref="System.IO.IOException"/>
+        /// <exception cref="System.Exception"/>
+        [NUnit.Framework.Test]
+        public virtual void PdfA1bButtonAppearanceSetValueTest() {
+            String name = "pdfA1b_ButtonAppearanceSetValueTest";
+            String outPath = destinationFolder + name + ".pdf";
+            String cmpPath = cmpFolder + "cmp_" + name + ".pdf";
+            String diff = "diff_" + name + "_";
+            PdfWriter writer = new PdfWriter(outPath);
+            Stream @is = new FileStream(sourceFolder + "sRGB Color Space Profile.icm", FileMode.Open, FileAccess.Read);
+            PdfOutputIntent outputIntent = new PdfOutputIntent("Custom", "", "http://www.color.org", "sRGB IEC61966-2.1"
+                , @is);
+            PdfADocument doc = new PdfADocument(writer, PdfAConformanceLevel.PDF_A_1B, outputIntent);
+            doc.SetTagged();
+            doc.GetCatalog().SetLang(new PdfString("en-US"));
+            doc.AddNewPage();
+            PdfAcroForm form = PdfAcroForm.GetAcroForm(doc, true);
+            Rectangle rect = new Rectangle(36, 626, 100, 40);
+            PdfFont font = PdfFontFactory.CreateFont(sourceFolder + "FreeSans.ttf", "WinAnsi", true);
+            PdfFormField button = PdfFormField.CreatePushButton(doc, rect, "push button", "push", font, 12, PdfAConformanceLevel
+                .PDF_A_1B);
+            button.SetValue("button");
+            form.AddField(button);
+            doc.Close();
+            NUnit.Framework.Assert.IsNull(new CompareTool().CompareByContent(outPath, cmpPath, destinationFolder, diff
+                ));
+        }
+    }
+}

itext.tests/itext.pdfa.tests/resources/itext/pdfa/cmp/PdfAPushbuttonfieldTest/cmp_pdfA1b_ButtonAppearanceRegenerateTest.pdf

@@ -1264,6 +1264,9 @@ public static PdfButtonFormField CreatePushButton(PdfDocument doc, Rectangle rec
             mk.Put(PdfName.CA, new PdfString(caption));
             mk.Put(PdfName.BG, new PdfArray(field.backgroundColor.GetColorValue()));
             annot.SetAppearanceCharacteristics(mk);
+            if (pdfAConformanceLevel != null) {
+                CreatePushButtonAppearanceState(annot.GetPdfObject());
+            }
             return field;
         }
 
@@ -2688,36 +2691,37 @@ public virtual bool RegenerateField() {
                     if ((ff & PdfButtonFormField.FF_PUSH_BUTTON) != 0) {
                         try {
                             value = text;
+                            PdfDictionary widget = GetPdfObject();
                             PdfFormXObject appearance;
                             Rectangle rect = GetRect(GetPdfObject());
                             PdfDictionary apDic = GetPdfObject().GetAsDictionary(PdfName.AP);
                             if (apDic == null) {
                                 IList<PdfWidgetAnnotation> widgets = GetWidgets();
                                 if (widgets.Count == 1) {
-                                    apDic = widgets[0].GetPdfObject().GetAsDictionary(PdfName.AP);
+                                    widget = widgets[0].GetPdfObject();
+                                    apDic = widget.GetAsDictionary(PdfName.AP);
                                 }
                             }
+                            if (apDic == null) {
+                                Put(PdfName.AP, apDic = new PdfDictionary());
+                                widget = GetPdfObject();
+                            }
                             if (img != null || form != null) {
                                 appearance = DrawPushButtonAppearance(rect.GetWidth(), rect.GetHeight(), value, null, null, 0);
                             }
                             else {
-                                PdfStream asNormal = null;
-                                if (apDic != null) {
-                                    //TODO DEVSIX-2528 what is PdfName.N is PdfDictionary?
-                                    asNormal = apDic.GetAsStream(PdfName.N);
-                                }
-                                Object[] fontAndSize = GetFontAndSize(asNormal);
+                                //TODO DEVSIX-2528 what if PdfName.N is PdfDictionary?
+                                Object[] fontAndSize = GetFontAndSize(apDic.GetAsStream(PdfName.N));
                                 PdfFont localFont = (PdfFont)fontAndSize[0];
                                 PdfName localFontName = (PdfName)fontAndSize[2];
                                 float fontSize = (float)fontAndSize[1];
                                 appearance = DrawPushButtonAppearance(rect.GetWidth(), rect.GetHeight(), value, localFont, localFontName, 
                                     fontSize);
                             }
-                            if (apDic == null) {
-                                apDic = new PdfDictionary();
-                                Put(PdfName.AP, apDic);
-                            }
                             apDic.Put(PdfName.N, appearance.GetPdfObject());
+                            if (pdfAConformanceLevel != null) {
+                                CreatePushButtonAppearanceState(widget);
+                            }
                         }
                         catch (System.IO.IOException e) {
                             throw new PdfException(e);
@@ -2783,6 +2787,21 @@ public virtual bool RegenerateField() {
             return true;
         }
 
+        private static void CreatePushButtonAppearanceState(PdfDictionary widget) {
+            PdfDictionary appearances = widget.GetAsDictionary(PdfName.AP);
+            PdfStream normalAppearanceStream = appearances.GetAsStream(PdfName.N);
+            if (normalAppearanceStream != null) {
+                PdfName stateName = widget.GetAsName(PdfName.AS);
+                if (stateName == null) {
+                    stateName = new PdfName("push");
+                }
+                widget.Put(PdfName.AS, stateName);
+                PdfDictionary normalAppearance = new PdfDictionary();
+                normalAppearance.Put(stateName, normalAppearanceStream);
+                appearances.Put(PdfName.N, normalAppearance);
+            }
+        }
+
         // TODO DEVSIX-2536
         // Actually this entire method is a mess,
         // because only radio group has FF_RADIO type and there is no RadioButton at all.

itext.tests/itext.pdfa.tests/resources/itext/pdfa/cmp/PdfAPushbuttonfieldTest/cmp_pdfA1b_ButtonAppearanceSetValueTest.pdf

@@ -1 +1 @@
-26409b5ce1656907942be1697522d0e1bf6db2fb
+59d94f4aefe2febfbc793a7b216b6a620e5c8227