Examples with PDAnnotationWidget com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget used on opensource projects

Example 1 with PDAnnotationWidget

use of com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget in project PdfBox-Android by TomRoush.

the class PDDocument method addSignature.

/**
 * This will add a signature to the document. If the 0-based page number in the options
 * parameter is smaller than 0 or larger than max, the nearest valid page number will be used
 * (i.e. 0 or max) and no exception will be thrown.
 * <p>
 * Only one signature may be added in a document. To sign several times,
 * load document, add signature, save incremental and close again.
 *
 * @param sigObject is the PDSignatureField model
 * @param signatureInterface is an interface whose implementation provides
 * signing capabilities. Can be null if external signing if used.
 * @param options signature options
 * @throws IOException if there is an error creating required fields
 * @throws IllegalStateException if one attempts to add several signature
 * fields.
 */
public void addSignature(PDSignature sigObject, SignatureInterface signatureInterface, SignatureOptions options) throws IOException {
    if (signatureAdded) {
        throw new IllegalStateException("Only one signature may be added in a document");
    }
    signatureAdded = true;
    // Reserve content
    // We need to reserve some space for the signature. Some signatures including
    // big certificate chain and we need enough space to store it.
    int preferredSignatureSize = options.getPreferredSignatureSize();
    if (preferredSignatureSize > 0) {
        sigObject.setContents(new byte[preferredSignatureSize]);
    } else {
        sigObject.setContents(new byte[SignatureOptions.DEFAULT_SIGNATURE_SIZE]);
    }
    // Reserve ByteRange, will be overwritten in COSWriter
    sigObject.setByteRange(RESERVE_BYTE_RANGE);
    signInterface = signatureInterface;
    // Create SignatureForm for signature and append it to the document
    // Get the first valid page
    int pageCount = getNumberOfPages();
    if (pageCount == 0) {
        throw new IllegalStateException("Cannot sign an empty document");
    }
    int startIndex = Math.min(Math.max(options.getPage(), 0), pageCount - 1);
    PDPage page = getPage(startIndex);
    // Get the AcroForm from the Root-Dictionary and append the annotation
    PDDocumentCatalog catalog = getDocumentCatalog();
    PDAcroForm acroForm = catalog.getAcroForm();
    catalog.getCOSObject().setNeedToBeUpdated(true);
    if (acroForm == null) {
        acroForm = new PDAcroForm(this);
        catalog.setAcroForm(acroForm);
    } else {
        acroForm.getCOSObject().setNeedToBeUpdated(true);
    }
    PDSignatureField signatureField = null;
    if (!(acroForm.getCOSObject().getDictionaryObject(COSName.FIELDS) instanceof COSArray)) {
        acroForm.getCOSObject().setItem(COSName.FIELDS, new COSArray());
    } else {
        COSArray fieldArray = (COSArray) acroForm.getCOSObject().getDictionaryObject(COSName.FIELDS);
        fieldArray.setNeedToBeUpdated(true);
        signatureField = findSignatureField(acroForm.getFieldIterator(), sigObject);
    }
    if (signatureField == null) {
        signatureField = new PDSignatureField(acroForm);
        // append the signature object
        signatureField.setValue(sigObject);
        // backward linking
        signatureField.getWidgets().get(0).setPage(page);
    } else {
        sigObject.getCOSObject().setNeedToBeUpdated(true);
    }
    // TODO This "overwrites" the settings of the original signature field which might not be intended by the user
    // better make it configurable (not all users need/want PDF/A but their own setting):
    // to conform PDF/A-1 requirement:
    // The /F key's Print flag bit shall be set to 1 and
    // its Hidden, Invisible and NoView flag bits shall be set to 0
    signatureField.getWidgets().get(0).setPrinted(true);
    // Set the AcroForm Fields
    List<PDField> acroFormFields = acroForm.getFields();
    acroForm.getCOSObject().setDirect(true);
    acroForm.setSignaturesExist(true);
    acroForm.setAppendOnly(true);
    boolean checkFields = checkSignatureField(acroForm.getFieldIterator(), signatureField);
    if (checkFields) {
        signatureField.getCOSObject().setNeedToBeUpdated(true);
    } else {
        acroFormFields.add(signatureField);
    }
    // Get the object from the visual signature
    COSDocument visualSignature = options.getVisualSignature();
    // Distinction of case for visual and non-visual signature
    if (visualSignature == null) {
        prepareNonVisibleSignature(signatureField);
        return;
    }
    prepareVisibleSignature(signatureField, acroForm, visualSignature);
    // Create Annotation / Field for signature
    List<PDAnnotation> annotations = page.getAnnotations();
    // Make /Annots a direct object to avoid problem if it is an existing indirect object:
    // it would not be updated in incremental save, and if we'd set the /Annots array "to be updated"
    // while keeping it indirect, Adobe Reader would claim that the document had been modified.
    page.setAnnotations(annotations);
    // take care that page and acroforms do not share the same array (if so, we don't need to add it twice)
    if (!(annotations instanceof COSArrayList && acroFormFields instanceof COSArrayList && ((COSArrayList<?>) annotations).toList().equals(((COSArrayList<?>) acroFormFields).toList()) && checkFields)) {
        PDAnnotationWidget widget = signatureField.getWidgets().get(0);
        // use check to prevent the annotation widget from appearing twice
        if (checkSignatureAnnotation(annotations, widget)) {
            widget.getCOSObject().setNeedToBeUpdated(true);
        } else {
            annotations.add(widget);
        }
    }
    page.getCOSObject().setNeedToBeUpdated(true);
}

Example 2 with PDAnnotationWidget

use of com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget in project PdfBox-Android by TomRoush.

the class PDFMergerUtility method mergeFields.

private void mergeFields(PDFCloneUtility cloner, PDField destField, PDField srcField) {
    if (destField instanceof PDNonTerminalField && srcField instanceof PDNonTerminalField) {
        Log.i("PdfBox-Android", "Skipping non terminal field " + srcField.getFullyQualifiedName());
        return;
    }
    if (destField.getFieldType() == "Tx" && destField.getFieldType() == "Tx") {
        // if the field already has multiple widgets we can add to the array
        if (destField.getCOSObject().containsKey(COSName.KIDS)) {
            COSArray widgets = destField.getCOSObject().getCOSArray(COSName.KIDS);
            for (PDAnnotationWidget srcWidget : srcField.getWidgets()) {
                try {
                    widgets.add(cloner.cloneForNewDocument(srcWidget.getCOSObject()));
                } catch (IOException ioe) {
                    Log.w("PdfBox-Android", "Unable to clone widget for source field " + srcField.getFullyQualifiedName());
                }
            }
        } else {
            COSArray widgets = new COSArray();
            try {
                COSDictionary widgetAsCOS = (COSDictionary) cloner.cloneForNewDocument(destField.getWidgets().get(0));
                cleanupWidgetCOSDictionary(widgetAsCOS, true);
                widgetAsCOS.setItem(COSName.PARENT, destField);
                widgets.add(widgetAsCOS);
                for (PDAnnotationWidget srcWidget : srcField.getWidgets()) {
                    try {
                        widgetAsCOS = (COSDictionary) cloner.cloneForNewDocument(srcWidget.getCOSObject());
                        cleanupWidgetCOSDictionary(widgetAsCOS, false);
                        widgetAsCOS.setItem(COSName.PARENT, destField);
                        widgets.add(widgetAsCOS);
                    } catch (IOException ioe) {
                        Log.w("PdfBox-Android", "Unable to clone widget for source field " + srcField.getFullyQualifiedName());
                    }
                }
                destField.getCOSObject().setItem(COSName.KIDS, widgets);
                cleanupFieldCOSDictionary(destField.getCOSObject());
            } catch (IOException ioe) {
                Log.w("PdfBox-Android", "Unable to clone widget for destination field " + destField.getFullyQualifiedName());
            }
        }
    } else {
        Log.i("PdfBox-Android", "Only merging two text fields is currently supported");
        Log.i("PdfBox-Android", "Skipping merging of " + srcField.getFullyQualifiedName() + " into " + destField.getFullyQualifiedName());
    }
}

Example 3 with PDAnnotationWidget

use of com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget in project PdfBox-Android by TomRoush.

the class HandleDifferentDALevelsTest method checkSingleAnnotation.

@Test
public void checkSingleAnnotation() throws IOException {
    PDTextField field = (PDTextField) acroForm.getField("SingleAnnotation");
    String fieldFontSetting = getFontSettingFromDA(field);
    List<PDAnnotationWidget> widgets = field.getWidgets();
    for (PDAnnotationWidget widget : widgets) {
        String contentAsString = new String(widget.getNormalAppearanceStream().getContentStream().toByteArray());
        assertTrue(contentAsString.indexOf(fieldFontSetting) > 0);
    }
}

Example 4 with PDAnnotationWidget

use of com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget in project PdfBox-Android by TomRoush.

the class PDAcroFormTest method createAcroFormWithMissingResourceInformation.

private byte[] createAcroFormWithMissingResourceInformation() throws IOException {
    PDDocument document = new PDDocument();
    PDPage page = new PDPage();
    document.addPage(page);
    PDAcroForm newAcroForm = new PDAcroForm(document);
    document.getDocumentCatalog().setAcroForm(newAcroForm);
    PDTextField textBox = new PDTextField(newAcroForm);
    textBox.setPartialName("SampleField");
    newAcroForm.getFields().add(textBox);
    PDAnnotationWidget widget = textBox.getWidgets().get(0);
    PDRectangle rect = new PDRectangle(50, 750, 200, 20);
    widget.setRectangle(rect);
    widget.setPage(page);
    page.getAnnotations().add(widget);
    // acroForm.setNeedAppearances(true);
    // acroForm.getField("SampleField").getCOSObject().setString(COSName.V, "content");
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    // this is a working PDF
    document.save(baos);
    document.close();
    return baos.toByteArray();
}

Example 5 with PDAnnotationWidget

use of com.tom_roush.pdfbox.pdmodel.interactive.annotation.PDAnnotationWidget in project PdfBox-Android by TomRoush.

the class PDButtonTest method testRadioButtonWithOptions.

@Test
public /**
 * PDFBOX-3656
 *
 * Test a radio button with options.
 * This was causing an ArrayIndexOutOfBoundsException when trying to set to "Off", as this
 * wasn't treated to be a valid option.
 *
 * @throws IOException
 */
void testRadioButtonWithOptions() {
    File file;
    PDDocument pdfDocument = null;
    try {
        file = new File(TARGET_PDF_DIR, "PDFBOX-3656.pdf");
        assumeTrue(file.exists());
        pdfDocument = PDDocument.load(file);
        PDRadioButton radioButton = (PDRadioButton) pdfDocument.getDocumentCatalog().getAcroForm().getField("Checking/Savings");
        radioButton.setValue("Off");
        for (PDAnnotationWidget widget : radioButton.getWidgets()) {
            assertEquals("The widget should be set to Off", COSName.Off, widget.getCOSObject().getItem(COSName.AS));
        }
    } catch (IOException e) {
        fail("Unexpected IOException " + e.getMessage());
    } finally {
        if (pdfDocument != null) {
            try {
                pdfDocument.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}