com.foxit.sdk.common.Range Class Reference
Inheritance diagram for com.foxit.sdk.common.Range:
com.foxit.sdk.common.Base

Classes

enum  Filter
 Enumeration for range filter.
More...
 

Public Member Functions

 Range ()
 Constructor.

 
 Range (int index)
 Constructor, with a single index.
More...
 
 Range (int start_index, int end_index, Range.Filter filter)
 Constructor, with a specified index range.
More...
 
 Range (Range arg0)
 Constructor, with another range object.

 
void addSegment (int start_index, int end_index, Range.Filter filter)
 Add a new range segment. (Reverse ordering is legal.)
More...
 
void addSingle (int index)
 Add an index as a new range segment.
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...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ Range() [1/2]

com.foxit.sdk.common.Range.Range ( int  index)

Constructor, with a single index.

Parameters
indexA single index.

◆ Range() [2/2]

com.foxit.sdk.common.Range.Range ( int  start_index,
int  end_index,
Range.Filter  filter 
)

Constructor, with a specified index range.

Parameters
start_indexThe start index of a range segment.
end_indexThe end index of a range segment.
filterFilter type to decide which indexes of this range would be used. Please refer to values starting from {} and this should be one of these values. Specially, when this value is e_Even or e_Odd, that means each even or odd number within the specified range segment will be treated as a single segment.

Member Function Documentation

◆ addSegment()

void com.foxit.sdk.common.Range.addSegment ( int  start_index,
int  end_index,
Range.Filter  filter 
)

Add a new range segment. (Reverse ordering is legal.)

Parameters
start_indexThe start index of a new range segment.
end_indexThe end index of a new range segment.
filterFilter type to decide which indexes of this range would be used. Please refer to values starting from {} and this should be one of these values. Specially, when this value is e_Even or e_Odd, that means each even or odd number within the specified range segment will be treated as a single segment.
Returns
None.

◆ addSingle()

void com.foxit.sdk.common.Range.addSingle ( int  index)

Add an index as a new range segment.

Parameters
indexAn index to be added as a new range segment.

◆ getSegmentCount()

int com.foxit.sdk.common.Range.getSegmentCount ( ) throws com.foxit.sdk.PDFException

Get the count of range segments.

Returns
The count of range segments.

◆ getSegmentEnd()

int com.foxit.sdk.common.Range.getSegmentEnd ( int  segment_index) throws com.foxit.sdk.PDFException

Get the end index of a specified range segment.

Parameters
segment_indexThe segment index. Valid range: 0 to (count-1). count is returned by function Range::getSegmentCount.
Returns
The end index of a specified range segment.

◆ getSegmentStart()

int com.foxit.sdk.common.Range.getSegmentStart ( int  segment_index) throws com.foxit.sdk.PDFException

Get the start index of a specified range segment.

Parameters
segment_indexThe segment index. Valid range: 0 to (count-1). count is returned by function Range::getSegmentCount.
Returns
The start index of a specified range segment.

◆ isEmpty()

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.

Returns
true means current object is empty, while false means not.

◆ removeAll()

void com.foxit.sdk.common.Range.removeAll ( ) throws com.foxit.sdk.PDFException

Remove all range segments.

Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.