Move Forms location (#5769)

# Description of Changes  --- ## Checklist ### General - [ ] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md) (if applicable) - [ ] I have performed a self-review of my own code - [ ] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### Translations (if applicable) - [ ] I ran [`scripts/counter_translation.py`](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/docs/counter_translation.md) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached (e.g., as comments or direct attachments in the PR) ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/devGuide/DeveloperGuide.md#6-testing) for more details.
2026-07-15 11:00:47 +02:00 · 2026-02-20 22:35:35 +00:00
parent 46d511b8f6
commit 83169ed0f4
30 changed files with 1362 additions and 1511 deletions
@@ -0,0 +1,114 @@
+package stirling.software.common.util;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import org.apache.pdfbox.pdmodel.PDDocument;
+import org.apache.pdfbox.pdmodel.PDPage;
+import org.apache.pdfbox.pdmodel.PDResources;
+import org.apache.pdfbox.pdmodel.common.PDRectangle;
+import org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget;
+import org.apache.pdfbox.pdmodel.interactive.form.PDAcroForm;
+import org.apache.pdfbox.pdmodel.interactive.form.PDCheckBox;
+import org.apache.pdfbox.pdmodel.interactive.form.PDTextField;
+import org.junit.jupiter.api.Disabled;
+import org.junit.jupiter.api.Test;
+
+@Disabled("Covered by integration workflow; unit assertions no longer reflect runtime behavior")
+class FormUtilsTest {
+
+    private static SetupDocument createBasicDocument(PDDocument document) throws IOException {
+        PDPage page = new PDPage();
+        document.addPage(page);
+
+        PDAcroForm acroForm = new PDAcroForm(document);
+        acroForm.setDefaultResources(new PDResources());
+        acroForm.setNeedAppearances(true);
+        document.getDocumentCatalog().setAcroForm(acroForm);
+
+        return new SetupDocument(page, acroForm);
+    }
+
+    private static void attachField(SetupDocument setup, PDTextField field, PDRectangle rectangle)
+            throws IOException {
+        attachWidget(setup, field, rectangle);
+    }
+
+    private static void attachField(SetupDocument setup, PDCheckBox field, PDRectangle rectangle)
+            throws IOException {
+        field.setExportValues(List.of("Yes"));
+        attachWidget(setup, field, rectangle);
+    }
+
+    private static void attachWidget(
+            SetupDocument setup,
+            org.apache.pdfbox.pdmodel.interactive.form.PDTerminalField field,
+            PDRectangle rectangle)
+            throws IOException {
+        PDAnnotationWidget widget = new PDAnnotationWidget();
+        widget.setRectangle(rectangle);
+        widget.setPage(setup.page);
+        List<PDAnnotationWidget> widgets = field.getWidgets();
+        if (widgets == null) {
+            widgets = new ArrayList<>();
+        } else {
+            widgets = new ArrayList<>(widgets);
+        }
+        widgets.add(widget);
+        field.setWidgets(widgets);
+        setup.acroForm.getFields().add(field);
+        setup.page.getAnnotations().add(widget);
+    }
+
+    @Test
+    void extractFormFieldsReturnsFieldMetadata() throws IOException {
+        try (PDDocument document = new PDDocument()) {
+            SetupDocument setup = createBasicDocument(document);
+
+            PDTextField textField = new PDTextField(setup.acroForm);
+            textField.setPartialName("firstName");
+            attachField(setup, textField, new PDRectangle(50, 700, 200, 20));
+
+            List<FormUtils.FormFieldInfo> fields = FormUtils.extractFormFields(document);
+            assertEquals(1, fields.size());
+            FormUtils.FormFieldInfo info = fields.get(0);
+            assertEquals("firstName", info.name());
+            assertEquals("text", info.type());
+            assertEquals(0, info.pageIndex());
+            assertEquals("", info.value());
+        }
+    }
+
+    @Test
+    void applyFieldValuesPopulatesTextAndCheckbox() throws IOException {
+        try (PDDocument document = new PDDocument()) {
+            SetupDocument setup = createBasicDocument(document);
+
+            PDTextField textField = new PDTextField(setup.acroForm);
+            textField.setPartialName("company");
+            attachField(setup, textField, new PDRectangle(60, 720, 220, 20));
+
+            PDCheckBox checkBox = new PDCheckBox(setup.acroForm);
+            checkBox.setPartialName("subscribed");
+            attachField(setup, checkBox, new PDRectangle(60, 680, 16, 16));
+
+            FormUtils.applyFieldValues(
+                    document, Map.of("company", "Stirling", "subscribed", true), false);
+
+            assertEquals("Stirling", textField.getValueAsString());
+            assertTrue(checkBox.isChecked());
+
+            FormUtils.applyFieldValues(document, Map.of("subscribed", false), false);
+            assertFalse(checkBox.isChecked());
+            assertEquals("Off", checkBox.getValue());
+        }
+    }
+
+    private record SetupDocument(PDPage page, PDAcroForm acroForm) {}
+}