Class PdfCleanUpProcessor

java.lang.Object

com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpProcessor

public class PdfCleanUpProcessor
extends Object

Represents the main mechanism for cleaning a PDF document.

Since:

5.5.4

Field Summary

Fields

Modifier and Type	Field	Description
static double	arcTolerance	Used as the criterion of a good approximation of rounded line joins and line caps.
private Map<Integer, List<Rectangle>>	clippingRects
private int	currentXObjNum
private static final String	FILL_COLOR
static boolean	fillCleanedArea
static double	floatMultiplier	When a document with line arts is being cleaned up, there are lot of calculations with floating point numbers.
private Map<Integer, List<PdfCleanUpLocation>>	pdfCleanUpLocations
private PdfStamper	pdfStamper
private Map<Integer, Set<String>>	redactAnnotIndirRefs
private static final String	STROKE_COLOR
private static final String	XOBJ_NAME_PREFIX

Constructor Summary

Constructors

Constructor	Description
PdfCleanUpProcessor(PdfStamper pdfStamper)	Creates a PdfCleanUpProcessor object.
PdfCleanUpProcessor(List<PdfCleanUpLocation> pdfCleanUpLocations, PdfStamper pdfStamper)	Creates a PdfCleanUpProcessor object based on the given List of PdfCleanUpLocations representing regions to be erased from the document.

Method Summary

Modifier and Type	Method	Description
private void	addColoredRectangle(PdfContentByte canvas, PdfCleanUpLocation cleanUpLocation)
void	cleanUp()	Cleans the document by erasing all the areas which are either provided or extracted from redaction annotations.
private void	cleanUpPage(int pageNum, List<PdfCleanUpLocation> cleanUpLocations)
private void	colorCleanedLocations(PdfContentByte canvas, List<PdfCleanUpLocation> cleanUpLocations)
private PdfCleanUpRegionFilter	createFilter(List<PdfCleanUpLocation> cleanUpLocations)
private void	deleteRedactAnnots(int pageNum)	Deletes redact annotations from the page and substitutes them with either OverlayText or RO object if it's needed.
private void	drawOverlayText(PdfContentByte canvas, List<Rectangle> textRectangles, PdfString overlayText, PdfString otDA, PdfNumber otQ, PdfBoolean otRepeat)
private List<PdfCleanUpLocation>	extractLocationsFromRedactAnnot(int page, int annotIndex, PdfDictionary annotDict)	Extracts locations from the concrete annotation.
private void	extractLocationsFromRedactAnnots()	Extracts locations from the redact annotations contained in the document.
private List<PdfCleanUpLocation>	extractLocationsFromRedactAnnots(int page, PdfDictionary pageDict)	Extracts locations from the redact annotations contained in the document and applied to the given page.
private PdfName	generateNameForXObj(PdfDictionary pageDict)
private String	getParentIndRefStr(PdfDictionary dict)
private int	getXObjNum(PdfName xobjName)
private void	insertFormXObj(PdfContentByte canvas, PdfDictionary pageDict, PdfStream formXObj, List<Rectangle> clippingRects, Rectangle annotRect)
private Map<Integer, List<PdfCleanUpLocation>>	organizeLocationsByPage(Collection<PdfCleanUpLocation> pdfCleanUpLocations)
(package private) Map<String,List>	parseDAParam(PdfString DA)
private Font	retrieveFontFromAcroForm(PdfName fontName, PdfNumber size)
private void	saveRedactAnnotIndirRef(int page, String indRefStr)
private void	setFillColor(PdfContentByte canvas, List fillColorArgs)
private void	setStrokeColor(PdfContentByte canvas, List strokeColorArgs)
private List<Rectangle>	translateQuadPointsToRectangles(PdfArray quadPoints)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

floatMultiplier

public static double floatMultiplier

When a document with line arts is being cleaned up, there are lot of calculations with floating point numbers. All of them are translated into fixed point numbers by multiplying by this coefficient. Vary it to adjust the preciseness of the calculations.

fillCleanedArea

public static boolean fillCleanedArea

arcTolerance

public static double arcTolerance

Used as the criterion of a good approximation of rounded line joins and line caps.

XOBJ_NAME_PREFIX

private static final String XOBJ_NAME_PREFIX

See Also:

• Constant Field Values

STROKE_COLOR

private static final String STROKE_COLOR

See Also:

• Constant Field Values

FILL_COLOR

private static final String FILL_COLOR

See Also:

• Constant Field Values

currentXObjNum

private int currentXObjNum

pdfStamper

private PdfStamper pdfStamper

pdfCleanUpLocations

private Map<Integer, List<PdfCleanUpLocation>> pdfCleanUpLocations

redactAnnotIndirRefs

private Map<Integer, Set<String>> redactAnnotIndirRefs

clippingRects

private Map<Integer, List<Rectangle>> clippingRects

Constructor Details

PdfCleanUpProcessor

public PdfCleanUpProcessor(List<PdfCleanUpLocation> pdfCleanUpLocations,
 PdfStamper pdfStamper)

Creates a PdfCleanUpProcessor object based on the given List of PdfCleanUpLocations representing regions to be erased from the document.

Parameters:

pdfCleanUpLocations - list of locations to be cleaned up

pdfStamper - APdfStamper object representing the document which redaction applies to.

PdfCleanUpProcessor

public PdfCleanUpProcessor(PdfStamper pdfStamper)

Creates a PdfCleanUpProcessor object. Regions to be erased from the document are extracted from the redact annotations contained inside the given document.

Parameters:

pdfStamper - APdfStamper object representing the document which redaction applies to.

Method Details

cleanUp

public void cleanUp()
             throws IOException,
DocumentException

Cleans the document by erasing all the areas which are either provided or extracted from redaction annotations.

Throws:

IOException

DocumentException

cleanUpPage

private void cleanUpPage(int pageNum,
 List<PdfCleanUpLocation> cleanUpLocations)
                  throws IOException,
DocumentException

Throws:

IOException

DocumentException

createFilter

private PdfCleanUpRegionFilter createFilter(List<PdfCleanUpLocation> cleanUpLocations)

colorCleanedLocations

private void colorCleanedLocations(PdfContentByte canvas,
 List<PdfCleanUpLocation> cleanUpLocations)

addColoredRectangle

private void addColoredRectangle(PdfContentByte canvas,
 PdfCleanUpLocation cleanUpLocation)

organizeLocationsByPage

private Map<Integer, List<PdfCleanUpLocation>> organizeLocationsByPage(Collection<PdfCleanUpLocation> pdfCleanUpLocations)

extractLocationsFromRedactAnnots

private void extractLocationsFromRedactAnnots()

Extracts locations from the redact annotations contained in the document.

extractLocationsFromRedactAnnots

private List<PdfCleanUpLocation> extractLocationsFromRedactAnnots(int page,
 PdfDictionary pageDict)

Extracts locations from the redact annotations contained in the document and applied to the given page.

saveRedactAnnotIndirRef

private void saveRedactAnnotIndirRef(int page,
 String indRefStr)

extractLocationsFromRedactAnnot

private List<PdfCleanUpLocation> extractLocationsFromRedactAnnot(int page,
 int annotIndex,
 PdfDictionary annotDict)

Extracts locations from the concrete annotation. Note: annotation can consist not only of one area specified by the RECT entry, but also of multiple areas specified by the QuadPoints entry in the annotation dictionary.

translateQuadPointsToRectangles

private List<Rectangle> translateQuadPointsToRectangles(PdfArray quadPoints)

deleteRedactAnnots

private void deleteRedactAnnots(int pageNum)
                         throws IOException,
DocumentException

Deletes redact annotations from the page and substitutes them with either OverlayText or RO object if it's needed.

Throws:

IOException

DocumentException

insertFormXObj

private void insertFormXObj(PdfContentByte canvas,
 PdfDictionary pageDict,
 PdfStream formXObj,
 List<Rectangle> clippingRects,
 Rectangle annotRect)
                     throws IOException

Throws:

IOException

drawOverlayText

private void drawOverlayText(PdfContentByte canvas,
 List<Rectangle> textRectangles,
 PdfString overlayText,
 PdfString otDA,
 PdfNumber otQ,
 PdfBoolean otRepeat)
                      throws DocumentException,
IOException

Throws:

DocumentException

IOException

retrieveFontFromAcroForm

private Font retrieveFontFromAcroForm(PdfName fontName,
 PdfNumber size)

parseDAParam

Map<String,List> parseDAParam(PdfString DA)
                       throws IOException

Throws:

IOException

getParentIndRefStr

private String getParentIndRefStr(PdfDictionary dict)

generateNameForXObj

private PdfName generateNameForXObj(PdfDictionary pageDict)

getXObjNum

private int getXObjNum(PdfName xobjName)

setFillColor

private void setFillColor(PdfContentByte canvas,
 List fillColorArgs)

setStrokeColor

private void setStrokeColor(PdfContentByte canvas,
 List strokeColorArgs)