Package com.itextpdf.text.pdf.pdfcleanup
Class PdfCleanUpLocation
- java.lang.Object
-
- com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation
-
public class PdfCleanUpLocation extends java.lang.Object
Defines the region to be erased in a PDF document.- Since:
- 5.5.4
-
-
Field Summary
Fields Modifier and Type Field Description private BaseColor
cleanUpColor
private int
page
private Rectangle
region
-
Constructor Summary
Constructors Constructor Description PdfCleanUpLocation(int page, Rectangle region)
Constructs aPdfCleanUpLocation
object.PdfCleanUpLocation(int page, Rectangle region, BaseColor cleanUpColor)
Constructs aPdfCleanUpLocation
object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BaseColor
getCleanUpColor()
Returns a color used to fill the area after erasing it.int
getPage()
Rectangle
getRegion()
-
-
-
Constructor Detail
-
PdfCleanUpLocation
public PdfCleanUpLocation(int page, 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, Rectangle region, BaseColor 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 Detail
-
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. Ifnull
the erased area left uncolored.- Returns:
- a color used to fill the area after erasing it.
-
-