pdfbox-trunk/examples/src/test/java/org/apache/pdfbox/examples/interactive/form/TestCreateSimpleForms.java
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.pdfbox.examples.interactive.form;

import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;

import java.io.File;
import java.io.IOException;
import java.util.List;
import org.apache.pdfbox.Loader;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.font.PDFont;
import org.apache.pdfbox.pdmodel.graphics.color.PDColor;
import org.apache.pdfbox.pdmodel.graphics.color.PDDeviceRGB;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceCharacteristicsDictionary;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceDictionary;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceEntry;
import org.apache.pdfbox.pdmodel.interactive.annotation.PDAppearanceStream;
import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
import org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox;
import org.apache.pdfbox.pdmodel.interactive.form.PDPushButton;
import org.apache.pdfbox.pdmodel.interactive.form.PDRadioButton;
import org.apache.pdfbox.pdmodel.interactive.form.PDTextField;
import org.apache.pdfbox.rendering.PDFRenderer;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.parallel.Execution;
import org.junit.jupiter.api.parallel.ExecutionMode;

/**
 * Test of some the form examples.
 *
 * @author Tilman Hausherr
 */
@Execution(ExecutionMode.CONCURRENT)
class TestCreateSimpleForms
{

    /**
     * Test of CreateSimpleForm
     *
     * @throws java.io.IOException
     */
    @Test
    void testCreateSimpleForm() throws IOException
    {
        String filename = "target/TestCreateSimpleForm.pdf";
        CreateSimpleForm.main(new String[] { filename });

        try (PDDocument doc = Loader.loadPDF(new File(filename)))
        {
            new PDFRenderer(doc).renderImage(0);
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDTextField textBox = (PDTextField) acroForm.getField("SampleField");
            assertEquals("Sample field content", textBox.getValue());
            try
            {
                textBox.setValue("Łódź");
                fail("should have failed with IllegalArgumentException");
            }
            catch (IllegalArgumentException ex)
            {
                assertTrue(ex.getMessage().contains("U+0141 ('Lslash') is not available"));
            }
            PDFont font = getFontFromWidgetResources(textBox, "Helv");
            assertEquals("Helvetica", font.getName());
            assertTrue(font.isStandard14());
        }
    }

    @Test
    void testAddBorderToField() throws IOException
    {
        CreateSimpleForm.main(null);

        try (PDDocument doc = Loader.loadPDF(new File(CreateSimpleForm.DEFAULT_FILENAME)))
        {
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDTextField textBox = (PDTextField) acroForm.getField("SampleField");
            PDAnnotationWidget widget = textBox.getWidgets().get(0);
            PDAppearanceCharacteristicsDictionary appearanceCharacteristics = widget.getAppearanceCharacteristics();
            PDColor borderColour = appearanceCharacteristics.getBorderColour();
            PDColor backgroundColour = appearanceCharacteristics.getBackground();
            assertEquals(PDDeviceRGB.INSTANCE, borderColour.getColorSpace());
            assertEquals(PDDeviceRGB.INSTANCE, backgroundColour.getColorSpace());
            assertArrayEquals(new float[] { 0, 1, 0 }, borderColour.getComponents(), 0);
            assertArrayEquals(new float[] { 1, 1, 0 }, backgroundColour.getComponents(), 0);
        }

        AddBorderToField.main(null);

        try (PDDocument doc = Loader.loadPDF(new File(AddBorderToField.RESULT_FILENAME)))
        {
            new PDFRenderer(doc).renderImage(0);
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDTextField textBox = (PDTextField) acroForm.getField("SampleField");
            PDAnnotationWidget widget = textBox.getWidgets().get(0);
            PDAppearanceCharacteristicsDictionary appearanceCharacteristics = widget.getAppearanceCharacteristics();
            PDColor borderColour = appearanceCharacteristics.getBorderColour();
            assertEquals(PDDeviceRGB.INSTANCE, borderColour.getColorSpace());
            assertArrayEquals(new float[] { 1, 0, 0 }, borderColour.getComponents(), 0);
        }
    }

    /**
     * Test of CreateSimpleFormWithEmbeddedFont
     *
     * @throws java.io.IOException
     */
    @Test
    void testCreateSimpleFormWithEmbeddedFont() throws IOException
    {
        CreateSimpleFormWithEmbeddedFont.main(null);
        try (PDDocument doc = Loader.loadPDF(new File("target/SimpleFormWithEmbeddedFont.pdf")))
        {
            new PDFRenderer(doc).renderImage(0);
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDTextField textBox = (PDTextField) acroForm.getField("SampleField");
            assertEquals("Sample field İ", textBox.getValue());
            textBox.setValue("Łódź");
            PDFont font = getFontFromWidgetResources(textBox, "F1");
            assertEquals("LiberationSans", font.getName());
        }
    }

    /**
     * Test of CreateSimpleFormWithEmbeddedFont
     *
     * @throws java.io.IOException
     */
    @Test
    void testCreateMultiWidgetsForm() throws IOException
    {
        CreateMultiWidgetsForm.main(null);

        try (PDDocument doc = Loader.loadPDF(new File("target/MultiWidgetsForm.pdf")))
        {
            assertEquals(2, doc.getNumberOfPages());
            new PDFRenderer(doc).renderImage(0);
            new PDFRenderer(doc).renderImage(1);
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDTextField textBox = (PDTextField) acroForm.getField("SampleField");
            assertEquals("Sample field", textBox.getValue());
            List<PDAnnotationWidget> widgets = textBox.getWidgets();
            assertEquals(2, widgets.size());
            PDAnnotationWidget w1 = widgets.get(0);
            PDAnnotationWidget w2 = widgets.get(1);
            PDPage page1 = w1.getPage();
            PDPage page2 = w2.getPage();
            assertNotEquals(page1.getCOSObject(), page2.getCOSObject());
            assertEquals(page1, doc.getPage(0));
            assertEquals(page2, doc.getPage(1));
            assertEquals(page1.getAnnotations().get(0), w1);
            assertEquals(page2.getAnnotations().get(0), w2);
            assertNotEquals(w1, w2);
            PDAppearanceCharacteristicsDictionary appearanceCharacteristics1 = w1.getAppearanceCharacteristics();
            PDAppearanceCharacteristicsDictionary appearanceCharacteristics2 = w2.getAppearanceCharacteristics();
            PDColor backgroundColor1 = appearanceCharacteristics1.getBackground();
            PDColor backgroundColor2 = appearanceCharacteristics2.getBackground();
            PDColor borderColour1 = appearanceCharacteristics1.getBorderColour();
            PDColor borderColour2 = appearanceCharacteristics2.getBorderColour();
            assertEquals(PDDeviceRGB.INSTANCE, backgroundColor1.getColorSpace());
            assertEquals(PDDeviceRGB.INSTANCE, backgroundColor2.getColorSpace());
            assertEquals(PDDeviceRGB.INSTANCE, borderColour1.getColorSpace());
            assertEquals(PDDeviceRGB.INSTANCE, borderColour2.getColorSpace());
            assertArrayEquals(new float[] { 1, 1, 0 }, backgroundColor1.getComponents(), 0);
            assertArrayEquals(new float[] { 0, 1, 0 }, backgroundColor2.getComponents(), 0);
            assertArrayEquals(new float[] { 0, 1, 0 }, borderColour1.getComponents(), 0);
            assertArrayEquals(new float[] { 1, 0, 0 }, borderColour2.getComponents(), 0);
        }
    }

    @Test
    void testCreateCheckBox() throws IOException
    {
        CreateCheckBox.main(null);
        try (PDDocument doc = Loader.loadPDF(new File("target/CheckBoxSample.pdf")))
        {
            new PDFRenderer(doc).renderImage(0);
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDCheckBox checkbox = (PDCheckBox) acroForm.getField("MyCheckBox");
            assertEquals("Yes", checkbox.getOnValue());
            assertEquals("Off", checkbox.getValue());
            checkbox.check();
            assertEquals("Yes", checkbox.getValue());
            doc.save("target/CheckBoxSample-modified.pdf");
        }
        try (PDDocument doc = Loader.loadPDF(new File("target/CheckBoxSample-modified.pdf")))
        {
            new PDFRenderer(doc).renderImage(0);
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDCheckBox checkbox = (PDCheckBox) acroForm.getField("MyCheckBox");
            assertEquals("Yes", checkbox.getValue());
        }
    }

    @Test
    void testRadioButtons() throws IOException
    {
        CreateRadioButtons.main(null);
        try (PDDocument doc = Loader.loadPDF(new File("target/RadioButtonsSample.pdf")))
        {
            new PDFRenderer(doc).renderImage(0);
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDRadioButton radioButton = (PDRadioButton) acroForm.getField("MyRadioButton");
            assertEquals(3, radioButton.getWidgets().size());
            assertEquals("c", radioButton.getValue());
            assertEquals(1, radioButton.getSelectedExportValues().size());
            assertEquals("c", radioButton.getSelectedExportValues().get(0));
            assertEquals(3, radioButton.getExportValues().size());
            assertEquals("a", radioButton.getExportValues().get(0));
            assertEquals("b", radioButton.getExportValues().get(1));
            assertEquals("c", radioButton.getExportValues().get(2));
            radioButton.setValue("b");
            doc.save("target/RadioButtonsSample-modified.pdf");
        }
        try (PDDocument doc = Loader.loadPDF(new File("target/RadioButtonsSample-modified.pdf")))
        {
            new PDFRenderer(doc).renderImage(0);
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDRadioButton radioButton = (PDRadioButton) acroForm.getField("MyRadioButton");
            assertEquals("b", radioButton.getValue());
            assertEquals(1, radioButton.getSelectedExportValues().size());
            assertEquals("b", radioButton.getSelectedExportValues().get(0));
            assertEquals(3, radioButton.getExportValues().size());
        }
    }
    
    @Test
    void testCreatePushButton() throws IOException
    {
        CreatePushButton.main(null);
        try (PDDocument doc = Loader.loadPDF(new File("target/PushButtonSample.pdf")))
        {
            new PDFRenderer(doc).renderImage(0);
            PDAcroForm acroForm = doc.getDocumentCatalog().getAcroForm();
            PDPushButton pushButton = (PDPushButton) acroForm.getField("push");
            assertNotNull(pushButton);
        }
    }

    private PDFont getFontFromWidgetResources(PDTextField textBox, String fontResourceName) throws IOException
    {
        PDAnnotationWidget widget = textBox.getWidgets().get(0);
        PDAppearanceDictionary appearance = widget.getAppearance();
        PDAppearanceEntry normalAppearance = appearance.getNormalAppearance();
        PDAppearanceStream appearanceStream = normalAppearance.getAppearanceStream();
        PDResources resources = appearanceStream.getResources();
        return resources.getFont(COSName.getPDFName(fontResourceName));
    }
}
