com.groupdocs.redaction.redactions

Class PageRangeFilter

java.lang.Object

com.groupdocs.redaction.redactions.RedactionFilter

com.groupdocs.redaction.redactions.PageRangeFilter

public class PageRangeFilter
extends RedactionFilter

Represents redaction filter, setting page range inside 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
PageRangeFilter(PageSeekOrigin origin, int index, int count) Initializes a new instance of RemovePageRedaction class.

Method Summary

Modifier and Type	Method and Description
int	getCount() Gets the count of pages to remove.
int	getIndex() Gets start position index (0-based).
PageSeekOrigin	getOrigin() Gets seek reference position, the beginning or the end of a document.
boolean	isPageInRange(int pageIndex, int pageCount) Checks if this filter page range contains given page.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageRangeFilter

public PageRangeFilter(PageSeekOrigin origin,
                       int index,
                       int count)

Initializes a new instance of RemovePageRedaction class.

Parameters:

origin - Seek reference position, the beginning or the end of a document

index - Start position index (0-based)

count - Count of pages to remove

Method Detail

getCount

public final int getCount()

Gets the count of pages to remove.

Returns:

The count of pages to remove.

getIndex

public final int getIndex()

Gets start position index (0-based).

Returns:

Start position index (0-based).

getOrigin

public final PageSeekOrigin getOrigin()

Gets seek reference position, the beginning or the end of a document.

Returns:

Seek reference position, the beginning or the end of a document.

isPageInRange

public final boolean isPageInRange(int pageIndex,
                                   int pageCount)

Checks if this filter page range contains given page.

Parameters:

pageIndex - index of the page (zero-bazed)

pageCount - total page count

Returns:

true, if this filter range contains page