Class PdfCleanUpLocation

java.lang.Object
com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation

public class PdfCleanUpLocation extends Object
Defines the region to be erased in a PDF document.
Since:
5.5.4
  • Field Details

    • page

      private int page
    • region

      private Rectangle region
    • cleanUpColor

      private BaseColor cleanUpColor
  • Constructor Details

    • PdfCleanUpLocation

      public PdfCleanUpLocation(int page, Rectangle region)
      Constructs a PdfCleanUpLocation object.
      Parameters:
      page - specifies the number of the page which the region belongs to.
      region - represents the boundaries of the area to be erased.
    • PdfCleanUpLocation

      public PdfCleanUpLocation(int page, Rectangle region, BaseColor cleanUpColor)
      Constructs a PdfCleanUpLocation object.
      Parameters:
      page - specifies the number of the page which the region belongs to.
      region - represents the boundaries of the area to be erased.
      cleanUpColor - a color used to fill the area after erasing it. If null the erased area left uncolored.
  • Method Details

    • getPage

      public int getPage()
      Returns:
      the number of the page which the region belongs to.
    • getRegion

      public Rectangle getRegion()
      Returns:
      A Rectangle representing the boundaries of the area to be erased.
    • getCleanUpColor

      public BaseColor getCleanUpColor()
      Returns a color used to fill the area after erasing it. If null the erased area left uncolored.
      Returns:
      a color used to fill the area after erasing it.