PageRange Leave feedback
On this page
Inheritance: java.lang.Object
public class PageRange
Encapsulates one page range, which can have open or closed bounds. By default is “fully open” - it includes all existing pages. Page numbering starts from 1, not from 0.
Immutable struct, that encapsulates a page range, which is not related to any specific document, and can represent a page range for any document.
| Constructor | Description |
|---|---|
| PageRange() |
| Field | Description |
|---|---|
| AllPages | Represents all existing pages of a document. |
| Method | Description |
|---|---|
| getStartNumber() | Inclusive start page number, from which this page range starts. |
| getEndNumber() | Exclusive end page number, until which this page range continues and on which is stops exclusively. |
| getCount() | Numbers of pages within range. |
| isDefault() | Indicates whether this instance represents a default “fully open” page range i.e. |
| equals(PageRange other) | Detects whether this instance of PageRange is equal to specified |
| fromBeginningWithCount(int pageCount) | Creates a page range, that starts from the first page and has specified amount of pages |
| fromStartPageTillEnd(int startPageNumber) | Creates a page range, that starts from the specified page number and continues till the end of the document |
| fromStartPageWithCount(int startPageNumber, int pageCount) | Creates a page range, that starts from the specified page number and has specified amount of pages, or unlimited page count (till the end) |
| fromStartPageTillEndPage(int startPageNumber, int endPageNumber) | Creates a page range, that starts from the specified page number (inclusively) and continues until the specified page number (exclusively) |
public PageRange()
public static final PageRange AllPages
Represents all existing pages of a document. Default value.
public final int getStartNumber()
Inclusive start page number, from which this page range starts. If 1 - page range starts from the first page of a document
Returns: int
public final int getEndNumber()
Exclusive end page number, until which this page range continues and on which is stops exclusively. If 0 - page range spreads until end of the document
Returns: int
public final int getCount()
Numbers of pages within range. If 0 - page range spreads until end of the document no matter how much pages it consists of
Returns: int
public final boolean isDefault()
Indicates whether this instance represents a default “fully open” page range i.e. it consists all pages of a document
Returns: boolean
public final boolean equals(PageRange other)
Detects whether this instance of PageRange is equal to specified
Parameters:
| Parameter | Type | Description |
|---|---|---|
| other | PageRange | Other PageRange instance to check on equality |
Returns: boolean - true is are equal; false if are unequal
public static PageRange fromBeginningWithCount(int pageCount)
Creates a page range, that starts from the first page and has specified amount of pages
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageCount | int | Number of pages, must be strictly bigger than zero |
Returns: PageRange - New PageRange instance
public static PageRange fromStartPageTillEnd(int startPageNumber)
Creates a page range, that starts from the specified page number and continues till the end of the document
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startPageNumber | int | Page number, from which page range starts, inclusively. Page numbers are 1-based, so must be strictly bigger than zero |
Returns: PageRange - New PageRange instance
public static PageRange fromStartPageWithCount(int startPageNumber, int pageCount)
Creates a page range, that starts from the specified page number and has specified amount of pages, or unlimited page count (till the end)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startPageNumber | int | Page number, from which page range starts, inclusively. Page numbers are 1-based, so must be strictly bigger than zero |
| pageCount | int | Number of pages, must be strictly bigger than zero. If zero - this means all pages till the end of a document |
Returns: PageRange - New PageRange instance
public static PageRange fromStartPageTillEndPage(int startPageNumber, int endPageNumber)
Creates a page range, that starts from the specified page number (inclusively) and continues until the specified page number (exclusively)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| startPageNumber | int | Page number, from which page range starts, inclusively. Page numbers are 1-based, so must be strictly bigger than zero |
| endPageNumber | int | Page number, until which page range continues, exclusively. Page numbers are 1-based, so must be strictly bigger than zero, and also must be strictly greater than startPageNumber |
Returns: PageRange -
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.