Foxit PDF SDK

构造函数 | 所有成员列表
FSFiller类 参考
类 FSFiller 继承关系图:

## 构造函数
(FSPointF *) | - getEditingTextCaretPosition:
| 当文本字段或组合框处于编辑状态时获取文本光标位置。 更多...
(void) | - highlightFormFields:
| 决定是否高亮显示表单字段（包括签名字段）。 更多...
(void) | - highlightFormFieldsAndSignatures:is_sign_highlight:
| 决定是否高亮显示签名字段和其他表单字段。 更多...
(id) | - initWithForm:assist:
| 构造函数。 更多...
(id) | - initWithOther:
| 复制构造函数。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(BOOL) | - killFocus
| 从表单中移除焦点。 更多...
(BOOL) | - onChar:flags:
| 当字符代码即将输入到表单字段时调用此函数。 更多...
(BOOL) | - onCopy
| 当弹出菜单项"复制"按下时调用此函数。 更多...
(BOOL) | - onCut
| 当弹出菜单项"剪切"按下时调用此函数。 更多...
(BOOL) | - onDelete
| 当弹出菜单项"删除"按下时调用此函数。 更多...
(BOOL) | - onKeyDown:flags:
| 当键盘上的键按下时调用此函数。 更多...
(BOOL) | - onKeyUp:flags:
| 当键盘上的键抬起时调用此函数。 更多...
(BOOL) | - onLButtonDoubleClick:point:flags:
| 当鼠标左键双击时调用此函数。 更多...
(BOOL) | - onLButtonDown:point:flags:
| 当鼠标左键按下时调用此函数。 更多...
(BOOL) | - onLButtonUp:point:flags:
| 当鼠标左键抬起时调用此函数。 更多...
(BOOL) | - onMouseEnter:point:flags:
| （保留，尚未支持）当鼠标进入某处时调用此函数。 更多...
(BOOL) | - onMouseHover:point:flags:
| （保留，尚未支持）当鼠标悬停在某处时调用此函数。 更多...
(BOOL) | - onMouseLeave:point:flags:
| （保留，尚未支持）当鼠标离开某处时调用此函数。 更多...
(BOOL) | - onMouseMove:point:flags:
| 当鼠标移动时调用此函数。 更多...
(BOOL) | - onMouseWheel:point:delta:flags:
| （保留，尚未支持）当鼠标滚轮移动时调用此函数。 更多...
(BOOL) | - onPaste
| 当弹出菜单项"粘贴"按下时调用此函数。 更多...
(BOOL) | - onRButtonDoubleClick:point:flags:
| （保留，尚未支持）当鼠标右键双击时调用此函数。 更多...
(BOOL) | - onRButtonDown:point:flags:
| 当鼠标右键按下时调用此函数。 更多...
(BOOL) | - onRButtonUp:point:flags:
| 当鼠标右键抬起时调用此函数。 更多...
(BOOL) | - onSelectAll
| 当弹出菜单项"全选"按下时调用此函数。 更多...
(BOOL) | - onWheelButtonDoubleClick:point:flags:
| （保留，尚未支持）当鼠标滚轮按钮双击时调用此函数。 更多...
(BOOL) | - onWheelButtonDown:point:flags:
| （保留，尚未支持）当鼠标滚轮按钮按下时调用此函数。 更多...
(BOOL) | - onWheelButtonUp:point:flags:
| （保留，尚未支持）当鼠标滚轮按钮抬起时调用此函数。 更多...
(void) | - render:matrix:renderer:
| 在页面上绘制当前获得焦点的表单控件。 更多...
(BOOL) | - setFocus:
| 将焦点设置到表单控件上。 更多...
(void) | - setHighlightColor:
| 设置用于高亮显示表单字段的高亮颜色。 更多...
(void) | - showOverflowIndicator:
| 决定当文本字段中的文本溢出时是否显示溢出指示器。 更多...

## 详细描述

此类表示用于填充PDF表单的表单填充器。对于一个交互式表单应该只有一个表单填充器对象， 因此不要为一个FSForm 对象构造超过一个表单填充器。 建议用户实现FSActionCallback并通过FSLibrary::setActionCallback: 函数将其设置到Foxit PDF SDK，以便实现表单填充器的更多功能。

参见
  FSLibrary

## 函数文档

## ◆ getEditingTextCaretPosition:()

- (FSPointF *) getEditingTextCaretPosition: |  | (FSMatrix2D*) | matrix |

当文本字段或组合框处于编辑状态时获取文本光标位置。

参数

  [in] | matrix | 用于将返回位置转换到设备坐标系统的矩阵。

返回
  设备坐标系统中文本光标顶部的位置。
  (-1,-1) 表示没有文本字段或组合框处于编辑状态。

## ◆ highlightFormFields:()

- (void) highlightFormFields: |  | (BOOL) | is_highlight |

决定是否高亮显示表单字段（包括签名字段）。

除按钮字段外，所有类型的表单字段都可以高亮显示。 如果不调用此函数，Foxit PDF SDK默认会高亮显示所有表单字段（包括签名字段）。

参数

  [in] | is_highlight | YES 表示高亮显示表单字段（包括签名字段）， NO 表示不高亮显示表单字段（包括签名字段）。

返回
  无。

## ◆ highlightFormFieldsAndSignatures:is_sign_highlight:()

- (void) highlightFormFieldsAndSignatures: |  | (BOOL) | is_highlight
is_sign_highlight: |  | (BOOL) | is_sign_highlight

决定是否高亮显示签名字段和其他表单字段。

除按钮字段外，所有类型的表单字段都可以高亮显示。 如果不调用此函数，Foxit PDF SDK默认会高亮显示除签名字段外的所有表单字段 （签名字段默认不高亮显示）。

参数

  [in] | is_highlight | 此布尔值用于非签名字段： YES 表示高亮显示表单字段，NO 表示 不高亮显示表单字段。
  [in] | is_sign_highlight | 此布尔值仅用于签名字段： YES 表示高亮显示签名字段，NO 表示 不高亮显示签名字段。

返回
  无。

## ◆ initWithForm:assist:()

- (id) initWithForm: |  | (FSForm*) | form
assist: |  | (id<FSFillerAssistCallback>) | assist

构造函数。

一个表单只能有一个表单填充器。

参数

  [in] | form | 有效的PDF表单。
  [in] | assist | 表单填充器的辅助回调类。这应该由用户实现，不应为nil。

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSFiller*) | other |

复制构造函数。

参数

  [in] | other | 另一个填充器对象。

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回
  YES 表示当前对象为空，NO 表示不为空。

## ◆ killFocus()

- (BOOL) killFocus |  |  |

从表单中移除焦点。

返回
  YES 表示成功，NO 表示失败。

## ◆ onChar:flags:()

- (BOOL) onChar: |  | (unsigned int) | char_code
flags: |  | (unsigned int) | flags

当字符代码即将输入到表单字段时调用此函数。

参数

  [in] | char_code | 字符代码，采用UTF16-LE编码。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。

## ◆ onCopy()

- (BOOL) onCopy |  |  |

当弹出菜单项"复制"按下时调用此函数。

返回
  YES 表示成功，NO 表示失败。

## ◆ onCut()

- (BOOL) onCut |  |  |

当弹出菜单项"剪切"按下时调用此函数。

返回
  YES 表示成功，NO 表示失败。

## ◆ onDelete()

- (BOOL) onDelete |  |  |

当弹出菜单项"删除"按下时调用此函数。

返回
  YES 表示成功，NO 表示失败。

## ◆ onKeyDown:flags:()

- (BOOL) onKeyDown: |  | (unsigned int) | key_code
flags: |  | (unsigned int) | flags

当键盘上的键按下时调用此函数。

参数

  [in] | key_code | 键码。请参考从FSFillerVkeyUnknown开始的值， 这应该是这些值中的一个。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回YES。

## ◆ onKeyUp:flags:()

- (BOOL) onKeyUp: |  | (unsigned int) | key_code
flags: |  | (unsigned int) | flags

当键盘上的键抬起时调用此函数。

参数

  [in] | key_code | 键码。请参考从FSFillerVkeyUnknown开始的值， 这应该是这些值中的一个。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回YES。

## ◆ onLButtonDoubleClick:point:flags:()

- (BOOL) onLButtonDoubleClick: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

当鼠标左键双击时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。

## ◆ onLButtonDown:point:flags:()

- (BOOL) onLButtonDown: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

当鼠标左键按下时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键按下的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。

## ◆ onLButtonUp:point:flags:()

- (BOOL) onLButtonUp: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

当鼠标左键抬起时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。

## ◆ onMouseEnter:point:flags:()

- (BOOL) onMouseEnter: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

（保留，尚未支持）当鼠标进入某处时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ onMouseHover:point:flags:()

- (BOOL) onMouseHover: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

（保留，尚未支持）当鼠标悬停在某处时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ onMouseLeave:point:flags:()

- (BOOL) onMouseLeave: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

（保留，尚未支持）当鼠标离开某处时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ onMouseMove:point:flags:()

- (BOOL) onMouseMove: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

当鼠标移动时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。

## ◆ onMouseWheel:point:delta:flags:()

- (BOOL) onMouseWheel: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
delta: |  | (int) | delta
flags: |  | (unsigned int) | flags

（保留，尚未支持）当鼠标滚轮移动时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | delta | 指示鼠标滚轮移动的量。正值表示向前移动， 负值表示向后移动。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ onPaste()

- (BOOL) onPaste |  |  |

当弹出菜单项"粘贴"按下时调用此函数。

返回
  YES 表示成功，NO 表示失败。

## ◆ onRButtonDoubleClick:point:flags:()

- (BOOL) onRButtonDoubleClick: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

（保留，尚未支持）当鼠标右键双击时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ onRButtonDown:point:flags:()

- (BOOL) onRButtonDown: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

当鼠标右键按下时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ onRButtonUp:point:flags:()

- (BOOL) onRButtonUp: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

当鼠标右键抬起时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ onSelectAll()

- (BOOL) onSelectAll |  |  |

当弹出菜单项"全选"按下时调用此函数。

返回
  YES 表示成功，NO 表示失败。

## ◆ onWheelButtonDoubleClick:point:flags:()

- (BOOL) onWheelButtonDoubleClick: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

（保留，尚未支持）当鼠标滚轮按钮双击时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ onWheelButtonDown:point:flags:()

- (BOOL) onWheelButtonDown: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

（保留，尚未支持）当鼠标滚轮按钮按下时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ onWheelButtonUp:point:flags:()

- (BOOL) onWheelButtonUp: |  | (FSPDFPage*) | page
point: |  | (FSPointF*) | point
flags: |  | (unsigned int) | flags

（保留，尚未支持）当鼠标滚轮按钮抬起时调用此函数。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | point | 页面中鼠标左键抬起的点，在中。
  [in] | flags | 事件标志。请参考从FSFillerEventFlagShiftKey开始的值， 这应该是这些值中的一个或组合。

返回
  YES 表示成功，NO 表示失败。 目前此函数尚不支持使用，因此此函数将始终返回NO。

## ◆ render:matrix:renderer:()

- (void) render: |  | (FSPDFPage*) | page
matrix: |  | (FSMatrix2D*) | matrix
renderer: |  | (FSRenderer*) | renderer

在页面上绘制当前获得焦点的表单控件。

如果页面上没有获得焦点的表单控件，此函数将不绘制任何内容。 获得焦点的表单控件必须是最顶层的可见元素，因此它应该 始终在页面内容和所有其他注释都已渲染后再渲染。
关于如何渲染表单控件（与控件注释关联），请参考 Renderer类注释中提到的推荐流程。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | matrix | 用于渲染的变换矩阵，通常由FSPDFPage::getDisplayMatrix:top:width:height:rotate:函数返回。
  [in] | renderer | 用于渲染的有效渲染器对象。

返回
  无。

## ◆ setFocus:()

- (BOOL) setFocus: |  | (FSControl*) | control |

将焦点设置到表单控件上。

参数

  [in] | control | 表单控件对象。如果这是由默认构造函数构造且未设置任何值， 表示无焦点控件。

返回
  YES 表示成功，NO 表示失败。

## ◆ setHighlightColor:()

- (void) setHighlightColor: |  | (unsigned int) | color |

设置用于高亮显示表单字段的高亮颜色。

如果不调用此函数，Foxit PDF SDK默认会使用一种浅蓝灰色（值0x80C8D2FF）。

参数

  [in] | color | 要为高亮显示表单字段设置的高亮颜色。

返回
  无。

## ◆ showOverflowIndicator:()

- (void) showOverflowIndicator: |  | (BOOL) | is_show_overflow_indicator |

决定当文本字段中的文本溢出时是否显示溢出指示器。

如果不调用此函数，Foxit PDF SDK默认不会显示表单字段溢出指示器。

参数

  [in] | is_show_overflow_indicator | YES 表示当文本字段中的文本溢出时显示溢出指示器， NO 表示在这种情况下不显示溢出指示器。

返回
  无。