Foxit PDF SDK

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

## Public 成员函数
| Annot ()
| 构造函数。
| Annot (Annot annot)
| 构造函数，使用另一个注释对象。 更多...
| Annot (PDFPage page, PDFDictionary annot_dict) throws com.foxit.sdk.PDFException
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
PDFStream | getAppearanceStream (int type, String appearance_state) throws com.foxit.sdk.PDFException
| 获取具有指定类型和状态的注释外观流。 更多...
long | getBorderColor () throws com.foxit.sdk.PDFException
| 获取边框颜色。 更多...
BorderInfo | getBorderInfo () throws com.foxit.sdk.PDFException
| 获取边框信息。 更多...
String | getContent () throws com.foxit.sdk.PDFException
| 获取内容。 更多...
RectI | getDeviceRect (Matrix2D matrix) throws com.foxit.sdk.PDFException
| 获取设备坐标系统中的注释矩形。 更多...
PDFDictionary | getDict () throws com.foxit.sdk.PDFException
| 获取注释的字典对象。 更多...
Matrix2D | getDisplayMatrix (Matrix2D page_display_matrix) throws com.foxit.sdk.PDFException
| 获取显示矩阵，从到 目标设备坐标系统。 更多...
int | getFlags () throws com.foxit.sdk.PDFException
| 获取注释标志。 更多...
int | getIndex () throws com.foxit.sdk.PDFException
| 获取当前注释在其所属页面中的索引。 更多...
DateTime | getModifiedDateTime () throws com.foxit.sdk.PDFException
| 获取最后修改日期时间。 更多...
PDFDictionary | getOptionalContent () throws com.foxit.sdk.PDFException
| 获取注释可选内容的PDF字典。 更多...
PDFPage | getPage () throws com.foxit.sdk.PDFException
| 获取相关的PDF页面。 更多...
RectF | getRect () throws com.foxit.sdk.PDFException
| 获取矩形，以表示。 更多...
int | getType () throws com.foxit.sdk.PDFException
| 获取当前注释的实际注释类型。 更多...
String | getUniqueID () throws com.foxit.sdk.PDFException
| 获取唯一ID。 更多...
boolean | hasProperty (int property) throws com.foxit.sdk.PDFException
| 当前注释是否具有指定的注释属性。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
boolean | isMarkup () throws com.foxit.sdk.PDFException
| 检查当前注释是否为标记注释。 更多...
boolean | move (RectF rect) throws com.foxit.sdk.PDFException
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
boolean | move (RectF rect, boolean is_reset_appearance) throws com.foxit.sdk.PDFException
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
boolean | removeProperty (int property) throws com.foxit.sdk.PDFException
| 删除指定的注释属性。 更多...
boolean | resetAppearanceStream () throws com.foxit.sdk.PDFException
| 重置外观流。 更多...
boolean | resetAppearanceStream (boolean is_generate_new_appearance_obj) throws com.foxit.sdk.PDFException
| 重置外观流。 更多...
void | setBorderColor (long color) throws com.foxit.sdk.PDFException
| 设置边框颜色。 更多...
void | setBorderInfo (BorderInfo border) throws com.foxit.sdk.PDFException
| 设置边框信息。 更多...
void | setContent (String content) throws com.foxit.sdk.PDFException
| 设置内容。 更多...
void | setFlags (int flags) throws com.foxit.sdk.PDFException
| 设置注释标志。 更多...
void | setModifiedDateTime (DateTime date_time) throws com.foxit.sdk.PDFException
| 设置最后修改日期时间。 更多...
void | setUniqueID (String unique_id) throws com.foxit.sdk.PDFException
| 设置唯一ID。 更多...

## 静态 Public 属性
static final int | e_3D = 25
| 注释类型：3D注释。<PDF参考1.7>中的标准注释之一。
static final int | e_AppearanceTypeDown = 2
| 注释的按下外观。
static final int | e_AppearanceTypeNormal = 0
| 注释的正常外观。
static final int | e_AppearanceTypeRollover = 1
| 注释的悬停外观。
static final int | e_Caret = 14
| 注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Circle = 6
| 注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。
static final int | e_FileAttachment = 17
| 注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。
static final int | e_FlagHidden = 0x0002
| 注释标志：隐藏。 更多...
static final int | e_FlagInvisible = 0x0001
| 注释标志：不可见。 更多...
static final int | e_FlagLocked = 0x0080
| 注释标志：锁定。 更多...
static final int | e_FlagLockedContents = 0x0200
| 注释标志：锁定内容。 更多...
static final int | e_FlagNoRotate = 0x0010
| 注释标志：无旋转。 更多...
static final int | e_FlagNoView = 0x0020
| 注释标志：无视图。 更多...
static final int | e_FlagNoZoom = 0x0008
| 注释标志：无缩放。 更多...
static final int | e_FlagPrint = 0x0004
| 注释标志：打印。 更多...
static final int | e_FlagReadOnly = 0x0040
| 注释标志：只读。 更多...
static final int | e_FlagToggleNoView = 0x0100
| 注释标志：切换无视图。 更多...
static final int | e_FreeText = 3
| 注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Highlight = 9
| 注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。
static final int | e_HighlightingInvert = 1
| 高亮模式：反转，即反转注释矩形的内容。
static final int | e_HighlightingNone = 0
| 高亮模式：无高亮。
static final int | e_HighlightingOutline = 2
| 高亮模式：轮廓，即反转注释的边框。
static final int | e_HighlightingPush = 3
| 高亮模式：按下，即显示注释的按下外观（如果有）。
static final int | e_HighlightingToggle = 4
| 高亮模式：切换。这仅对小组件注释有用。
static final int | e_Ink = 15
| 注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Line = 4
| 注释类型：直线注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Link = 2
| 注释类型：链接注释。<PDF参考1.7>中的标准注释之一。
static final int | e_MKEntryBackgroundColor = 2
| 背景颜色条目。MK字典中的"BG"。
static final int | e_MKEntryBorderColor = 1
| 边框颜色条目。MK字典中的"BC"。
static final int | e_MKEntryDownCaption = 5
| 按下标题（或备用标题）条目。MK字典中的"AC"。 更多...
static final int | e_MKEntryDownIcon = 8
| 按下图标（或备用图标）条目。MK字典中的"IX"。 更多...
static final int | e_MKEntryIconCaptionRelation = 10
| 图标和标题关系条目。MK字典中的"TP"。 更多...
static final int | e_MKEntryIconFit = 9
| 图标适配信息条目。MK字典中的"IF"。 更多...
static final int | e_MKEntryNormalCaption = 3
| 正常标题条目。MK字典中的"CA"。 更多...
static final int | e_MKEntryNormalIcon = 6
| 正常图标条目。MK字典中的"I"。 更多...
static final int | e_MKEntryRolloverCaption = 4
| 悬停标题条目。MK字典中的"RC"。 更多...
static final int | e_MKEntryRolloverIcon = 7
| 悬停图标条目。MK字典中的"RI"。 更多...
static final int | e_MKEntryRotation = 0
| 旋转条目。MK字典中的"R"。
static final int | e_MKRelationCaptionAboveIcon = 3
| 标题在图标上方。
static final int | e_MKRelationCaptionBelowIcon = 2
| 标题在图标下方。
static final int | e_MKRelationCaptionLeft = 5
| 标题在图标左侧。
static final int | e_MKRelationCaptionOvrlayOnIcon = 6
| 标题直接覆盖在图标上。
static final int | e_MKRelationCaptionRight = 4
| 标题在图标右侧。
static final int | e_MKRelationNoCaption = 1
| 无标题；仅图标。
static final int | e_MKRelationNoIcon = 0
| 无图标；仅标题。
static final int | e_Movie = 19
| 注释类型：电影注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Note = 1
| 注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。
static final int | e_PagingSeal = 29
| 注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。
static final int | e_Polygon = 7
| 注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。
static final int | e_PolyLine = 8
| 注释类型：折线注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Popup = 26
| 注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。
static final int | e_PrinterMark = 22
| 注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。
static final int | e_PropertyBorderColor = 2
| 注释属性：边框颜色。 更多...
static final int | e_PropertyCreationDate = 1
| 注释属性：创建日期。 更多...
static final int | e_PropertyFillColor = 3
| 注释属性：填充颜色 更多...
static final int | e_PropertyModifiedDate = 0
| 注释属性：修改日期。
static final int | e_PSInk = 16
| 注释类型：压力敏感墨迹注释。
static final int | e_Redact = 27
| 注释类型：编辑注释。
static final int | e_RichMedia = 28
| 注释类型：富媒体注释。
static final int | e_Screen = 21
| 注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Sound = 18
| 注释类型：声音注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Square = 5
| 注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Squiggly = 11
| 注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Stamp = 13
| 注释类型：印章注释。<PDF参考1.7>中的标准注释之一。
static final int | e_StrikeOut = 12
| 注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。
static final int | e_TrapNet = 23
| 注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Underline = 10
| 注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。
static final int | e_UnknownType = 0
| 注释类型：未知。
static final int | e_Watermark = 24
| 注释类型：水印注释。<PDF参考1.7>中的标准注释之一。
static final int | e_Widget = 20
| 注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。 更多...

## 详细描述

注释将对象（如注记、声音或电影）与PDF文档页面上的位置关联起来， 或提供通过鼠标和键盘与用户交互的方式。PDF包含各种各样的 标准注释类型。
类Annot 是所有PDF注释类型的基类。它提供获取/设置 注释公共属性、移动注释或重置注释外观流的基础函数。 对于具体的注释类型，请参考派生类。要获取注释计数或 获取/添加/移除注释，请参考类pdfPDFPage。
此类对象也可用于构造其他类的对象，以便在注释中进行更多操作 或访问注释的指定信息：

- 要访问附加动作，请使用注释对象构造com.foxit.sdk.pdf.actions.AdditionalAction 对象。 只有少数类型的注释可能有附加动作。有关更多详细信息，请参考 类com.foxit.sdk.pdf.actions.AdditionalAction 。
- 要在注释中搜索文本，请使用注释对象构造com.foxit.sdk.pdf.TextSearch 对象。 搜索只能支持某些类型的注释。有关更多详细信息，请参考 类com.foxit.sdk.pdf.TextSearch 。

注解
  目前，以下类型的函数仅支持注记、高亮、下划线、删除线、波浪线、链接、 矩形、圆形、自由文本、印章、插入符、墨迹、直线、多边形、折线、文件附件、弹出窗口、 小组件、屏幕、PSInk、编辑注释：
  - 类Annot 中的所有"set"函数。
  - 函数Annot.move 、Annot.resetAppearanceStream 、 Annot.removeProperty 。

参见
  com.foxit.sdk.pdf.PDFPage
  com.foxit.sdk.pdf.actions.AdditionalAction
  com.foxit.sdk.pdf.TextSearch

## 构造及析构函数说明

## ◆ Annot() [1/2]

com.foxit.sdk.pdf.annots.Annot.Annot | ( | PDFPage | page,
|  | PDFDictionary | annot_dict
| ) |  | throws com.foxit.sdk.PDFException

构造函数，使用PDF页面和注释的PDF字典。

参数

  [in] | page | 有效的PDF页面。
  [in] | annot_dict | 注释的PDF字典。它应该表示一个注释，并且应该在 参数page指定的PDF页面中。

## ◆ Annot() [2/2]

com.foxit.sdk.pdf.annots.Annot.Annot | ( | Annot | annot | ) |

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

参数

  [in] | annot | 另一个注释对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.pdf.annots.Annot.delete | ( |  | ) |

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

返回
  无。

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

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

被 com.foxit.sdk.pdf.annots.Widget, com.foxit.sdk.pdf.annots.Screen, com.foxit.sdk.pdf.annots.FreeText, com.foxit.sdk.pdf.annots.FileAttachment, com.foxit.sdk.pdf.annots.Link, com.foxit.sdk.pdf.annots.Sound, com.foxit.sdk.pdf.annots.Stamp, com.foxit.sdk.pdf.annots.Caret, com.foxit.sdk.pdf.annots.Circle, com.foxit.sdk.pdf.annots.Ink, com.foxit.sdk.pdf.annots.Line, com.foxit.sdk.pdf.annots.Markup, com.foxit.sdk.pdf.annots.Note, com.foxit.sdk.pdf.annots.PagingSeal, com.foxit.sdk.pdf.annots.Polygon, com.foxit.sdk.pdf.annots.PolyLine, com.foxit.sdk.pdf.annots.Square, com.foxit.sdk.pdf.annots.Highlight, com.foxit.sdk.pdf.annots.Popup, com.foxit.sdk.pdf.annots.PSInk, com.foxit.sdk.pdf.annots.Redact, com.foxit.sdk.pdf.annots.Squiggly, com.foxit.sdk.pdf.annots.StrikeOut, com.foxit.sdk.pdf.annots.TextMarkup , 以及 com.foxit.sdk.pdf.annots.Underline 重载.

## ◆ getAppearanceStream()

PDFStream com.foxit.sdk.pdf.annots.Annot.getAppearanceStream | ( | int | type,
|  | String | appearance_state
| ) |  | throws com.foxit.sdk.PDFException

获取具有指定类型和状态的注释外观流。

有关更多详细信息，请参考 <PDF参考1.7> 中 "表8.15 所有注释字典通用条目"中的"AP"和"AS"条目。

参数

  [in] | type | 注释外观类型。请参考 com.foxit.sdk.pdf.annots.Annot.e_AppearanceTypeNormal 及相关值。
  [in] | appearance_state | 注释的外观状态，用于从外观子字典中选择适用的外观流。 如果为空字符串，Foxit PDF SDK 将选择注释字典中"AS"（外观状态）条目指定的外观状态。

返回
  指定的注释外观流。 如果没有与外观相关的条目或发生任何错误，此函数将返回 null。

## ◆ getBorderColor()

long com.foxit.sdk.pdf.annots.Annot.getBorderColor | ( |  | ) | throws com.foxit.sdk.PDFException

获取边框颜色。

此属性对注释的外观有影响。

返回
  边框颜色。格式：0xRRGGBB。 如果找不到边框颜色，将返回0x000000。

## ◆ getBorderInfo()

BorderInfo com.foxit.sdk.pdf.annots.Annot.getBorderInfo | ( |  | ) | throws com.foxit.sdk.PDFException

获取边框信息。

此属性对注释的外观有影响。对于没有边框信息的注释，将返回默认边框信息：
边框宽度 = 1，边框样式 = com.foxit.sdk.pdf.annots.BorderInfo.e_Solid ， 边框云状强度 = 0，边框虚线相位 = 0，边框虚线数组为空数组。 注意：在支持的注释类型中（请参考类 Annot 的"注意"注释部分）， 此属性对以下注释的外观不起作用： 注记、高亮、下划线、删除线、波浪线、印章、插入符、弹出窗口、文件附件、PSInk、编辑。 对于墨迹注释，只有边框宽度对墨迹注释的外观有影响。

返回
  接收边框信息的边框信息对象。如果找不到任何边框信息，将返回"详细信息"部分所述的默认边框信息。

## ◆ getContent()

String com.foxit.sdk.pdf.annots.Annot.getContent | ( |  | ) | throws com.foxit.sdk.PDFException

获取内容。

返回
  内容字符串。

## ◆ getDeviceRect()

RectI com.foxit.sdk.pdf.annots.Annot.getDeviceRect | ( | Matrix2D | matrix | ) | throws com.foxit.sdk.PDFException

获取设备坐标系统中的注释矩形。

这是获取注释的设备矩形的有用函数， 但不支持弹出注释。
对于矩形转换，结果矩形始终是"标准化的"，即 使用设备坐标系统：左侧始终小于右侧，顶部始终小于底部。

参数

  [in] | matrix | 用于从转换到 设备坐标系统的矩阵。通常，这由函数 pdf.PDFPage.getDisplayMatrix 返回，也用于渲染。

返回
  设备坐标系统中的注释矩形。 如果没有矩形信息，将返回所有值为0的RectI对象。

## ◆ getDict()

PDFDictionary com.foxit.sdk.pdf.annots.Annot.getDict | ( |  | ) | throws com.foxit.sdk.PDFException

获取注释的字典对象。

返回
  注释的字典。如果有任何错误，此函数将返回null。

## ◆ getDisplayMatrix()

Matrix2D com.foxit.sdk.pdf.annots.Annot.getDisplayMatrix | ( | Matrix2D | page_display_matrix | ) | throws com.foxit.sdk.PDFException

获取显示矩阵，从到 目标设备坐标系统。

当前注释的显示矩阵可以与注释的矩形一起使用， 以计算注释在目标设备坐标系统中的实际区域。

参数

  [in] | page_display_matrix | The transformation matrix. Usually this is returned by function PDFPage.getDisplayMatrix .

返回
  The display matrix of current annotation.

## ◆ getFlags()

int com.foxit.sdk.pdf.annots.Annot.getFlags | ( |  | ) | throws com.foxit.sdk.PDFException

获取注释标志。

返回
  注释标志。请参考从com.foxit.sdk.pdf.annots.Annot.e_FlagInvisible 开始的值， 这将是这些值中的一个或组合。0表示无注释标志。

## ◆ getIndex()

int com.foxit.sdk.pdf.annots.Annot.getIndex | ( |  | ) | throws com.foxit.sdk.PDFException

获取当前注释在其所属页面中的索引。

返回
  索引值，从0开始。

## ◆ getModifiedDateTime()

DateTime com.foxit.sdk.pdf.annots.Annot.getModifiedDateTime | ( |  | ) | throws com.foxit.sdk.PDFException

获取最后修改日期时间。

返回
  接收最后修改日期时间的日期和时间对象。 如果没有修改日期时间信息，将返回所有值为0的日期和时间对象。

## ◆ getOptionalContent()

PDFDictionary com.foxit.sdk.pdf.annots.Annot.getOptionalContent | ( |  | ) | throws com.foxit.sdk.PDFException

获取注释可选内容的PDF字典。

返回
  注释可选内容的PDF字典。 如果没有"OC"条目或发生任何错误，此函数将返回 null。

## ◆ getPage()

PDFPage com.foxit.sdk.pdf.annots.Annot.getPage | ( |  | ) | throws com.foxit.sdk.PDFException

获取相关的PDF页面。

返回
  作为相关PDF页面的PDF页面对象。

## ◆ getRect()

RectF com.foxit.sdk.pdf.annots.Annot.getRect | ( |  | ) | throws com.foxit.sdk.PDFException

获取矩形，以表示。

返回
  注释矩形。 如果没有矩形信息，将返回所有值为0的RectF对象。

## ◆ getType()

int com.foxit.sdk.pdf.annots.Annot.getType | ( |  | ) | throws com.foxit.sdk.PDFException

获取当前注释的实际注释类型。

返回
  注释类型。请参考从com.foxit.sdk.pdf.annots.Annot.e_Note 开始的值，这将是这些值中的一个。

## ◆ getUniqueID()

String com.foxit.sdk.pdf.annots.Annot.getUniqueID | ( |  | ) | throws com.foxit.sdk.PDFException

获取唯一ID。

返回
  唯一ID字符串。

## ◆ hasProperty()

boolean com.foxit.sdk.pdf.annots.Annot.hasProperty | ( | int | property | ) | throws com.foxit.sdk.PDFException

当前注释是否具有指定的注释属性。

参数

  [in] | property | 属性名称。请参考从com.foxit.sdk.pdf.annots.Annot.e_PropertyModifiedDate 开始的值， 这应该是这些值中的一个。

返回
  true表示当前注释具有指定的属性， 而false表示当前注释没有指定的属性。

## ◆ isEmpty()

boolean com.foxit.sdk.pdf.annots.Annot.isEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ isMarkup()

boolean com.foxit.sdk.pdf.annots.Annot.isMarkup | ( |  | ) | throws com.foxit.sdk.PDFException

检查当前注释是否为标记注释。

返回
  true表示当前注释是标记注释，而false表示当前注释 不是标记注释。

## ◆ move() [1/2]

boolean com.foxit.sdk.pdf.annots.Annot.move | ( | RectF | rect | ) | throws com.foxit.sdk.PDFException

将当前注释移动到新位置，由中的新矩形指定。

参数

  [in] | rect | 指定当前注释要移动到的新位置的新矩形。 它应该在中有效。

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

## ◆ move() [2/2]

boolean com.foxit.sdk.pdf.annots.Annot.move | ( | RectF | rect,
|  | boolean | is_reset_appearance
| ) |  | throws com.foxit.sdk.PDFException

将当前注释移动到新位置，由中的新矩形指定。

参数

  [in] | rect | 指定当前注释要移动到的新位置的新矩形。 它应该在中有效。
  [in] | is_reset_appearance | 布尔值，指定移动后是否重置注释的外观。

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

## ◆ removeProperty()

boolean com.foxit.sdk.pdf.annots.Annot.removeProperty | ( | int | property | ) | throws com.foxit.sdk.PDFException

删除指定的注释属性。

此函数可用于删除注释的某些可选属性。 当成功删除与外观相关的属性时，例如 com.foxit.sdk.pdf.annots.Annot.e_PropertyBorderColor 和 com.foxit.sdk.pdf.annots.Annot.e_PropertyFillColor ， 用户应调用函数 Annot.resetAppearanceStream 以在注释外观上产生效果。

参数

  [in] | property | 属性名称。请参考从 com.foxit.sdk.pdf.annots.Annot.e_PropertyModifiedDate 开始的值， 应为这些值中的一个。

返回
  true 表示成功删除指定属性，或当前注释支持该属性但没有该属性。
  false 表示当前注释不支持拥有指定属性，或当前注释无法删除指定属性。

## ◆ resetAppearanceStream() [1/2]

boolean com.foxit.sdk.pdf.annots.Annot.resetAppearanceStream | ( |  | ) | throws com.foxit.sdk.PDFException

重置外观流。

注释的外观作为流存储在PDF文档中。 任何与外观相关的属性都可以通过相应的设置函数进行更改。 为了使此更改生效，应调用此函数来更新注释的外观。
请查看类 Annot 注释中的"注意"部分，了解哪些类型的注释可以 通过当前函数重置外观，并检查这些注释类的注释，以了解在重置外观流之前是否需要任何属性。

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

## ◆ resetAppearanceStream() [2/2]

boolean com.foxit.sdk.pdf.annots.Annot.resetAppearanceStream | ( | boolean | is_generate_new_appearance_obj | ) | throws com.foxit.sdk.PDFException

重置外观流。

注释的外观作为流存储在PDF文档中。 任何与外观相关的属性都可以通过相应的设置函数进行更改。 为了使此更改生效，应调用此函数来更新注释的外观。
请查看类 Annot 注释中的"注意"部分，了解哪些类型的注释可以 通过当前函数重置外观，并检查这些注释类的注释，以了解在重置外观流之前是否需要任何属性。

参数

  [in] | is_generate_new_appearance_obj | true 表示生成新的外观对象来重置当前注释的外观， false 表示重置共享此外观流的注释的外观。 该参数仅对小组件注释的外观有影响。

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

## ◆ setBorderColor()

void com.foxit.sdk.pdf.annots.Annot.setBorderColor | ( | long | color | ) | throws com.foxit.sdk.PDFException

设置边框颜色。

此属性对注释的外观有影响。如果用户希望新的边框颜色对 注释的外观有影响，请在设置新边框颜色后调用函数Annot.resetAppearanceStream 。

参数

  [in] | color | 要设置的新边框颜色。格式：0xRRGGBB。

返回
  无。

## ◆ setBorderInfo()

void com.foxit.sdk.pdf.annots.Annot.setBorderInfo | ( | BorderInfo | border | ) | throws com.foxit.sdk.PDFException

设置边框信息。

此属性对注释的外观有影响。如果用户希望新的边框信息对注释的外观有影响， 请在设置新边框信息后调用函数 Annot.resetAppearanceStream 。
注意：在支持的注释类型中（请参考类 Annot 的"注意"注释部分）， 此属性对以下注释的外观不起作用： 注记、高亮、下划线、删除线、波浪线、印章、插入符、弹出窗口、文件附件、PSInk、编辑。 对于墨迹注释，只有边框宽度对墨迹注释的外观有影响。

参数

  [in] | border | 要设置的新边框信息。应为有效的边框信息对象。 如果参数 border 的任何值无效，此函数将无法为当前注释设置新边框信息。

返回
  无。

## ◆ setContent()

void com.foxit.sdk.pdf.annots.Annot.setContent | ( | String | content | ) | throws com.foxit.sdk.PDFException

设置内容。

对于自由文本注释和直线注释（已启用标题）， 它们会在外观中显示内容。因此，对于这些类型的注释，此属性会 影响注释的外观。如果用户希望效果显示在 这些类型注释的外观中，请在设置新内容后调用函数Annot.resetAppearanceStream 。

参数

  [in] | content | 要设置的新内容字符串。

返回
  无。

## ◆ setFlags()

void com.foxit.sdk.pdf.annots.Annot.setFlags | ( | int | flags | ) | throws com.foxit.sdk.PDFException

设置注释标志。

参数

  [in] | flags | 注释标志。可以是0，或者是从 com.foxit.sdk.pdf.annots.Annot.e_FlagInvisible 开始的值中的一个或组合。

返回
  无。

## ◆ setModifiedDateTime()

void com.foxit.sdk.pdf.annots.Annot.setModifiedDateTime | ( | DateTime | date_time | ) | throws com.foxit.sdk.PDFException

设置最后修改日期时间。

参数

  [in] | date_time | 要设置的数据时间。它应该包含有效的日期时间数据。

返回
  无。

## ◆ setUniqueID()

void com.foxit.sdk.pdf.annots.Annot.setUniqueID | ( | String | unique_id | ) | throws com.foxit.sdk.PDFException

设置唯一ID。

参数

  [in] | unique_id | 要设置的新唯一ID字符串。

返回
  无。

## 类成员变量说明

## ◆ e_FlagHidden

final int com.foxit.sdk.pdf.annots.Annot.e_FlagHidden = 0x0002
| static

注释标志：隐藏。

如果设置，不显示或打印注释或允许用户与其交互， 无论其注释类型如何或是否有可用的注释处理程序。

## ◆ e_FlagInvisible

final int com.foxit.sdk.pdf.annots.Annot.e_FlagInvisible = 0x0001
| static

注释标志：不可见。

如果设置，当注释不属于标准注释类型且没有可用的注释处理程序时，不显示该注释。 如果清除，则使用其外观字典指定的外观流显示此类非标准注释（如果有）。

## ◆ e_FlagLocked

final int com.foxit.sdk.pdf.annots.Annot.e_FlagLocked = 0x0080
| static

注释标志：锁定。

如果设置，不允许用户删除注释或修改其属性（包括位置和大小）。 但是，此标志不限制对注释内容的更改，例如表单字段的值。

## ◆ e_FlagLockedContents

final int com.foxit.sdk.pdf.annots.Annot.e_FlagLockedContents = 0x0200
| static

注释标志：锁定内容。

如果设置，不允许用户修改注释的内容。 此标志不限制删除注释或更改其他注释属性，例如位置和大小。

## ◆ e_FlagNoRotate

final int com.foxit.sdk.pdf.annots.Annot.e_FlagNoRotate = 0x0010
| static

注释标志：无旋转。

如果设置，不根据页面的旋转旋转注释的外观。 注释矩形的左上角在页面上保持固定位置， 无论页面旋转如何。

## ◆ e_FlagNoView

final int com.foxit.sdk.pdf.annots.Annot.e_FlagNoView = 0x0020
| static

注释标志：无视图。

如果设置，不在屏幕上显示注释或允许用户与其交互。 注释可能被打印（取决于标志com.foxit.sdk.pdf.annots.Annot.e_FlagPrint 的设置）， 但在屏幕显示和用户交互方面应被视为隐藏。

## ◆ e_FlagNoZoom

final int com.foxit.sdk.pdf.annots.Annot.e_FlagNoZoom = 0x0008
| static

注释标志：无缩放。

如果设置，不根据页面的放大倍数缩放注释的外观。 注释在页面上的位置（由其注释矩形的左上角定义） 保持固定，无论页面放大倍数如何。

## ◆ e_FlagPrint

final int com.foxit.sdk.pdf.annots.Annot.e_FlagPrint = 0x0004
| static

注释标志：打印。

如果设置，打印页面时打印注释。如果清除，从不打印注释， 无论它是否显示在屏幕上。这可能很有用，例如， 对于表示交互式按钮的注释，这些按钮在打印页面上没有意义。

## ◆ e_FlagReadOnly

final int com.foxit.sdk.pdf.annots.Annot.e_FlagReadOnly = 0x0040
| static

注释标志：只读。

如果设置，不允许注释与用户交互。注释可能显示或打印 （取决于标志com.foxit.sdk.pdf.annots.Annot.e_FlagNoView 和com.foxit.sdk.pdf.annots.Annot.e_FlagPrint 的设置）， 但不应响应鼠标点击或响应鼠标移动而改变其外观。

注解
  对于小组件注释，此标志被忽略；其功能被相关表单字段的标志 com.foxit.sdk.pdf.interform.Field.e_FlagReadOnly 取代。

## ◆ e_FlagToggleNoView

final int com.foxit.sdk.pdf.annots.Annot.e_FlagToggleNoView = 0x0100
| static

注释标志：切换无视图。

如果设置，为某些事件反转NoView标志的解释。一个典型用途是 使注释仅在鼠标光标悬停在其上时出现。

## ◆ e_MKEntryDownCaption

final int com.foxit.sdk.pdf.annots.Annot.e_MKEntryDownCaption = 5
| static

按下标题（或备用标题）条目。MK字典中的"AC"。

注解
  仅适用于与按钮字段关联的小组件注释。

## ◆ e_MKEntryDownIcon

final int com.foxit.sdk.pdf.annots.Annot.e_MKEntryDownIcon = 8
| static

按下图标（或备用图标）条目。MK字典中的"IX"。

注解
  仅适用于与按钮字段关联的小组件注释。

## ◆ e_MKEntryIconCaptionRelation

final int com.foxit.sdk.pdf.annots.Annot.e_MKEntryIconCaptionRelation = 10
| static

图标和标题关系条目。MK字典中的"TP"。

注解
  仅适用于与按钮字段关联的小组件注释。 用于指定小组件注释的mk标题文本相对于小组件注释的mk图标的位置。

## ◆ e_MKEntryIconFit

final int com.foxit.sdk.pdf.annots.Annot.e_MKEntryIconFit = 9
| static

图标适配信息条目。MK字典中的"IF"。

注解
  仅适用于与按钮字段关联的小组件注释。

## ◆ e_MKEntryNormalCaption

final int com.foxit.sdk.pdf.annots.Annot.e_MKEntryNormalCaption = 3
| static

正常标题条目。MK字典中的"CA"。

注解
  仅适用于与按钮字段、复选框字段或单选按钮字段关联的小组件注释。

## ◆ e_MKEntryNormalIcon

final int com.foxit.sdk.pdf.annots.Annot.e_MKEntryNormalIcon = 6
| static

正常图标条目。MK字典中的"I"。

注解
  仅适用于与按钮字段关联的小组件注释。

## ◆ e_MKEntryRolloverCaption

final int com.foxit.sdk.pdf.annots.Annot.e_MKEntryRolloverCaption = 4
| static

悬停标题条目。MK字典中的"RC"。

注解
  仅适用于与按钮字段关联的小组件注释。

## ◆ e_MKEntryRolloverIcon

final int com.foxit.sdk.pdf.annots.Annot.e_MKEntryRolloverIcon = 7
| static

悬停图标条目。MK字典中的"RI"。

注解
  仅适用于与按钮字段关联的小组件注释。

## ◆ e_PropertyBorderColor

final int com.foxit.sdk.pdf.annots.Annot.e_PropertyBorderColor = 2
| static

注释属性：边框颜色。

自由文本注释可以具有边框颜色属性，但 不支持从自由文本注释中删除此属性。

## ◆ e_PropertyCreationDate

final int com.foxit.sdk.pdf.annots.Annot.e_PropertyCreationDate = 1
| static

注释属性：创建日期。

只有标记注释可以具有创建日期属性。

## ◆ e_PropertyFillColor

final int com.foxit.sdk.pdf.annots.Annot.e_PropertyFillColor = 3
| static

注释属性：填充颜色

只有以下类型的注释可以具有填充颜色属性：
正方形、圆形、自由文本、线条、多边形、折线、编辑。

## ◆ e_Widget

final int com.foxit.sdk.pdf.annots.Annot.e_Widget = 20
| static

注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。

注解
  福昕PDF SDK将小组件注释视为表单控件。