Package com.itextpdf.pdfcleanup

Class CleanUpProperties

java.lang.Object
com.itextpdf.pdfcleanup.CleanUpProperties
public class CleanUpProperties extends Object
Contains properties for PdfCleanUpTool operations.

  • Constructor Details

    • CleanUpProperties

      public CleanUpProperties()
      Creates default CleanUpProperties instance.

  • Method Details

    • setMetaInfo

      public CleanUpProperties setMetaInfo (com.itextpdf.commons.actions.contexts.IMetaInfo metaInfo)
      Sets additional meta info.
      Parameters:
      metaInfo - the meta info to set
      Returns:
      this CleanUpProperties instance

    • isProcessAnnotations

      public boolean isProcessAnnotations()
      Check if page annotations will be processed. Default: true.
      Returns:
      true if annotations will be processed by the PdfCleanUpTool

    • setProcessAnnotations

      public CleanUpProperties 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
      Returns:
      this CleanUpProperties instance

    • getOverlapRatio

      public Double 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

      public CleanUpProperties setOverlapRatio (Double overlapRatio)
      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
      Returns:
      this CleanUpProperties instance

    • getOffsetProperties

      public PathOffsetApproximationProperties getOffsetProperties()
      Get PathOffsetApproximationProperties specifying approximation parameters for ClipperOffset operations.
      Returns:
      PathOffsetApproximationProperties parameters

    • setOffsetProperties

      public CleanUpProperties setOffsetProperties (PathOffsetApproximationProperties offsetProperties)
      Set PathOffsetApproximationProperties specifying approximation parameters for ClipperOffset operations.
      Parameters:
      offsetProperties - PathOffsetApproximationProperties to set
      Returns:
      this CleanUpProperties instance