Foxit PDF SDK

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

## Public 成员函数
| FillSign (PDFPage page) throws com.foxit.sdk.PDFException
| 构造函数，从PDF页面对象构造。 更多...
| FillSign (FillSign other)
| 构造函数，使用另一个 FillSign 对象。 更多...
FillSignObject | addObject (int type, PointF point, float width, float height, int rotation) throws com.foxit.sdk.PDFException
| 向相关PDF页面（在构造函数中使用的）添加新的填充签名对象（除了文本填充签名对象）。 更多...
FillSignObject | addTextObject (TextFillSignObjectDataArray text_data, PointF point, float width, float height, int rotation, boolean is_comb_field_mode) throws com.foxit.sdk.PDFException
| 向相关PDF页面（在构造函数中使用的）添加新的文本填充签名对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
FillSignObject | getObjectAtDevicePoint (PointF point, Matrix2D matrix) throws com.foxit.sdk.PDFException
| 通过设备坐标系中的指定点获取填充签名对象。 更多...
FillSignObject | getObjectAtPoint (PointF point) throws com.foxit.sdk.PDFException
| 通过中的指定点获取填充签名对象。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
boolean | removeObject (FillSignObject fillsign_object) throws com.foxit.sdk.PDFException
| 删除指定的填充签名对象。 更多...
Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void | delete ()
| 直接清除C++相关资源。 更多...

## 静态 Public 属性
static final int | e_FillSignObjectTypeCheckMark = 2
| 勾号标记填充签名对象。
static final int | e_FillSignObjectTypeCrossMark = 1
| 叉号标记填充签名对象。
static final int | e_FillSignObjectTypeDot = 5
| 点填充签名对象。
static final int | e_FillSignObjectTypeInitialsSignature = 7
| 首字母签名填充签名对象。
static final int | e_FillSignObjectTypeLine = 4
| 线条填充签名对象。
static final int | e_FillSignObjectTypeRoundRectangle = 3
| 圆角矩形填充签名对象。
static final int | e_FillSignObjectTypeSignature = 6
| 签名填充签名对象。
static final int | e_FillSignObjectTypeText = 0
| 文本填充签名对象。

## 详细描述

填充签名是指向PDF页面填充一些图形对象并签名。此类用作填充签名对象的管理器。 用户可以使用此类向PDF页面添加/获取/删除填充签名对象（包括叉号标记、勾号标记、点、线条、圆角矩形、 签名和首字母签名）。

## 构造及析构函数说明

## ◆ FillSign() [1/2]

com.foxit.sdk.pdf.FillSign.FillSign | ( | PDFPage | page | ) | throws com.foxit.sdk.PDFException

构造函数，从PDF页面对象构造。

请确保输入的PDF页面已成功解析。

参数

  [in] | page | 一个有效的PDF页面对象。

## ◆ FillSign() [2/2]

com.foxit.sdk.pdf.FillSign.FillSign | ( | FillSign | other | ) |

构造函数，使用另一个 FillSign 对象。

参数

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

## 成员函数说明

## ◆ addObject()

FillSignObject com.foxit.sdk.pdf.FillSign.addObject | ( | int | type,
|  | PointF | point,
|  | float | width,
|  | float | height,
|  | int | rotation
| ) |  | throws com.foxit.sdk.PDFException

向相关PDF页面（在构造函数中使用的）添加新的填充签名对象（除了文本填充签名对象）。

此函数可用于添加除类型 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeText 之外的填充签名对象。 如果您想添加类型为 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeText 的填充签名对象， 请调用函数 FillSign.addTextObject 。

- 如果要添加类型为 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeCrossMark 、 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeCheckMark 、com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeLine 或 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeDot 的填充签名对象，输入宽度和高度中的较大值将 用作新填充签名对象的宽度和高度。

- 如果要添加类型为 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeLine 的填充签名对象，输入的height无用 并将被忽略。

参数

  [in] | type | 填充签名类型，用于指定要添加的填充签名对象的类型。 请参考从 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeCrossMark 开始的值， 这应该是这些值中的一个。
  [in] | point | 新填充签名对象的左下角点，在中。
  [in] | width | 新填充签名对象的宽度。
  [in] | height | 新填充签名对象的高度。
  [in] | rotation | 旋转状态信息。此旋转值包括视图旋转和页面旋转属性信息。 请参考从 com.foxit.sdk.common.Constants.e_Rotation0 开始的值， 这应该是这些值中的一个，除了 com.foxit.sdk.common.Constants.e_RotationUnknown 。

返回
  一个新的填充签名对象。

## ◆ addTextObject()

FillSignObject com.foxit.sdk.pdf.FillSign.addTextObject | ( | TextFillSignObjectDataArray | text_data,
|  | PointF | point,
|  | float | width,
|  | float | height,
|  | int | rotation,
|  | boolean | is_comb_field_mode
| ) |  | throws com.foxit.sdk.PDFException

向相关PDF页面（在构造函数中使用的）添加新的文本填充签名对象。

参数

  [in] | text_data | 要设置到新文本填充签名对象的文本数据数组。对于每个文本填充签名对象数据， 成员text_state的origin_position将不被使用。
  [in] | point | 新填充签名对象的左下角点，在中。
  [in] | width | 新填充签名对象的宽度。
  [in] | height | 新填充签名对象的高度。
  [in] | rotation | 旋转状态信息。此旋转值包括视图旋转和页面旋转属性信息。 请参考从 com.foxit.sdk.common.Constants.e_Rotation0 开始的值， 这应该是这些值中的一个，除了 com.foxit.sdk.common.Constants.e_RotationUnknown 。
  [in] | is_comb_field_mode | 一个布尔值，用于决定是使用梳型字段模式还是普通模式： true表示以梳型字段模式设置输入文本数据。对于每个文本填充签名对象数据， 如果成员text_state的charspace为0，将使用默认值6.0f。 false表示以普通模式设置输入文本数据。对于每个文本填充签名对象数据， 成员text_state的charspace将不被使用。

返回
  一个新的填充签名对象。

## ◆ delete()

synchronized void com.foxit.sdk.pdf.FillSign.delete | ( |  | ) |

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

返回
  无。

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

## ◆ getObjectAtDevicePoint()

FillSignObject com.foxit.sdk.pdf.FillSign.getObjectAtDevicePoint | ( | PointF | point,
|  | Matrix2D | matrix
| ) |  | throws com.foxit.sdk.PDFException

通过设备坐标系中的指定点获取填充签名对象。

添加类型为 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeSignature 或 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeInitialsSignature 的填充签名对象后， 属于同一PDF文档的所有现有填充签名对象都无法检索。

参数

  [in] | point | 设备坐标系中的指定点。
  [in] | matrix | 从设备坐标系到的变换矩阵。

返回
  一个填充签名对象。

## ◆ getObjectAtPoint()

FillSignObject com.foxit.sdk.pdf.FillSign.getObjectAtPoint | ( | PointF | point | ) | throws com.foxit.sdk.PDFException

通过中的指定点获取填充签名对象。

添加类型为 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeSignature 或 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeInitialsSignature 的填充签名对象后， 属于同一PDF文档的所有现有填充签名对象都无法检索。

参数

  [in] | point | 中的指定点。

返回
  一个填充签名对象。

## ◆ isEmpty()

boolean com.foxit.sdk.pdf.FillSign.isEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ removeObject()

boolean com.foxit.sdk.pdf.FillSign.removeObject | ( | FillSignObject | fillsign_object | ) | throws com.foxit.sdk.PDFException

删除指定的填充签名对象。

添加类型为 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeSignature 或 com.foxit.sdk.pdf.FillSign.e_FillSignObjectTypeInitialsSignature 的填充签名对象后， 属于同一PDF文档的所有现有填充签名对象都无法删除。在这种情况下， 如果要删除任何现有填充签名对象，此函数将返回false。

参数

  [in] | fillsign_object | 要删除的填充签名对象。

返回
  true表示成功，false表示失败。