Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.common.Range类 参考
类 com.foxit.sdk.common.Range 继承关系图:

## Public 成员函数
| Range ()
| 构造函数。
| Range (int index)
| 带有单个索引的构造函数。 更多...
| Range (int start_index, int end_index, int filter)
| 带有指定索引范围的构造函数。 更多...
| Range (Range other)
| 使用另一个范围对象的构造函数。 更多...
void | addSegment (int start_index, int end_index, int filter)
| 添加新的范围段。（反向排序是合法的。） 更多...
void | addSingle (int index)
| 添加索引作为新的范围段。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
int | getSegmentCount () throws com.foxit.sdk.PDFException
| 获取范围段的数量。 更多...
int | getSegmentEnd (int segment_index) throws com.foxit.sdk.PDFException
| 获取指定范围段的结束索引。 更多...
int | getSegmentStart (int segment_index) throws com.foxit.sdk.PDFException
| 获取指定范围段的起始索引。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
void | removeAll () throws com.foxit.sdk.PDFException
| 移除所有范围段。 更多...

## 静态 Public 属性
static final int | e_All = 0
| 范围内的所有索引都将被使用。
static final int | e_Even = 1
| 只使用范围内的偶数（丢弃奇数）。
static final int | e_Odd = 2
| 只使用范围内的奇数（丢弃偶数）。

## 详细描述

此类表示索引范围。在这里，范围由一个或多个段组成，每个段由 单个索引或一组连续索引组成。
对于某些特殊情况，例如在 pdf::HeaderFooter 中使用的，此范围中指定的索引值直接表示页码而不是页面索引。

参见
  pdf::HeaderFooter

## 构造及析构函数说明

## ◆ Range() [1/3]

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

带有单个索引的构造函数。

参数

  [in] | index | 单个索引。

## ◆ Range() [2/3]

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

带有指定索引范围的构造函数。

参数

  [in] | start_index | 范围段的起始索引。
  [in] | end_index | 范围段的结束索引。
  [in] | filter | 过滤器类型，用于决定此范围的哪些索引将被使用。请参考从 com.foxit.sdk.common.Range.e_All 开始的值，应该是这些值中的一个。 默认值：com.foxit.sdk.common.Range.e_All 。 特别地，当此值为 com.foxit.sdk.common.Range.e_Even 或 com.foxit.sdk.common.Range.e_Odd 时， 意味着指定范围段内的每个偶数或奇数将 被视为单个段。

## ◆ Range() [3/3]

com.foxit.sdk.common.Range.Range | ( | Range | other | ) |

使用另一个范围对象的构造函数。

参数

  [in] | other | 另一个范围对象。

## 成员函数说明

## ◆ addSegment()

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

添加新的范围段。（反向排序是合法的。）

参数

  [in] | start_index | 新范围段的起始索引。
  [in] | end_index | 新范围段的结束索引。
  [in] | filter | 过滤器类型，用于决定此范围的哪些索引将被使用。请参考从 com.foxit.sdk.common.Range.e_All 开始的值，应该是这些值中的一个。 默认值：com.foxit.sdk.common.Range.e_All 。 特别地，当此值为 com.foxit.sdk.common.Range.e_Even 或 com.foxit.sdk.common.Range.e_Odd 时， 意味着指定范围段内的每个偶数或奇数将 被视为单个段。

返回
  无。

## ◆ addSingle()

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

添加索引作为新的范围段。

参数

  [in] | index | 要作为新范围段添加的索引。

## ◆ delete()

synchronized void com.foxit.sdk.common.Range.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

重载 com.foxit.sdk.common.Base .

## ◆ getSegmentCount()

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

获取范围段的数量。

返回
  范围段的数量。

## ◆ getSegmentEnd()

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

获取指定范围段的结束索引。

参数

  [in] | segment_index | 段索引。有效范围：0到(count-1)。 count由函数 Range.getSegmentCount 返回。

返回
  指定范围段的结束索引。

## ◆ getSegmentStart()

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

获取指定范围段的起始索引。

参数

  [in] | segment_index | 段索引。有效范围：0到(count-1)。 count由函数 Range.getSegmentCount 返回。

返回
  指定范围段的起始索引。

## ◆ isEmpty()

boolean com.foxit.sdk.common.Range.isEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ removeAll()

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

移除所有范围段。

返回
  无。