Package com.itextpdf.pdfcleanup

Class PdfCleanUpLocation

java.lang.Object

com.itextpdf.pdfcleanup.PdfCleanUpLocation

       public class PdfCleanUpLocation extends Object
      

Defines the region to be erased in a PDF document.

Constructor Summary

Constructors

Constructor	Description
PdfCleanUpLocation(int page, com.itextpdf.kernel.geom.Rectangle region)	Constructs a PdfCleanUpLocation object.
PdfCleanUpLocation(int page, com.itextpdf.kernel.geom.Rectangle region, com.itextpdf.kernel.colors.Color cleanUpColor)	Constructs a PdfCleanUpLocation object.

Method Summary

Modifier and Type	Method	Description
com.itextpdf.kernel.colors.Color	getCleanUpColor()	Returns a color used to fill the area after erasing it.
int	getPage()
com.itextpdf.kernel.geom.Rectangle	getRegion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PdfCleanUpLocation

             public PdfCleanUpLocation
             (int page, com.itextpdf.kernel.geom.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, com.itextpdf.kernel.geom.Rectangle region, com.itextpdf.kernel.colors.Color 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 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. If null the erased area left uncolored.

Returns:

a color used to fill the area after erasing it.