Package com.itextpdf.text.pdf.pdfcleanup
Class PdfCleanUpLocation
java.lang.Object
com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation
Defines the region to be erased in a PDF document.
- Since:
- 5.5.4
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionPdfCleanUpLocation
(int page, Rectangle region) Constructs aPdfCleanUpLocation
object.PdfCleanUpLocation
(int page, Rectangle region, BaseColor cleanUpColor) Constructs aPdfCleanUpLocation
object. -
Method Summary
Modifier and TypeMethodDescriptionReturns a color used to fill the area after erasing it.int
getPage()
-
Field Details
-
page
private int page -
region
-
cleanUpColor
-
-
Constructor Details
-
PdfCleanUpLocation
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
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
- Returns:
- A
Rectangle
representing the boundaries of the area to be erased.
-
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.
-