Package com.itextpdf.pdfcleanup
Class CleanUpProperties
java.lang.Object
com.itextpdf.pdfcleanup.CleanUpProperties
Contains properties for
PdfCleanUpTool
operations.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the overlap ratio.boolean
Check if page annotations will be processed.void
setMetaInfo
(com.itextpdf.commons.actions.contexts.IMetaInfo metaInfo) Sets additional meta info.void
setOverlapRatio
(Double overlapRatio) Sets the overlap ratio.void
setProcessAnnotations
(boolean processAnnotations) Set if page annotations will be processed.
-
Constructor Details
-
CleanUpProperties
public CleanUpProperties()Creates default CleanUpProperties instance.
-
-
Method Details
-
setMetaInfo
public void setMetaInfo(com.itextpdf.commons.actions.contexts.IMetaInfo metaInfo) Sets additional meta info.- Parameters:
-
metaInfo
- the meta info to set
-
isProcessAnnotations
public boolean isProcessAnnotations()Check if page annotations will be processed. Default:true
.- Returns:
-
true
if annotations will be processed by thePdfCleanUpTool
-
setProcessAnnotations
public void setProcessAnnotations(boolean processAnnotations) Set if page annotations will be processed. Default processing behaviour: remove annotation if there is overlap with a redaction region.- Parameters:
-
processAnnotations
- is page annotations will be processed
-
getOverlapRatio
Gets the overlap ratio. This is a value between 0 and 1 that indicates how much the content region should overlap with the redaction area to be removed.- Returns:
-
the overlap ratio or
null
if it has not been set.
-
setOverlapRatio
Sets the overlap ratio. This is a value between 0 and 1 that indicates how much the content region should overlap with the redaction area to be removed.Example: if the overlap ratio is set to 0.3, the content region will be removed if it overlaps with the redaction area by at least 30%.
- Parameters:
-
overlapRatio
- The overlap ratio to set.
-