Package com.itextpdf.pdfcleanup
Class PdfCleanUpLocation
java.lang.Object
com.itextpdf.pdfcleanup.PdfCleanUpLocation
Defines the region to be erased in a PDF document.
-
Constructor Summary
ConstructorsConstructorDescriptionPdfCleanUpLocation
(int page, com.itextpdf.kernel.geom.Rectangle region) Constructs aPdfCleanUpLocation
object.PdfCleanUpLocation
(int page, com.itextpdf.kernel.geom.Rectangle region, com.itextpdf.kernel.colors.Color cleanUpColor) Constructs aPdfCleanUpLocation
object. -
Method Summary
Modifier and TypeMethodDescriptioncom.itextpdf.kernel.colors.Color
Returns a color used to fill the area after erasing it.int
getPage()
com.itextpdf.kernel.geom.Rectangle
-
Constructor Details
-
PdfCleanUpLocation
public PdfCleanUpLocation(int page, com.itextpdf.kernel.geom.Rectangle region) Constructs aPdfCleanUpLocation
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, com.itextpdf.kernel.geom.Rectangle region, com.itextpdf.kernel.colors.Color cleanUpColor) Constructs aPdfCleanUpLocation
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. Ifnull
the erased area left uncolored.
-
-
Method Details
-
getPage
public int getPage()- Returns:
- the number of the page which the region belongs to.
-
getRegion
public com.itextpdf.kernel.geom.Rectangle getRegion()- Returns:
-
A
Rectangle
representing the boundaries of the area to be erased.
-
getCleanUpColor
public com.itextpdf.kernel.colors.Color getCleanUpColor()Returns a color used to fill the area after erasing it. Ifnull
the erased area left uncolored.- Returns:
- a color used to fill the area after erasing it.
-