com.itextpdf.kernel.utils

Class PageRange

java.lang.Object

com.itextpdf.kernel.utils.PageRange

public class PageRange
extends Object

Class representing a page range, for instance a page range can contain pages 5, then pages 10 through 15, then page 18, then page 21 and so on.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PageRange.IPageRangePart Inner interface for range parts definition
static class	PageRange.PageRangePartAfter Class for range part containing a range of pages for all pages after a given start page
static class	PageRange.PageRangePartAnd Class for range part based on several range parts.
static class	PageRange.PageRangePartOddEven Class for range part for all even or odd pages.
static class	PageRange.PageRangePartSequence Class for range part containing a range of pages represented by a start and an end page
static class	PageRange.PageRangePartSingle Class for range part containing a single page

Constructor Summary

Constructors

Constructor and Description
PageRange() Constructs an empty PageRange instance.
PageRange(String pageRange) Constructs a PageRange instance from a range in a string form, for example: "1-12, 15, 45-66".

Method Summary

Modifier and Type	Method and Description
PageRange	addPageRangePart(PageRange.IPageRangePart part) Adds any page range part to this page range.
PageRange	addPageSequence(int startPageNumber, int endPageNumber) Adds a page sequence to the range.
PageRange	addSinglePage(int pageNumber) Adds a single page to the range.
boolean	equals(Object obj)
List<Integer>	getAllPages() Deprecated. Please use getQualifyingPageNums(int)
List<Integer>	getQualifyingPageNums(int nbPages) Gets the list of pages that have been added to the range so far.
int	hashCode()
boolean	isPageInRange(int pageNumber) Checks if a given page is present in the range built so far.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageRange

public PageRange()

Constructs an empty PageRange instance.

PageRange

public PageRange(String pageRange)

Constructs a PageRange instance from a range in a string form, for example: "1-12, 15, 45-66". More advanced forms are also available, for example: - "3-" to indicate from page 3 to the last page - "odd" for all odd pages - "even" for all even pages - "3- & odd" for all odd pages starting from page 3 A complete example for pages 1 to 5, page 8 then odd pages starting from page 9: "1-5, 8, odd & 9-".

Parameters:

pageRange - a String of page ranges

Method Detail

addPageRangePart

public PageRange addPageRangePart(PageRange.IPageRangePart part)

Adds any page range part to this page range. Users may define and plug in custom implementations for behavior not found in the standard library.

Parameters:

part - a custom implementation of PageRange.IPageRangePart

Returns:

this range, already modified

addPageSequence

public PageRange addPageSequence(int startPageNumber,
                                 int endPageNumber)

Adds a page sequence to the range.

Parameters:

startPageNumber - the starting page number of the sequence

endPageNumber - the finishing page number of the sequence

Returns:

this range, already modified

addSinglePage

public PageRange addSinglePage(int pageNumber)

Adds a single page to the range.

Parameters:

pageNumber - the page number to add

Returns:

this range, already modified

getAllPages

@Deprecated
public List<Integer> getAllPages()

Deprecated. Please use getQualifyingPageNums(int)

Gets the list of pages that have been added to the range so far. This method has been deprecated in favor of an alternative method that requires the user to supply the total number of pages in the document. This number is necessary in order to limit open-ended ranges like "4-".

Returns:

the list containing page numbers added to the range

getQualifyingPageNums

public List<Integer> getQualifyingPageNums(int nbPages)

Gets the list of pages that have been added to the range so far.

Parameters:

nbPages - number of pages of the document to get the pages, to list only the pages eligible for this document.

Returns:

the list containing page numbers added to the range matching this document

isPageInRange

public boolean isPageInRange(int pageNumber)

Checks if a given page is present in the range built so far.

Parameters:

pageNumber - the page number to check

Returns:

true if the page is present in this range, false otherwise

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object