Foxit PDF SDK
|
Public Member Functions | |
Range () | |
Constructor. | |
Range (int index) | |
Constructor, with a single index. More... | |
Range (int start_index, int end_index, int filter) | |
Constructor, with a specified index range. More... | |
Range (Range other) | |
Constructor, with another range object. More... | |
void | addSegment (int start_index, int end_index, int filter) |
Add a new range segment. (Reverse ordering is legal.) More... | |
void | addSingle (int index) |
Add an index as a new range segment. More... | |
synchronized void | delete () |
Clean up related resources immediately. More... | |
int | getSegmentCount () throws com.foxit.sdk.PDFException |
Get the count of range segments. More... | |
int | getSegmentEnd (int segment_index) throws com.foxit.sdk.PDFException |
Get the end index of a specified range segment. More... | |
int | getSegmentStart (int segment_index) throws com.foxit.sdk.PDFException |
Get the start index of a specified range segment. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
void | removeAll () throws com.foxit.sdk.PDFException |
Remove all range segments. More... | |
Static Public Attributes | |
static final int | e_All = 0 |
All the indexes within a range will be used. | |
static final int | e_Even = 1 |
Only even numbers in a range will be used (discards odd numbers). | |
static final int | e_Odd = 2 |
Only odd numbers in a range will be used (discards even numbers). | |
This class represents index range. Here, a range consists of one or more segments and each segment consists of one single index or a group of consecutive indexes.
For some special case, such as used in com.foxit.sdk.pdf.HeaderFooter , index values specified in this range represent page numbers directly instead of page indexes.
com.foxit.sdk.common.Range.Range | ( | int | index | ) |
Constructor, with a single index.
[in] | index | A single index. |
com.foxit.sdk.common.Range.Range | ( | int | start_index, |
int | end_index, | ||
int | filter | ||
) |
Constructor, with a specified index range.
[in] | start_index | The start index of a range segment. |
[in] | end_index | The end index of a range segment. |
[in] | filter | Filter type to decide which indexes of this range would be used. Please refer to values starting from com.foxit.sdk.common.Range.e_All and this should be one of these values. Specially, when this value is com.foxit.sdk.common.Range.e_Even or com.foxit.sdk.common.Range.e_Odd , that means each even or odd number within the specified range segment will be treated as a single segment. |
com.foxit.sdk.common.Range.Range | ( | Range | other | ) |
Constructor, with another range object.
[in] | other | Another range object. |
void com.foxit.sdk.common.Range.addSegment | ( | int | start_index, |
int | end_index, | ||
int | filter | ||
) |
Add a new range segment. (Reverse ordering is legal.)
[in] | start_index | The start index of a new range segment. |
[in] | end_index | The end index of a new range segment. |
[in] | filter | Filter type to decide which indexes of this range would be used. Please refer to values starting from com.foxit.sdk.common.Range.e_All and this should be one of these values. Specially, when this value is com.foxit.sdk.common.Range.e_Even or com.foxit.sdk.common.Range.e_Odd , that means each even or odd number within the specified range segment will be treated as a single segment. |
void com.foxit.sdk.common.Range.addSingle | ( | int | index | ) |
Add an index as a new range segment.
[in] | index | An index to be added as a new range segment. |
synchronized void com.foxit.sdk.common.Range.delete | ( | ) |
Clean up related resources immediately.
Reimplemented from com.foxit.sdk.common.Base.
int com.foxit.sdk.common.Range.getSegmentCount | ( | ) | throws com.foxit.sdk.PDFException |
Get the count of range segments.
int com.foxit.sdk.common.Range.getSegmentEnd | ( | int | segment_index | ) | throws com.foxit.sdk.PDFException |
Get the end index of a specified range segment.
[in] | segment_index | The segment index. Valid range: 0 to (count-1). count is returned by function Range.getSegmentCount . |
int com.foxit.sdk.common.Range.getSegmentStart | ( | int | segment_index | ) | throws com.foxit.sdk.PDFException |
Get the start index of a specified range segment.
[in] | segment_index | The segment index. Valid range: 0 to (count-1). count is returned by function Range.getSegmentCount . |
boolean com.foxit.sdk.common.Range.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
void com.foxit.sdk.common.Range.removeAll | ( | ) | throws com.foxit.sdk.PDFException |
Remove all range segments.