Index (pdfSweep 4.0.0 API)

add(ICleanupStrategy) - Method in class com.itextpdf.pdfcleanup.autosweep.CompositeCleanupStrategy

Adds a cleanup strategy to this composite pattern.

addCleanupLocation(PdfCleanUpLocation) - Method in class com.itextpdf.pdfcleanup.PdfCleanUpTool

Adds a PdfCleanUpLocation to be cleaned up.

applyDashPattern(Path, LineDashPattern) - Static method in class com.itextpdf.pdfcleanup.LineDashPattern

Apply a LineDashPattern along a Path

arcTolerance - Static variable in class com.itextpdf.pdfcleanup.PdfCleanUpTool

Deprecated.

autoSweepCleanUp(PdfDocument, ICleanupStrategy) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(PdfDocument, ICleanupStrategy, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(PdfDocument, ICleanupStrategy, List) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(PdfDocument, ICleanupStrategy, List, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(PdfPage, ICleanupStrategy) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(PdfPage, ICleanupStrategy, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(PdfPage, ICleanupStrategy, List) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(PdfPage, ICleanupStrategy, List, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(InputStream, OutputStream, ICleanupStrategy) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(InputStream, OutputStream, ICleanupStrategy, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(InputStream, OutputStream, ICleanupStrategy, List) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

autoSweepCleanUp(InputStream, OutputStream, ICleanupStrategy, List, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Perform cleanup of areas of interest based on a given cleanup strategy.

beginMarkedContent(PdfName, PdfDictionary) - Method in class com.itextpdf.pdfcleanup.PdfCleanUpProcessor

CANADA_SOCIAL_SECURITY_NUMBER - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

CANADA_ZIP_CODE - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

CANNOT_OBTAIN_IMAGE_INFO_AFTER_FILTERING - Static variable in class com.itextpdf.pdfcleanup.logs.CleanUpLogMessageConstant

The Constant CANNOT_OBTAIN_IMAGE_INFO_AFTER_FILTERING.

cleanUp() - Method in class com.itextpdf.pdfcleanup.PdfCleanUpTool

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

cleanUp(PdfDocument, List) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing all the areas which are provided.

cleanUp(PdfDocument, List, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing all the areas which are provided.

cleanUp(InputStream, OutputStream, List) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing all the areas which are provided.

cleanUp(InputStream, OutputStream, List, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing all the areas which are provided.

CLEANUP_PDF - Static variable in class com.itextpdf.pdfcleanup.actions.event.PdfSweepProductEvent

Cleanup event type description.

CleanUpCsCompareUtil - Class in com.itextpdf.pdfcleanup.util

Utility class providing methods to check images compatibility.

CleanupExceptionMessageConstant - Class in com.itextpdf.pdfcleanup.exceptions

Class that bundles all the error message templates as constants.

CleanUpHelperUtil - Class in com.itextpdf.pdfcleanup.util

Utility class providing clean up helping methods.

cleanUpImage(byte[], List) - Static method in class com.itextpdf.pdfcleanup.util.CleanUpImageUtil

Clean up an image using a List of Rectangles that need to be redacted.

CleanupImageHandlingUtilException(String, Exception) - Constructor for exception com.itextpdf.pdfcleanup.util.CleanUpImageUtil.CleanupImageHandlingUtilException

Creates a new CleanUpImageUtil.CleanupImageHandlingUtilException.

CleanUpImageUtil - Class in com.itextpdf.pdfcleanup.util

Utility class providing methods to handle images and work with graphics.

CleanUpImageUtil.CleanupImageHandlingUtilException - Exception in com.itextpdf.pdfcleanup.util

Exception is thrown when errors occur during handling and cleaning up images.

CleanUpLogMessageConstant - Class in com.itextpdf.pdfcleanup.logs

Class that bundles all the log message templates as constants.

CleanUpProperties - Class in com.itextpdf.pdfcleanup

Contains properties for PdfCleanUpTool operations.

CleanUpProperties() - Constructor for class com.itextpdf.pdfcleanup.CleanUpProperties

Creates default CleanUpProperties instance.

cleanUpRedactAnnotations(PdfDocument) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing regions defined by redact annotations inside the document.

cleanUpRedactAnnotations(PdfDocument, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing regions defined by redact annotations inside the document.

cleanUpRedactAnnotations(PdfDocument, List) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing regions defined by redact annotations and additional cleanup locations inside the document.

cleanUpRedactAnnotations(PdfDocument, List, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing regions defined by redact annotations inside the document.

cleanUpRedactAnnotations(InputStream, OutputStream) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing regions defined by redact annotations inside the document.

cleanUpRedactAnnotations(InputStream, OutputStream, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing regions defined by redact annotations inside the document.

cleanUpRedactAnnotations(InputStream, OutputStream, List) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing regions defined by redact annotations and additional cleanup locations inside the document.

cleanUpRedactAnnotations(InputStream, OutputStream, List, CleanUpProperties) - Static method in class com.itextpdf.pdfcleanup.PdfCleaner

Cleans the document by erasing regions defined by redact annotations inside the document.

com.itextpdf.pdfcleanup - package com.itextpdf.pdfcleanup

com.itextpdf.pdfcleanup.actions.data - package com.itextpdf.pdfcleanup.actions.data

com.itextpdf.pdfcleanup.actions.event - package com.itextpdf.pdfcleanup.actions.event

com.itextpdf.pdfcleanup.autosweep - package com.itextpdf.pdfcleanup.autosweep

com.itextpdf.pdfcleanup.exceptions - package com.itextpdf.pdfcleanup.exceptions

com.itextpdf.pdfcleanup.logs - package com.itextpdf.pdfcleanup.logs

com.itextpdf.pdfcleanup.util - package com.itextpdf.pdfcleanup.util

CommonRegex - Class in com.itextpdf.pdfcleanup.autosweep

This class contains some of the more common regular expressions to be used for redaction.

CommonRegex() - Constructor for class com.itextpdf.pdfcleanup.autosweep.CommonRegex

CompositeCleanupStrategy - Class in com.itextpdf.pdfcleanup.autosweep

This class is a composite pattern for ICleanupStrategy.

CompositeCleanupStrategy() - Constructor for class com.itextpdf.pdfcleanup.autosweep.CompositeCleanupStrategy

Creates a composite pattern for cleanup strategies.

createCleanupPdfEvent(SequenceId, IMetaInfo) - Static method in class com.itextpdf.pdfcleanup.actions.event.PdfSweepProductEvent

Creates a cleanup-pdf event which associated with a general identifier and additional meta data.

DATE_DD_MM_YYYY - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

DATE_DD_MM_YYYY_HH_MM_SS - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

DATE_MM_DD_YYYY - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

DATE_MM_DD_YYYY_HH_MM_SS - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

DEFAULT_APPEARANCE_NOT_FOUND - Static variable in class com.itextpdf.pdfcleanup.exceptions.CleanupExceptionMessageConstant

EMAIL_ADDRESS - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

EU_CURRENCY - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

eventOccurred(IEventData, EventType) - Method in class com.itextpdf.pdfcleanup.autosweep.CompositeCleanupStrategy

eventOccurred(IEventData, EventType) - Method in class com.itextpdf.pdfcleanup.PdfCleanUpEventListener

eventOccurred(IEventData, EventType) - Method in class com.itextpdf.pdfcleanup.PdfCleanUpProcessor

FAILED_TO_PROCESS_A_TRANSFORMATION_MATRIX - Static variable in class com.itextpdf.pdfcleanup.logs.CleanUpLogMessageConstant

The Constant FAILED_TO_PROCESS_A_TRANSFORMATION_MATRIX.

floatMultiplier - Static variable in class com.itextpdf.pdfcleanup.PdfCleanUpTool

Deprecated.

getCleanUpColor() - Method in class com.itextpdf.pdfcleanup.PdfCleanUpLocation

Returns a color used to fill the area after erasing it.

getDashArray() - Method in class com.itextpdf.pdfcleanup.LineDashPattern

Getter for the dash array.

getDashPhase() - Method in class com.itextpdf.pdfcleanup.LineDashPattern

Getter for the dash phase.

getEventListener() - Method in class com.itextpdf.pdfcleanup.PdfCleanUpProcessor

getEventType() - Method in class com.itextpdf.pdfcleanup.actions.event.PdfSweepProductEvent

getImageRectToClean(Rectangle, int, int) - Static method in class com.itextpdf.pdfcleanup.util.CleanUpHelperUtil

Calculates the coordinates of the image rectangle to clean by the passed Rectangle, specifying the area to clean.

getInstance() - Static method in class com.itextpdf.pdfcleanup.actions.data.PdfSweepProductData

Getter for an instance of ProductData related to iText pdfSweep module.

getPage() - Method in class com.itextpdf.pdfcleanup.PdfCleanUpLocation

getPdfCleanUpLocations(PdfDocument) - Method in class com.itextpdf.pdfcleanup.autosweep.PdfAutoSweepTools

Get all PdfCleanUpLocation objects from a given PdfDocument.

getPdfCleanUpLocations(PdfPage) - Method in class com.itextpdf.pdfcleanup.autosweep.PdfAutoSweepTools

Get all PdfCleanUpLocation objects from a given PdfPage.

getRedactionColor(IPdfTextLocation) - Method in class com.itextpdf.pdfcleanup.autosweep.CompositeCleanupStrategy

Get the color in which redaction is to take place

getRedactionColor(IPdfTextLocation) - Method in interface com.itextpdf.pdfcleanup.autosweep.ICleanupStrategy

Get the color in which redaction is to take place

getRedactionColor(IPdfTextLocation) - Method in class com.itextpdf.pdfcleanup.autosweep.RegexBasedCleanupStrategy

Get the color in which redaction is to take place

getRegion() - Method in class com.itextpdf.pdfcleanup.PdfCleanUpLocation

getResultantLocations() - Method in class com.itextpdf.pdfcleanup.autosweep.CompositeCleanupStrategy

getSupportedEvents() - Method in class com.itextpdf.pdfcleanup.autosweep.CompositeCleanupStrategy

getSupportedEvents() - Method in class com.itextpdf.pdfcleanup.PdfCleanUpEventListener

highlight(PdfDocument) - Method in class com.itextpdf.pdfcleanup.autosweep.PdfAutoSweepTools

Highlight areas of interest in a given PdfDocument

highlight(PdfPage) - Method in class com.itextpdf.pdfcleanup.autosweep.PdfAutoSweepTools

Highlight areas of interest in a given PdfPage

HTTP_URL - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

ICleanupStrategy - Interface in com.itextpdf.pdfcleanup.autosweep

This class represents a generic cleanup strategy to be used with PdfCleaner or PdfAutoSweepTools ICleanupStrategy must implement Cloneable to ensure a strategy can be reset after having handled a page.

IMAGE_MASK_CLEAN_UP_NOT_SUPPORTED - Static variable in class com.itextpdf.pdfcleanup.logs.CleanUpLogMessageConstant

The Constant IMAGE_MASK_CLEAN_UP_NOT_SUPPORTED.

invokeOperator(PdfLiteral, List) - Method in class com.itextpdf.pdfcleanup.PdfCleanUpProcessor

IPV4_ADDRESS - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

IPV6_ADDRESS - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

isOriginalCsCompatible(PdfImageXObject, PdfImageXObject) - Static method in class com.itextpdf.pdfcleanup.util.CleanUpCsCompareUtil

Check whether the image info of the passed original image and the image info of the cleared image are the same.

isProcessAnnotations() - Method in class com.itextpdf.pdfcleanup.CleanUpProperties

Check if page annotations will be processed.

isSolid() - Method in class com.itextpdf.pdfcleanup.LineDashPattern

Checks whether the dashed pattern is solid or not.

LineDashPattern - Class in com.itextpdf.pdfcleanup

Represents the line dash pattern.

LineDashPattern(PdfArray, float) - Constructor for class com.itextpdf.pdfcleanup.LineDashPattern

Creates new LineDashPattern object.

LineDashPattern.DashArrayElem - Class in com.itextpdf.pdfcleanup

Class representing a single element of a dash array

MAC_ADDRESS - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

MODERN_ROMAN_NUMERALS_FLEXIBLE - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

MODERN_ROMAN_NUMERALS_STRICT - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

NONINVERTIBLE_MATRIX_CANNOT_BE_PROCESSED - Static variable in class com.itextpdf.pdfcleanup.exceptions.CleanupExceptionMessageConstant

PDF_DOCUMENT_MUST_BE_OPENED_IN_STAMPING_MODE - Static variable in class com.itextpdf.pdfcleanup.exceptions.CleanupExceptionMessageConstant

PDF_SWEEP_PRODUCT_NAME - Static variable in class com.itextpdf.pdfcleanup.actions.data.PdfSweepProductData

PDF_SWEEP_PUBLIC_PRODUCT_NAME - Static variable in class com.itextpdf.pdfcleanup.actions.data.PdfSweepProductData

PdfAutoSweepTools - Class in com.itextpdf.pdfcleanup.autosweep

Class that automatically extracts all regions of interest from a given PdfDocument and redacts them.

PdfAutoSweepTools(ICleanupStrategy) - Constructor for class com.itextpdf.pdfcleanup.autosweep.PdfAutoSweepTools

Construct a new instance of PdfAutoSweepTools with a given ICleanupStrategy

PdfCleaner - Class in com.itextpdf.pdfcleanup

Main entry point for cleaning a PDF document.

PdfCleanUpEventListener - Class in com.itextpdf.pdfcleanup

An event listener which handles cleanup related events.

PdfCleanUpEventListener() - Constructor for class com.itextpdf.pdfcleanup.PdfCleanUpEventListener

PdfCleanUpLocation - Class in com.itextpdf.pdfcleanup

Defines the region to be erased in a PDF document.

PdfCleanUpLocation(int, Rectangle) - Constructor for class com.itextpdf.pdfcleanup.PdfCleanUpLocation

Constructs a PdfCleanUpLocation object.

PdfCleanUpLocation(int, Rectangle, Color) - Constructor for class com.itextpdf.pdfcleanup.PdfCleanUpLocation

Constructs a PdfCleanUpLocation object.

PdfCleanUpProcessor - Class in com.itextpdf.pdfcleanup

PDF content stream processor, which filters content to be cleaned up.

PdfCleanUpTool - Class in com.itextpdf.pdfcleanup

Represents the main mechanism for cleaning a PDF document.

PdfCleanUpTool(PdfDocument) - Constructor for class com.itextpdf.pdfcleanup.PdfCleanUpTool

Creates a PdfCleanUpTool object.

PdfCleanUpTool(PdfDocument, boolean, CleanUpProperties) - Constructor for class com.itextpdf.pdfcleanup.PdfCleanUpTool

Creates a PdfCleanUpTool object.

PdfCleanUpTool(PdfDocument, List, CleanUpProperties) - Constructor for class com.itextpdf.pdfcleanup.PdfCleanUpTool

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

PdfSweepProductData - Class in com.itextpdf.pdfcleanup.actions.data

Stores an instance of ProductData related to iText pdfSweep module.

PdfSweepProductEvent - Class in com.itextpdf.pdfcleanup.actions.event

Class represents events registered in iText cleanup module.

processContent(byte[], PdfResources) - Method in class com.itextpdf.pdfcleanup.PdfCleanUpProcessor

processPageAnnotations(PdfPage, List, boolean) - Method in class com.itextpdf.pdfcleanup.PdfCleanUpProcessor

Process the annotations of a page.

processPageContent(PdfPage) - Method in class com.itextpdf.pdfcleanup.PdfCleanUpProcessor

REDACTION_OF_ANNOTATION_TYPE_WATERMARK_IS_NOT_SUPPORTED - Static variable in class com.itextpdf.pdfcleanup.logs.CleanUpLogMessageConstant

The Constant REDACTION_OF_ANNOTATION_TYPE_WATERMARK_IS_NOT_SUPPORTED.

RegexBasedCleanupStrategy - Class in com.itextpdf.pdfcleanup.autosweep

This class represents a regular expression based cleanup strategy

RegexBasedCleanupStrategy(String) - Constructor for class com.itextpdf.pdfcleanup.autosweep.RegexBasedCleanupStrategy

Creates an object of regular expression based cleanup strategy.

RegexBasedCleanupStrategy(Pattern) - Constructor for class com.itextpdf.pdfcleanup.autosweep.RegexBasedCleanupStrategy

Creates an object of regular expression based cleanup strategy.

reset() - Method in class com.itextpdf.pdfcleanup.autosweep.CompositeCleanupStrategy

Returns a cleanup strategy which represents a reset composite cleanup strategy.

reset() - Method in interface com.itextpdf.pdfcleanup.autosweep.ICleanupStrategy

ICleanupStrategy objects have to be reset at times PdfAutoSweep will use the same strategy for all pages, and expects to receive only the rectangles from the last page as output.

reset() - Method in class com.itextpdf.pdfcleanup.autosweep.RegexBasedCleanupStrategy

Returns an ICleanupStrategy object which is set to this regular pattern and redaction color.

setDashArray(PdfArray) - Method in class com.itextpdf.pdfcleanup.LineDashPattern

Setter for the dash array.

setDashPhase(float) - Method in class com.itextpdf.pdfcleanup.LineDashPattern

Setter for the dash phase.

setMetaInfo(IMetaInfo) - Method in class com.itextpdf.pdfcleanup.CleanUpProperties

Sets additional meta info.

setProcessAnnotations(boolean) - Method in class com.itextpdf.pdfcleanup.CleanUpProperties

Set if page annotations will be processed.

setRedactionColor(Color) - Method in class com.itextpdf.pdfcleanup.autosweep.RegexBasedCleanupStrategy

Sets the color in which redaction is to take place.

tentativeCleanUp(PdfDocument) - Method in class com.itextpdf.pdfcleanup.autosweep.PdfAutoSweepTools

Perform tentative cleanup of areas of interest on a given PdfDocument This method will add all redaction annotations to the given document, allowing the end-user to choose which redactions to keep or delete.

tentativeCleanUp(PdfPage) - Method in class com.itextpdf.pdfcleanup.autosweep.PdfAutoSweepTools

Perform tentative cleanup of areas of interest on a given PdfPage This method will add all redaction annotations to the given page, allowing the end-user to choose which redactions to keep or delete.

UK_CURRENCY - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

UK_SOCIAL_SECURITY_NUMBER - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

UK_ZIP_CODE - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

UNSUPPORTED_IMAGE_TYPE - Static variable in class com.itextpdf.pdfcleanup.exceptions.CleanupExceptionMessageConstant

US_CURRENCY - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

US_SOCIAL_SECURITY_NUMBER - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex

US_ZIP_CODE - Static variable in class com.itextpdf.pdfcleanup.autosweep.CommonRegex