com.itextpdf.kernel.utils.PdfAnnotationFlattener Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2024 Apryse Group NV
Authors: Apryse Software.
This program is offered under a commercial and under the AGPL license.
For commercial licensing, contact us at https://itextpdf.com/sales. For AGPL licensing, see below.
AGPL licensing:
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see
* This class can be used to remove interactive elements from a PDF document.
*/
public class PdfAnnotationFlattener {
private final PdfAnnotationFlattenFactory pdfAnnotationFlattenFactory;
/**
* Creates a new instance of {@link PdfAnnotationFlattener}.
*
* @param pdfAnnotationFlattenFactory the factory for creating annotation flatten workers
*/
public PdfAnnotationFlattener(PdfAnnotationFlattenFactory pdfAnnotationFlattenFactory) {
this.pdfAnnotationFlattenFactory = pdfAnnotationFlattenFactory;
}
/**
* Creates a new instance of {@link PdfAnnotationFlattener}.
* The default factory will be used for creating annotation flatten workers.
*/
public PdfAnnotationFlattener() {
this.pdfAnnotationFlattenFactory = new PdfAnnotationFlattenFactory();
}
/**
* Flattens the annotations on the page according to the defined implementation of
* {@link IAnnotationFlattener}.
*
* @param annotationsToFlatten the annotations that should be flattened.
*
* @return the list of annotations that were not flattened successfully
*/
public List flatten(List annotationsToFlatten) {
if (annotationsToFlatten == null) {
throw new PdfException(
MessageFormatUtil.format(KernelExceptionMessageConstant.ARG_SHOULD_NOT_BE_NULL,
"annotationsToFlatten"));
}
final List unFlattenedAnnotations = new ArrayList<>();
for (final PdfAnnotation pdfAnnotation : annotationsToFlatten) {
if (pdfAnnotation == null) {
continue;
}
PdfPage page = pdfAnnotation.getPage();
if (page == null) {
continue;
}
final IAnnotationFlattener worker = pdfAnnotationFlattenFactory.getAnnotationFlattenWorker(
pdfAnnotation.getSubtype());
final boolean flattenedSuccessfully = worker.flatten(pdfAnnotation, page);
if (!flattenedSuccessfully) {
unFlattenedAnnotations.add(pdfAnnotation);
}
}
return unFlattenedAnnotations;
}
/**
* Flattens the annotations on the page according to the defined implementation of
* {@link IAnnotationFlattener}.
*
* @param document the document that contains the annotations that should be flattened.
*
* @return the list of annotations that were not flattened successfully
*/
public List flatten(PdfDocument document) {
if (document == null) {
throw new PdfException(
MessageFormatUtil.format(KernelExceptionMessageConstant.ARG_SHOULD_NOT_BE_NULL, "document"));
}
final List annotations = new ArrayList<>();
// Process page by page to avoid loading a bunch of annotations into memory
final int documentNumberOfPages = document.getNumberOfPages();
for (int i = 1; i <= documentNumberOfPages; i++) {
final PdfPage page = document.getPage(i);
final List failedFlatteningAnnotations = flatten(page.getAnnotations());
annotations.addAll(failedFlatteningAnnotations);
}
return annotations;
}
}