Foxit PDF SDK

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

## Public 成员函数
| Markup ()
| 构造函数
| Markup (Annot annot)
| 构造函数，使用父类对象。 更多...
Note | addReply () throws com.foxit.sdk.PDFException
| 在回复列表的末尾添加新回复。 更多...
void | addRichText (String content, RichTextStyle style) throws com.foxit.sdk.PDFException
| 在末尾添加新的富文本字符串。 更多...
Note | addStateAnnot (String title, int model, int state) throws com.foxit.sdk.PDFException
| 添加新的状态注释。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
float | getBorderOpacity () throws com.foxit.sdk.PDFException
| 获取注释的边框透明度。 更多...
DateTime | getCreationDateTime () throws com.foxit.sdk.PDFException
| 获取创建日期时间。 更多...
float | getFillOpacity () throws com.foxit.sdk.PDFException
| 获取注释的填充透明度。 更多...
MarkupArray | getGroupElements () throws com.foxit.sdk.PDFException
| 从当前标记注释所属的组中获取一个元素（作为标记注释）。 更多...
Markup | getGroupHeader () throws com.foxit.sdk.PDFException
| 获取当前标记注释所属组的头注释（作为主注释）。 更多...
String | getIntent () throws com.foxit.sdk.PDFException
| 获取意图名称。 更多...
float | getOpacity () throws com.foxit.sdk.PDFException
| 获取不透明度值。 更多...
Popup | getPopup () throws com.foxit.sdk.PDFException
| 获取相关的弹出注释。 更多...
Note | getReply (int index) throws com.foxit.sdk.PDFException
| 按索引获取回复。 更多...
int | getReplyCount () throws com.foxit.sdk.PDFException
| 计算所有回复。 更多...
String | getRichTextContent (int index) throws com.foxit.sdk.PDFException
| 获取指定索引的富文本字符串的文本字符串。 更多...
int | getRichTextCount () throws com.foxit.sdk.PDFException
| 获取富文本字符串的数量。 更多...
RichTextStyle | getRichTextStyle (int index) throws com.foxit.sdk.PDFException
| 获取指定索引的富文本字符串的样式数据。 更多...
NoteArray | getStateAnnots (int model) throws com.foxit.sdk.PDFException
| 获取指定状态模型中的所有状态注释。 更多...
String | getSubject () throws com.foxit.sdk.PDFException
| 获取主题字符串。 更多...
String | getTitle () throws com.foxit.sdk.PDFException
| 获取标题字符串。 更多...
void | insertRichText (int index, String content, RichTextStyle style) throws com.foxit.sdk.PDFException
| 在指定索引位置插入新的富文本字符串。 更多...
boolean | isGrouped () throws com.foxit.sdk.PDFException
| 检查当前标记注释是否在组中。 更多...
boolean | removeAllReplies () throws com.foxit.sdk.PDFException
| 删除所有回复。 更多...
boolean | removeAllStateAnnots () throws com.foxit.sdk.PDFException
| 移除所有状态注释。 更多...
boolean | removePopup () throws com.foxit.sdk.PDFException
| 删除相关的弹出注释。 更多...
boolean | removeReply (int index) throws com.foxit.sdk.PDFException
| 按索引删除回复。 更多...
void | removeRichText (int index) throws com.foxit.sdk.PDFException
| 移除指定索引的富文本字符串。 更多...
void | setBorderOpacity (float opacity) throws com.foxit.sdk.PDFException
| 设置注释的边框透明度。 更多...
void | setCreationDateTime (DateTime date_time) throws com.foxit.sdk.PDFException
| 设置创建日期时间。 更多...
void | setFillOpacity (float opacity) throws com.foxit.sdk.PDFException
| 设置注释的填充透明度。 更多...
void | setIntent (String intent) throws com.foxit.sdk.PDFException
| 设置意图名称。 更多...
void | setOpacity (float opacity) throws com.foxit.sdk.PDFException
| 设置不透明度值。 更多...
void | setPopup (Popup popup) throws com.foxit.sdk.PDFException
| 设置相关的弹出注释。 更多...
void | setRichTextContent (int index, String content) throws com.foxit.sdk.PDFException
| 设置指定索引的富文本字符串的文本字符串。 更多...
void | setRichTextStyle (int index, RichTextStyle style) throws com.foxit.sdk.PDFException
| 设置指定索引的富文本字符串的样式数据。 更多...
void | setSubject (String subject) throws com.foxit.sdk.PDFException
| 设置主题字符串。 更多...
void | setTitle (String title) throws com.foxit.sdk.PDFException
| 设置标题字符串。 更多...
boolean | ungroup () throws com.foxit.sdk.PDFException
| 将当前标记注释从其所属的组中解组。 更多...
Public 成员函数 继承自 com.foxit.sdk.pdf.annots.Annot
| Annot ()
| 构造函数。
| Annot (Annot annot)
| 构造函数，使用另一个注释对象。 更多...
| Annot (PDFPage page, PDFDictionary annot_dict) throws com.foxit.sdk.PDFException
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
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_EndingStyleButt = 6
| 端点处垂直于线条本身的短线。
static final int | e_EndingStyleCircle = 2
| 用注释的内部颜色填充的圆形（如果有）。
static final int | e_EndingStyleClosedArrow = 5
| 两条短线以锐角相交（如OpenArrow样式），并由第三条线连接， 形成用注释的内部颜色填充的三角形闭合箭头（如果有）。
static final int | e_EndingStyleDiamond = 3
| 用注释的内部颜色填充的菱形（如果有）。
static final int | e_EndingStyleNone = 0
| 无特殊线条端点。
static final int | e_EndingStyleOpenArrow = 4
| 两条短线以锐角相交形成开放箭头。
static final int | e_EndingStyleRClosedArrow = 8
| 与ClosedArrow方向相反的三角形闭合箭头。
static final int | e_EndingStyleROpenArrow = 7
| 与OpenArrow方向相反的两条短线。
static final int | e_EndingStyleSlash = 9
| 端点处与线条垂直方向约顺时针30度的短线。
static final int | e_EndingStyleSquare = 1
| 用注释的内部颜色填充的正方形（如果有）。
static final int | e_MeasureTypeA = 3
| 面积的测量。
static final int | e_MeasureTypeD = 2
| 任意方向距离的测量。
static final int | e_MeasureTypeS = 5
| 直线斜率的测量。
static final int | e_MeasureTypeT = 4
| 角度的测量。
static final int | e_MeasureTypeX = 0
| 沿x轴变化的测量。
static final int | e_MeasureTypeY = 1
| 沿y轴变化的测量。
static final int | e_StateAccepted = 3
| （与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用） 用户同意更改。
static final int | e_StateCancelled = 5
| （与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用） 更改已被取消。
static final int | e_StateCompleted = 6
| （与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用） 更改已完成。
static final int | e_StateDeferred = 7
| （与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用） 更改已延期。
static final int | e_StateFuture = 8
| （与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用） 更改将在将来进行。
static final int | e_StateMarked = 1
| （与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelMarked 一起使用） 注释已被用户标记。
static final int | e_StateModelMarked = 1
| 标记注释状态模型：已标记。
static final int | e_StateModelReview = 2
| 标记注释状态模型：审阅。
static final int | e_StateNone = 0
| （与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用） 用户没有对更改表示任何意见。
static final int | e_StateRejected = 4
| （与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用） 用户不同意更改。
static final int | e_StateUnmarked = 2
| （与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelMarked 一起使用） 注释尚未被用户标记。
静态 Public 属性 继承自 com.foxit.sdk.pdf.annots.Annot
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文档。这些注释包含文本， 作为注释的一部分出现，并且可能由查看器应用程序以其他方式显示，例如在注释窗格中。
类com.foxit.sdk.pdf.annots.Markup 派生自类Annot ，也是所有PDF标记注释的基类。 它提供获取/设置标记注释公共属性的基础函数。 对于具体的标记注释类型，请参考派生类。
函数Annot.isMarkup 可用于判断注释是否为标记注释。

注解
  目前，以下类型的函数仅支持注记、高亮、下划线、删除线、波浪线、 矩形、圆形、自由文本、印章、插入符、墨迹、直线、多边形、折线、文件附件注释：
  - 类Markup 中的所有"set"函数。
  - 函数Annot.resetAppearanceStream （从Markup 的父类继承）。

参见
  Annot

## 构造及析构函数说明

## ◆ Markup()

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

构造函数，使用父类对象。

参数

  [in] | annot | 父类对象。

## 成员函数说明

## ◆ addReply()

Note com.foxit.sdk.pdf.annots.Markup.addReply | ( |  | ) | throws com.foxit.sdk.PDFException

在回复列表的末尾添加新回复。

返回
  表示新回复注释的新便签注释。

## ◆ addRichText()

void com.foxit.sdk.pdf.annots.Markup.addRichText | ( | String | content,
|  | RichTextStyle | style
| ) |  | throws com.foxit.sdk.PDFException

在末尾添加新的富文本字符串。

标记注释的内容可以由多个富文本字符串组成。 特别地，如果当前注释是自由文本且其意图是"FreeTextTypewriter"，输入样式的文本对齐方式将 被设置给当前自由文本注释的所有富文本字符串。

参数

  [in] | content | 用作新富文本字符串内容的文本字符串。这不应是空字符串。
  [in] | style | 用于新富文本字符串的样式数据。

返回
  无。

## ◆ addStateAnnot()

Note com.foxit.sdk.pdf.annots.Markup.addStateAnnot | ( | String | title,
|  | int | model,
|  | int | state
| ) |  | throws com.foxit.sdk.PDFException

添加新的状态注释。

标记注释可能有一个或多个与其关联的作者特定状态。每个状态不是在注释本身中指定的， 而是在单独的注记注释中指定的。

- 对于状态模型 com.foxit.sdk.pdf.annots.Markup.e_StateModelReview ，每次调用此函数时都会添加一个新的状态注释。
- 对于状态模型 com.foxit.sdk.pdf.annots.Markup.e_StateModelMarked ，此函数将查找具有此模型且 标题与输入参数 title 相同的最新状态注释：如果找到一个，此函数将更改找到的状态注释的状态值并 直接返回找到的状态注释；如果没有找到任何合适的状态注释，此函数将添加一个新的并 返回新的状态注释。

参数

  [in] | title | 新状态注释的标题。标题可用于识别添加当前注释的用户。 这可以是空字符串，但强烈建议用户在使用此函数时设置有意义的标题。
  [in] | model | 新状态注释的状态模型。应为以下值之一： com.foxit.sdk.pdf.annots.Markup.e_StateModelMarked com.foxit.sdk.pdf.annots.Markup.e_StateModelReview
  [in] | state | 新状态注释的状态值。应为以下值之一： 如果参数 model 是 com.foxit.sdk.pdf.annots.Markup.e_StateModelMarked ， 状态应为 com.foxit.sdk.pdf.annots.Markup.e_StateMarked 或 com.foxit.sdk.pdf.annots.Markup.e_StateUnmarked 。 如果参数 model 是 com.foxit.sdk.pdf.annots.Markup.e_StateModelReview ， 状态应为 com.foxit.sdk.pdf.annots.Markup.e_StateAccepted 、com.foxit.sdk.pdf.annots.Markup.e_StateRejected 、 com.foxit.sdk.pdf.annots.Markup.e_StateCancelled 、com.foxit.sdk.pdf.annots.Markup.e_StateCompleted 、 com.foxit.sdk.pdf.annots.Markup.e_StateDeferred 、com.foxit.sdk.pdf.annots.Markup.e_StateFuture 或 com.foxit.sdk.pdf.annots.Markup.e_StateNone 。

返回
  表示新状态注释的注记注释。返回的状态注释的最后修改日期时间 默认情况下将设置为当前本地系统时间。

## ◆ delete()

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

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

返回
  无。

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

重载 com.foxit.sdk.pdf.annots.Annot .

被 com.foxit.sdk.pdf.annots.FreeText, com.foxit.sdk.pdf.annots.FileAttachment, 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.Note, 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.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 重载.

## ◆ getBorderOpacity()

float com.foxit.sdk.pdf.annots.Markup.getBorderOpacity | ( |  | ) | throws com.foxit.sdk.PDFException

获取注释的边框透明度。

返回
  透明度值。有效范围：0.0 到 1.0。 0.0 表示完全透明，1.0 表示完全不透明。

## ◆ getCreationDateTime()

DateTime com.foxit.sdk.pdf.annots.Markup.getCreationDateTime | ( |  | ) | throws com.foxit.sdk.PDFException

获取创建日期时间。

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

## ◆ getFillOpacity()

float com.foxit.sdk.pdf.annots.Markup.getFillOpacity | ( |  | ) | throws com.foxit.sdk.PDFException

获取注释的填充透明度。

返回
  透明度值。有效范围：0.0 到 1.0。 0.0 表示完全透明，1.0 表示完全不透明。

## ◆ getGroupElements()

MarkupArray com.foxit.sdk.pdf.annots.Markup.getGroupElements | ( |  | ) | throws com.foxit.sdk.PDFException

从当前标记注释所属的组中获取一个元素（作为标记注释）。

标记注释可以分组。组由一个主注释和一个或多个从属注释组成。 主注释中的一些条目被视为应适用于整个组的组属性； 从属注释中的相应条目应被忽略。这些条目包括内容、最后修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应尊重 组属性：当组中注释的属性发生更改时，同一组中的其他注释也应进行更改。
操作组中任何注释的操作，如移动、剪切和复制，查看器应用程序应将其视为 作用于整个组。

返回
  包含组中所有标记注释的数组。 如果当前注释不属于组，此函数将返回空数组。

## ◆ getGroupHeader()

Markup com.foxit.sdk.pdf.annots.Markup.getGroupHeader | ( |  | ) | throws com.foxit.sdk.PDFException

获取当前标记注释所属组的头注释（作为主注释）。

标记注释可以分组。组由一个主注释和一个或多个从属注释组成。 主注释中的一些条目被视为应适用于整个组的组属性； 从属注释中的相应条目应被忽略。这些条目包括内容、最后修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应尊重 组属性：当组中注释的属性发生更改时，同一组中的其他注释也应进行更改。
操作组中任何注释的操作，如移动、剪切和复制，查看器应用程序应将其视为 作用于整个组。

返回
  当前标记注释所属组的头标记注释。 如果返回的标记注释对象的函数 Annot.isEmpty （从 Markup 的父类继承） 的返回值为 true，则表示当前注释不属于组。

## ◆ getIntent()

String com.foxit.sdk.pdf.annots.Markup.getIntent | ( |  | ) | throws com.foxit.sdk.PDFException

获取意图名称。

以下注释类型具有预定义的意图名称：

- 自由文本注释的预定义意图名称："FreeTextCallout"、"FreeTextTypewriter"。 如果未使用意图名称，自由文本注释将显示为文本框。
- 直线注释的预定义意图名称："LineArrow"、"LineDimension"。 如果未使用意图名称，直线注释将显示为普通直线。
- 多边形的预定义意图名称："PolygonCloud"、"PolygonDimension"。 如果未使用意图名称，多边形注释将显示为普通多边形。
- 折线注释的预定义意图名称："PolyLineDimension"。 如果未使用意图名称，折线注释将显示为普通折线。

返回
  意图名称字符串。

## ◆ getOpacity()

float com.foxit.sdk.pdf.annots.Markup.getOpacity | ( |  | ) | throws com.foxit.sdk.PDFException

获取不透明度值。

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

返回
  不透明度值。有效范围：0.0 到 1.0。 0.0 表示完全透明，1.0 表示完全不透明。

## ◆ getPopup()

Popup com.foxit.sdk.pdf.annots.Markup.getPopup | ( |  | ) | throws com.foxit.sdk.PDFException

获取相关的弹出注释。

大多数标记注释都可以有弹出注释来显示其内容，除了声音和自由文本注释：

- 声音注释没有弹出注释。
- 自由文本注释直接在页面上显示文本，因此不需要弹出注释。

尽管在某些特殊（或错误）的PDF文档中，声音或自由文本注释可能有弹出注释， 但它们仍然不需要弹出注释。

返回
  相关的弹出注释。如果返回的弹出注释的函数 Annot.isEmpty （从 Popup 的父类继承）的返回值为 true， 则表示当前标记注释没有弹出注释。

## ◆ getReply()

Note com.foxit.sdk.pdf.annots.Markup.getReply | ( | int | index | ) | throws com.foxit.sdk.PDFException

按索引获取回复。

参数

  [in] | index | 指定回复的索引。有效范围：从 0 到 (count-1)。 count 由函数 Markup.getReplyCount 返回。

返回
  表示指定回复注释的便签注释。

## ◆ getReplyCount()

int com.foxit.sdk.pdf.annots.Markup.getReplyCount | ( |  | ) | throws com.foxit.sdk.PDFException

计算所有回复。

返回
  回复的数量。

## ◆ getRichTextContent()

String com.foxit.sdk.pdf.annots.Markup.getRichTextContent | ( | int | index | ) | throws com.foxit.sdk.PDFException

获取指定索引的富文本字符串的文本字符串。

标记注释的内容可以由多个富文本字符串组成。

参数

  [in] | index | 要检索其内容的富文本字符串的索引。有效范围：从 0 到（count-1）。 count 由函数 Markup.getRichTextCount 返回。

返回
  指定富文本的文本字符串。

## ◆ getRichTextCount()

int com.foxit.sdk.pdf.annots.Markup.getRichTextCount | ( |  | ) | throws com.foxit.sdk.PDFException

获取富文本字符串的数量。

标记注释的内容可以由多个富文本字符串组成。

返回
  富文本字符串的数量。

## ◆ getRichTextStyle()

RichTextStyle com.foxit.sdk.pdf.annots.Markup.getRichTextStyle | ( | int | index | ) | throws com.foxit.sdk.PDFException

获取指定索引的富文本字符串的样式数据。

标记注释的内容可以由多个富文本字符串组成。

参数

  [in] | index | 要检索其样式数据的富文本字符串的索引。有效范围：从 0 到（count-1）。 count 由函数 Markup.getRichTextCount 返回。

返回
  指定富文本字符串的样式数据。

## ◆ getStateAnnots()

NoteArray com.foxit.sdk.pdf.annots.Markup.getStateAnnots | ( | int | model | ) | throws com.foxit.sdk.PDFException

获取指定状态模型中的所有状态注释。

标记注释可能有一个或多个与其关联的作者特定状态。每个状态不是在注释本身中指定的， 而是在单独的注记注释中指定的。

参数

  [in] | model | 状态模型。应为以下值之一： com.foxit.sdk.pdf.annots.Markup.e_StateModelMarked com.foxit.sdk.pdf.annots.Markup.e_StateModelReview

返回
  表示指定状态模型中所有状态注释的注记注释数组。 此数组中的所有注释将按时间顺序排列。

## ◆ getSubject()

String com.foxit.sdk.pdf.annots.Markup.getSubject | ( |  | ) | throws com.foxit.sdk.PDFException

获取主题字符串。

返回
  主题字符串。

## ◆ getTitle()

String com.foxit.sdk.pdf.annots.Markup.getTitle | ( |  | ) | throws com.foxit.sdk.PDFException

获取标题字符串。

按惯例，注释的标题可用于识别添加当前注释的用户。

返回
  标题字符串。

## ◆ insertRichText()

void com.foxit.sdk.pdf.annots.Markup.insertRichText | ( | int | index,
|  | String | content,
|  | RichTextStyle | style
| ) |  | throws com.foxit.sdk.PDFException

在指定索引位置插入新的富文本字符串。

标记注释的内容可以由多个富文本字符串组成。 特别地，如果当前注释是自由文本且其意图是"FreeTextTypewriter"，输入样式的文本对齐方式将 被设置给当前自由文本注释的所有富文本字符串。

参数

  [in] | index | 要在其处插入富文本字符串的样式数据的索引。有效范围：从 0 到 count。 count 由函数 Markup.getRichTextCount 返回。 如果输入值等于富文本字符串数量，这意味着将新富文本字符串添加到末尾。 在这种情况下，此函数等同于函数 Markup.addRichText 。
  [in] | content | 用作新富文本字符串内容的文本字符串。这不应是空字符串。
  [in] | style | 用于新富文本字符串的样式数据。

返回
  无。

## ◆ isGrouped()

boolean com.foxit.sdk.pdf.annots.Markup.isGrouped | ( |  | ) | throws com.foxit.sdk.PDFException

检查当前标记注释是否在组中。

标记注释可以分组。组由一个主注释和一个或多个从属注释组成。 主注释中的一些条目被视为应适用于整个组的组属性； 从属注释中的相应条目应被忽略。这些条目包括内容、最后修改时间、填充颜色/边框颜色、 标题、弹出注释、创建时间、主题和打开状态。因此用户应尊重 组属性：当组中注释的属性发生更改时，同一组中的其他注释也应进行更改。
操作组中任何注释的操作，如移动、剪切和复制，查看器应用程序应将其视为 作用于整个组。

返回
  true 表示当前标记注释在组中。 false 表示当前标记注释不属于任何组。

## ◆ removeAllReplies()

boolean com.foxit.sdk.pdf.annots.Markup.removeAllReplies | ( |  | ) | throws com.foxit.sdk.PDFException

删除所有回复。

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

## ◆ removeAllStateAnnots()

boolean com.foxit.sdk.pdf.annots.Markup.removeAllStateAnnots | ( |  | ) | throws com.foxit.sdk.PDFException

移除所有状态注释。

状态注释由注记注释表示，因此移除状态注释意味着 从页面中移除此类注记注释（及其弹出注释，如果有的话）。

返回
  true 表示成功移除所有状态注释或当前注释没有任何状态注释， false 表示失败。

## ◆ removePopup()

boolean com.foxit.sdk.pdf.annots.Markup.removePopup | ( |  | ) | throws com.foxit.sdk.PDFException

删除相关的弹出注释。

返回
  true表示相关的弹出注释被成功删除， 而false表示当前标记注释没有相关的弹出注释。

## ◆ removeReply()

boolean com.foxit.sdk.pdf.annots.Markup.removeReply | ( | int | index | ) | throws com.foxit.sdk.PDFException

按索引删除回复。

如果指定的回复有自己的回复，这些子回复将同时被删除。

参数

  [in] | index | 要删除的指定回复的索引。有效范围：从 0 到 (count-1)。 count 由函数 Markup.getReplyCount 返回。

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

## ◆ removeRichText()

void com.foxit.sdk.pdf.annots.Markup.removeRichText | ( | int | index | ) | throws com.foxit.sdk.PDFException

移除指定索引的富文本字符串。

标记注释的内容可以由多个富文本字符串组成。

参数

  [in] | index | 要在其处插入样式数据的富文本字符串的索引。有效范围：从 0 到（count-1）。 count 由函数 Markup.getRichTextCount 返回。

返回
  无。

## ◆ setBorderOpacity()

void com.foxit.sdk.pdf.annots.Markup.setBorderOpacity | ( | float | opacity | ) | throws com.foxit.sdk.PDFException

设置注释的边框透明度。

此属性影响标记注释的外观。如果用户希望新的透明度值对注释外观产生效果， 请在设置新透明度值后调用函数 Annot.resetAppearanceStream 。

参数

  [in] | opacity | 新的透明度值。有效范围：0.0 到 1.0。 0.0 means full transparency and 1.0 means full opaque.

返回
  None.

## ◆ setCreationDateTime()

void com.foxit.sdk.pdf.annots.Markup.setCreationDateTime | ( | DateTime | date_time | ) | throws com.foxit.sdk.PDFException

设置创建日期时间。

参数

  [in] | date_time | 要设置的新日期时间。

返回
  无。

## ◆ setFillOpacity()

void com.foxit.sdk.pdf.annots.Markup.setFillOpacity | ( | float | opacity | ) | throws com.foxit.sdk.PDFException

设置注释的填充透明度。

此属性影响标记注释的外观。如果用户希望新的透明度值对注释外观产生效果， 请在设置新透明度值后调用函数 Annot.resetAppearanceStream 。

参数

  [in] | opacity | 新的透明度值。有效范围：0.0 到 1.0。 0.0 表示完全透明，1.0 表示完全不透明。

返回
  无。

## ◆ setIntent()

void com.foxit.sdk.pdf.annots.Markup.setIntent | ( | String | intent | ) | throws com.foxit.sdk.PDFException

设置意图名称。

以下注释类型具有预定义的意图名称：

- 自由文本注释的预定义意图名称："FreeTextCallout"、"FreeTextTypewriter"。 如果未使用意图名称，自由文本注释将显示为文本框。 如果意图名称为 FreeTextTypewriter，边框颜色将被移除。
- 直线注释的预定义意图名称："LineArrow"、"LineDimension"。 如果未使用意图名称，直线注释将显示为普通直线。
  如果直线注释的意图设置为"LineArrow"，直线注释的线条结束样式 将默认为起点 com.foxit.sdk.pdf.annots.Markup.e_EndingStyleNone 和 终点 com.foxit.sdk.pdf.annots.Markup.e_EndingStyleOpenArrow 。
- 多边形的预定义意图名称："PolygonCloud"、"PolygonDimension"。 如果未使用意图名称，多边形注释将显示为普通多边形。
  如果多边形注释的意图设置为"PolygonCloud"，多边形注释的 边框样式将更改为 com.foxit.sdk.pdf.annots.BorderInfo.e_Cloudy ， 边框云状强度将默认设置为 2。
- 折线注释的预定义意图名称："PolyLineDimension"。 如果未使用意图名称，折线注释将显示为普通折线。

如果已为相应类型的注释设置了支持的预定义意图名称，用户应调用 函数 Annot.resetAppearanceStream 以在注释外观上产生效果。

参数

  [in] | intent | 要设置的新意图名称字符串。如果为空字符串，则表示不会使用意图属性。 某些注释类型具有预定义的意图名称，请参考"详细信息"部分了解更多详情。 如果此字符串是不支持的意图名称之一，设置到相应注释时将忽略此字符串。

返回
  无。

## ◆ setOpacity()

void com.foxit.sdk.pdf.annots.Markup.setOpacity | ( | float | opacity | ) | throws com.foxit.sdk.PDFException

设置不透明度值。

此属性对标记注释的外观有影响。如果用户希望新的不透明度值对 注释的外观有影响，请在设置新不透明度值后调用函数 Annot.resetAppearanceStream 。

参数

  [in] | opacity | 新的不透明度值。有效范围：0.0 到 1.0。 0.0 表示完全透明，1.0 表示完全不透明。

返回
  无。

## ◆ setPopup()

void com.foxit.sdk.pdf.annots.Markup.setPopup | ( | Popup | popup | ) | throws com.foxit.sdk.PDFException

设置相关的弹出注释。

大多数标记注释都可以有弹出注释来显示其内容，除了声音和自由文本注释：

- 声音注释没有弹出注释。
- 自由文本注释直接在页面上显示文本，因此不需要弹出注释。

因此，此函数不允许为声音和自由文本注释设置弹出注释。

参数

  [in] | popup | 要设置到当前标记注释的有效弹出注释。

返回
  无。

## ◆ setRichTextContent()

void com.foxit.sdk.pdf.annots.Markup.setRichTextContent | ( | int | index,
|  | String | content
| ) |  | throws com.foxit.sdk.PDFException

设置指定索引的富文本字符串的文本字符串。

标记注释的内容可以由多个富文本字符串组成。

参数

  [in] | index | 要设置其内容的富文本字符串的索引。有效范围：从 0 到（count-1）。 count 由函数 Markup.getRichTextCount 返回。
  [in] | content | 要设置为指定富文本内容的文本字符串。这不应是空字符串。

返回
  无。

## ◆ setRichTextStyle()

void com.foxit.sdk.pdf.annots.Markup.setRichTextStyle | ( | int | index,
|  | RichTextStyle | style
| ) |  | throws com.foxit.sdk.PDFException

设置指定索引的富文本字符串的样式数据。

标记注释的内容可以由多个富文本字符串组成。
特别地，如果当前注释是自由文本且其意图是"FreeTextTypewriter"，输入样式的文本对齐方式将 被设置给当前自由文本注释的所有富文本字符串。

参数

  [in] | index | 要检索其样式数据的富文本字符串的索引。有效范围：从 0 到（count-1）。 count 由函数 Markup.getRichTextCount 返回。
  [in] | style | 用于设置到指定富文本的样式数据。

返回
  无。

## ◆ setSubject()

void com.foxit.sdk.pdf.annots.Markup.setSubject | ( | String | subject | ) | throws com.foxit.sdk.PDFException

设置主题字符串。

参数

  [in] | subject | 要设置的新主题字符串。

返回
  无。

## ◆ setTitle()

void com.foxit.sdk.pdf.annots.Markup.setTitle | ( | String | title | ) | throws com.foxit.sdk.PDFException

设置标题字符串。

按惯例，注释的标题可用于识别添加当前注释的用户。

参数

  [in] | title | 要设置的新标题字符串。

返回
  无。

## ◆ ungroup()

boolean com.foxit.sdk.pdf.annots.Markup.ungroup | ( |  | ) | throws com.foxit.sdk.PDFException

将当前标记注释从其所属的组中解组。

- 如果当前标记注释只是组头，此函数将解散整个组。
- 如果当前标记注释只是组的成员，此函数将仅将当前标记注释从其所属的组中解组。
- 如果当前标记注释不属于任何组，此函数将不执行任何操作并直接返回 false。

返回
  true 表示成功，false 表示当前标记注释不属于任何组。