com.groupdocs.redaction.redactions

Class PageAreaFilter

java.lang.Object

com.groupdocs.redaction.redactions.RedactionFilter

com.groupdocs.redaction.redactions.PageAreaFilter

public class PageAreaFilter
extends RedactionFilter

Represents redaction filter, setting an area within a page of a document to apply redaction.

Learn more

• More details about applying redactions: Redaction basics
• More details about redaction filters: Use PDF redaction filters

Constructor Summary

Constructors

Constructor and Description
PageAreaFilter(Point topLeft, Dimension size) Initializes a new instance of PageAreaFilter class for redacting specific area.

Method Summary

Modifier and Type	Method and Description
Rectangle	getRectangle() Gets the rectangle (top-left position and size of the area) on a page.
boolean	isInTheArea(Rectangle rectangle) Checks if this filter area has intersection with given rectangle.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageAreaFilter

public PageAreaFilter(Point topLeft,
                      Dimension size)

Initializes a new instance of PageAreaFilter class for redacting specific area.

Parameters:

topLeft - Top-left area coordinates

size - Area size and color

Method Detail

getRectangle

public final Rectangle getRectangle()

Gets the rectangle (top-left position and size of the area) on a page.

Returns:

The rectangle (top-left position and size of the area) on a page.

isInTheArea

public final boolean isInTheArea(Rectangle rectangle)

Checks if this filter area has intersection with given rectangle.

Parameters:

rectangle - Rectangle to check

Returns:

true, if this filter area has intersection