Foxit PDF SDK

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

## Public 成员函数
| Widget ()
| 构造函数。
| Widget (Annot annot)
| 构造函数，使用父类对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
Action | getAction () throws com.foxit.sdk.PDFException
| 获取动作。 更多...
String | getAppearanceOnStateName () throws com.foxit.sdk.PDFException
| 获取注释外观"ON"状态的名称。 更多...
String | getAppearanceState () throws com.foxit.sdk.PDFException
| 获取注释的外观状态，从外观子字典中选择适用的外观流。 更多...
Control | getControl () throws com.foxit.sdk.PDFException
| 获取关联的表单控件。 更多...
Field | getField () throws com.foxit.sdk.PDFException
| 获取关联的表单字段。 更多...
int | getHighlightingMode () throws com.foxit.sdk.PDFException
| 获取高亮模式。 更多...
int | getLineSpacing (java.lang.Float line_spacing_value) throws com.foxit.sdk.PDFException
| 获取当前小部件的行间距。 更多...
long | getMKBackgroundColor () throws com.foxit.sdk.PDFException
| 获取 MK 字典中的背景颜色。 更多...
long | getMKBorderColor () throws com.foxit.sdk.PDFException
| 获取 MK 字典中的边框颜色。 更多...
String | getMKDownCaption () throws com.foxit.sdk.PDFException
| 获取 MK 字典中的向下标题字符串。 更多...
Bitmap | getMKDownIconBitmap () throws com.foxit.sdk.PDFException
| 获取MK字典中的按下图标位图。 更多...
int | getMKIconCaptionRelation () throws com.foxit.sdk.PDFException
| 获取MK字典中图标和标题的关系。 更多...
IconFit | getMKIconFit () throws com.foxit.sdk.PDFException
| 获取MK字典中的图标适合信息。 更多...
String | getMKNormalCaption () throws com.foxit.sdk.PDFException
| 获取 MK 字典中的普通标题字符串。 更多...
Bitmap | getMKNormalIconBitmap () throws com.foxit.sdk.PDFException
| 获取 MK 字典中的普通图标位图。 更多...
String | getMKRolloverCaption () throws com.foxit.sdk.PDFException
| 获取 MK 字典中的翻转标题字符串。 更多...
Bitmap | getMKRolloverIconBitmap () throws com.foxit.sdk.PDFException
| 获取 MK 字典中的翻转图标位图。 更多...
int | getMKRotation () throws com.foxit.sdk.PDFException
| 获取 MK 字典中的旋转值。 更多...
boolean | hasMKEntry (int mk_entry) throws com.foxit.sdk.PDFException
| 检查在 MK 字典中是否存在指定的条目。 更多...
void | removeAction () throws com.foxit.sdk.PDFException
| 移除动作。 更多...
void | removeMKEntry (int mk_entry) throws com.foxit.sdk.PDFException
| 从 MK 字典中移除指定的条目。 更多...
void | setAction (Action action) throws com.foxit.sdk.PDFException
| 设置动作。 更多...
void | setAppearanceState (String appearance_state) throws com.foxit.sdk.PDFException
| 设置注释的外观状态，从外观子字典中选择适用的外观流。 更多...
void | setHighlightingMode (int mode) throws com.foxit.sdk.PDFException
| 设置高亮模式。 更多...
void | setLineSpacing (int line_spacing_style, float line_spacing_value) throws com.foxit.sdk.PDFException
| 设置当前小部件的行间距。 更多...
void | setMKBackgroundColor (long color) throws com.foxit.sdk.PDFException
| 设置 MK 字典中的背景颜色。 更多...
void | setMKBorderColor (long color) throws com.foxit.sdk.PDFException
| 设置 MK 字典中的边框颜色。 更多...
void | setMKDownCaption (String caption) throws com.foxit.sdk.PDFException
| 设置 MK 字典中的向下标题字符串。 更多...
void | setMKDownIconBitmap (Bitmap bitmap) throws com.foxit.sdk.PDFException
| 设置MK字典中的按下图标位图。 更多...
void | setMKDownIconImage (Image image, int frame_index) throws com.foxit.sdk.PDFException
| 设置指定帧索引的图像作为MK字典中的按下图标。 更多...
void | setMKIconCaptionRelation (int relation) throws com.foxit.sdk.PDFException
| 设置MK字典中图标和标题的关系。 更多...
void | setMKIconFit (IconFit icon_fit) throws com.foxit.sdk.PDFException
| 设置MK字典中的图标适合信息。 更多...
void | setMKNormalCaption (String caption) throws com.foxit.sdk.PDFException
| 设置 MK 字典中的普通标题字符串。 更多...
void | setMKNormalIconBitmap (Bitmap bitmap) throws com.foxit.sdk.PDFException
| 设置一个位图作为 MK 字典中的普通图标。 更多...
void | setMKNormalIconImage (Image image, int frame_index) throws com.foxit.sdk.PDFException
| 设置指定帧索引的图像作为 MK 字典中的普通图标。 更多...
void | setMKRolloverCaption (String caption) throws com.foxit.sdk.PDFException
| 设置 MK 字典中的翻转标题字符串。 更多...
void | setMKRolloverIconBitmap (Bitmap bitmap) throws com.foxit.sdk.PDFException
| 设置MK字典中的翻转图标位图。 更多...
void | setMKRolloverIconImage (Image image, int frame_index) throws com.foxit.sdk.PDFException
| 设置指定帧索引的图像作为MK字典中的翻转图标。 更多...
void | setMKRotation (int rotation) throws com.foxit.sdk.PDFException
| 设置 MK 字典中的旋转值。 更多...
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_LineSpacingAuto = 4
| 行间距样式：自动行间距。
static final int | e_LineSpacingDouble = 2
| 行间距样式：双倍行间距。
static final int | e_LineSpacingExactValue = 3
| 行间距样式：精确值行间距。
static final int | e_LineSpacingOneAndHalf = 1
| 行间距样式：1.5倍行间距。
static final int | e_LineSpacingSingle = 0
| 行间距样式：单倍行间距。
静态 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>中的标准注释之一。 更多...

## 详细描述

小部件注释用于表示表单字段的外观。
类 com.foxit.sdk.pdf.annots.Widget 派生自类 Annot ，并且还提供了获取/设置小部件注释属性的函数。 函数 Widget.getField 和 Widget.getControl 可用于获取关联的表单字段 和表单控件对象。如果小部件注释没有与任何表单字段关联或与 签名字段关联，此小部件仍可以获取/设置属性，但无法重置外观。对于这些情况， Annot.resetAppearanceStream （从 Widget 的父类继承）将直接返回 false。

参见
  Annot
  com.foxit.sdk.pdf.interform.Field
  com.foxit.sdk.pdf.interform.Control

## 构造及析构函数说明

## ◆ Widget()

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

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

参数

  [in] | annot | 父类对象。

## 成员函数说明

## ◆ delete()

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

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

返回
  无。

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

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

## ◆ getAction()

Action com.foxit.sdk.pdf.annots.Widget.getAction | ( |  | ) | throws com.foxit.sdk.PDFException

获取动作。

此函数不能用于获取用作附加动作的动作。 如果用户想要获取任何附加动作，请参考类 com.foxit.sdk.pdf.actions.AdditionalAction 了解更多详情。

返回
  接收动作数据的动作对象。如果返回的动作对象的函数 actions.Action.isEmpty 返回值为 true，那意味着没有动作。

## ◆ getAppearanceOnStateName()

String com.foxit.sdk.pdf.annots.Widget.getAppearanceOnStateName | ( |  | ) | throws com.foxit.sdk.PDFException

获取注释外观"ON"状态的名称。

返回
  注释外观"ON"状态的名称。

## ◆ getAppearanceState()

String com.foxit.sdk.pdf.annots.Widget.getAppearanceState | ( |  | ) | throws com.foxit.sdk.PDFException

获取注释的外观状态，从外观子字典中选择适用的外观流。

返回
  注释的外观状态。

## ◆ getControl()

Control com.foxit.sdk.pdf.annots.Widget.getControl | ( |  | ) | throws com.foxit.sdk.PDFException

获取关联的表单控件。

返回
  关联的表单控件对象。

## ◆ getField()

Field com.foxit.sdk.pdf.annots.Widget.getField | ( |  | ) | throws com.foxit.sdk.PDFException

获取关联的表单字段。

返回
  关联的表单字段对象。

## ◆ getHighlightingMode()

int com.foxit.sdk.pdf.annots.Widget.getHighlightingMode | ( |  | ) | throws com.foxit.sdk.PDFException

获取高亮模式。

高亮模式是当鼠标按钮在其活动区域内按下或保持按下时使用的视觉效果。

返回
  高亮模式值。请参考从com.foxit.sdk.pdf.annots.Annot.e_HighlightingNone 开始的值， 这将是这些值中的一个。

## ◆ getLineSpacing()

int com.foxit.sdk.pdf.annots.Widget.getLineSpacing | ( | java.lang.Float | line_spacing_value | ) | throws com.foxit.sdk.PDFException

获取当前小部件的行间距。

这仅适用于与包含标志com.foxit.sdk.pdf.interform.Field.e_FlagTextMultiline 的文本字段关联的小部件。 对于其他类型的字段，这将无用。

参数

  [out] | line_spacing_value | 接收行间距精确值的输出参数。

返回
  行间距样式。请参考从com.foxit.sdk.pdf.annots.Widget.e_LineSpacingSingle 开始的值， 这将是这些值中的一个。

## ◆ getMKBackgroundColor()

long com.foxit.sdk.pdf.annots.Widget.getMKBackgroundColor | ( |  | ) | throws com.foxit.sdk.PDFException

获取 MK 字典中的背景颜色。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

返回
  MK 字典中的背景颜色。值格式：0xRRGGBB。
  0 可能表示 MK 字典中没有背景颜色。在这种情况下，请使用值 com.foxit.sdk.pdf.annots.Annot.e_MKEntryBackgroundColor 调用函数 Widget.hasMKEntry 进行检查。

## ◆ getMKBorderColor()

long com.foxit.sdk.pdf.annots.Widget.getMKBorderColor | ( |  | ) | throws com.foxit.sdk.PDFException

获取 MK 字典中的边框颜色。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

返回
  MK 字典中的边框颜色。值格式：0xRRGGBB。
  0 可能表示 MK 字典中没有边框颜色。在这种情况下，请使用值 com.foxit.sdk.pdf.annots.Annot.e_MKEntryBorderColor 调用函数 Widget.hasMKEntry 进行检查。

## ◆ getMKDownCaption()

String com.foxit.sdk.pdf.annots.Widget.getMKDownCaption | ( |  | ) | throws com.foxit.sdk.PDFException

获取 MK 字典中的向下标题字符串。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的向下标题（或备用标题）用于在鼠标按钮在其活动区域内按下时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

返回
  向下标题字符串。空字符串可能表示 MK 字典中没有向下标题。在这种情况下， 请使用值 com.foxit.sdk.pdf.annots.Annot.e_MKEntryDownCaption 调用函数 Widget.hasMKEntry 进行检查。

## ◆ getMKDownIconBitmap()

Bitmap com.foxit.sdk.pdf.annots.Widget.getMKDownIconBitmap | ( |  | ) | throws com.foxit.sdk.PDFException

获取MK字典中的按下图标位图。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK字典中的按下图标（或备用图标）用于在鼠标按钮在其活动区域内 按下时显示。这适用于与按钮字段关联的小部件。 对于其他类型的字段，这将无用。

返回
  按下图标位图。如果返回的位图对象的函数common.Bitmap.isEmpty 返回true， 则表示当前小部件注释没有按下图标位图。

## ◆ getMKIconCaptionRelation()

int com.foxit.sdk.pdf.annots.Widget.getMKIconCaptionRelation | ( |  | ) | throws com.foxit.sdk.PDFException

获取MK字典中图标和标题的关系。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 标题和图标的关系位置指定小部件注释标题文本相对于其图标的位置。 这适用于与按钮字段关联的小部件。对于其他类型的字段， 这将无用。

返回
  标题和图标的关系位置。请参考com.foxit.sdk.pdf.annots.Annot.e_MKRelationNoIcon 值，这应该是这些值中的一个。

## ◆ getMKIconFit()

IconFit com.foxit.sdk.pdf.annots.Widget.getMKIconFit | ( |  | ) | throws com.foxit.sdk.PDFException

获取MK字典中的图标适合信息。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 图标适合信息指定如何在注释矩形内显示小部件注释的图标。 如果存在，图标适合信息适用于注释的所有图标。 这适用于与按钮字段关联的小部件。对于其他类型的字段， 这将无用。

返回
  图标适合对象，包含MK字典中的图标适合信息。 如果图标适合对象的缩放方式类型是值com.foxit.sdk.pdf.annots.IconFit.e_ScaleWayNone ， 则表示MK字典中没有图标适合信息。

## ◆ getMKNormalCaption()

String com.foxit.sdk.pdf.annots.Widget.getMKNormalCaption | ( |  | ) | throws com.foxit.sdk.PDFException

获取 MK 字典中的普通标题字符串。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的普通标题用于在小部件不与用户交互时显示。 这适用于与按钮字段、复选框字段或单选按钮字段关联的小部件。 对于其他类型的字段，这将无用。

返回
  普通标题字符串。 空字符串可能表示 MK 字典中没有普通标题。在这种情况下，请使用值 com.foxit.sdk.pdf.annots.Annot.e_MKEntryNormalCaption 调用函数 Widget.hasMKEntry 进行检查。

## ◆ getMKNormalIconBitmap()

Bitmap com.foxit.sdk.pdf.annots.Widget.getMKNormalIconBitmap | ( |  | ) | throws com.foxit.sdk.PDFException

获取 MK 字典中的普通图标位图。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的普通图标用于在小部件不与用户交互时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

返回
  普通图标位图。如果返回的位图对象的函数 common.Bitmap.isEmpty 返回 true， 那意味着当前小部件注释没有普通图标位图。

## ◆ getMKRolloverCaption()

String com.foxit.sdk.pdf.annots.Widget.getMKRolloverCaption | ( |  | ) | throws com.foxit.sdk.PDFException

获取 MK 字典中的翻转标题字符串。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的翻转标题用于在用户将光标移动到其活动区域内 但不按下鼠标按钮时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段， 这将无用。

返回
  翻转标题字符串。 空字符串可能表示 MK 字典中没有翻转标题。在这种情况下，请使用值 com.foxit.sdk.pdf.annots.Annot.e_MKEntryRolloverCaption 调用函数 Widget.hasMKEntry 进行检查。

## ◆ getMKRolloverIconBitmap()

Bitmap com.foxit.sdk.pdf.annots.Widget.getMKRolloverIconBitmap | ( |  | ) | throws com.foxit.sdk.PDFException

获取 MK 字典中的翻转图标位图。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的翻转图标用于在用户将光标移动到其活动区域内 但不按下鼠标按钮时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

返回
  翻转图标位图。如果返回的位图对象的函数 common.Bitmap.isEmpty 返回 true，那意味着当前小部件注释没有翻转图标位图。

## ◆ getMKRotation()

int com.foxit.sdk.pdf.annots.Widget.getMKRotation | ( |  | ) | throws com.foxit.sdk.PDFException

获取 MK 字典中的旋转值。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的旋转指定了小部件注释相对于页面逆时针旋转的度数。

返回
  MK 字典中的旋转值。请参考从 com.foxit.sdk.common.Constants.e_Rotation0 开始的值， 这将是这些值中的一个。值 com.foxit.sdk.common.Constants.e_RotationUnknown 表示 MK 字典中没有旋转。 特别地，返回的旋转值表示逆时针方向。

## ◆ hasMKEntry()

boolean com.foxit.sdk.pdf.annots.Widget.hasMKEntry | ( | int | mk_entry | ) | throws com.foxit.sdk.PDFException

检查在 MK 字典中是否存在指定的条目。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

参数

  [in] | mk_entry | MK 字典中的一个条目。请参考从 com.foxit.sdk.pdf.annots.Annot.e_MKEntryRotation 开始的值，这应该是这些值中的一个。

返回
  true 表示指定的条目存在于 MK 字典中，而 false 表示不存在。

## ◆ removeAction()

void com.foxit.sdk.pdf.annots.Widget.removeAction | ( |  | ) | throws com.foxit.sdk.PDFException

移除动作。

此函数不能用于移除用作附加动作的动作。 如果用户想要移除任何附加动作，请参考类 com.foxit.sdk.pdf.actions.AdditionalAction 了解更多详情。

返回
  无。

## ◆ removeMKEntry()

void com.foxit.sdk.pdf.annots.Widget.removeMKEntry | ( | int | mk_entry | ) | throws com.foxit.sdk.PDFException

从 MK 字典中移除指定的条目。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

参数

  [in] | mk_entry | MK 字典中的一个条目。请参考从 com.foxit.sdk.pdf.annots.Annot.e_MKEntryRotation 开始的值，这应该是这些值中的一个。

返回
  无。

## ◆ setAction()

void com.foxit.sdk.pdf.annots.Widget.setAction | ( | Action | action | ) | throws com.foxit.sdk.PDFException

设置动作。

此函数不能用于设置用作附加动作的动作。 如果用户想要设置任何附加动作，请参考类 com.foxit.sdk.pdf.actions.AdditionalAction 了解更多详情。

参数

  [in] | action | 要设置的新动作。它应该是有效的。 当前仅支持以下类型作为新动作： com.foxit.sdk.pdf.actions.Action.e_TypeGoto , com.foxit.sdk.pdf.actions.Action.e_TypeURI , com.foxit.sdk.pdf.actions.Action.e_TypeJavaScript , com.foxit.sdk.pdf.actions.Action.e_TypeNamed , com.foxit.sdk.pdf.actions.Action.e_TypeGoToR , com.foxit.sdk.pdf.actions.Action.e_TypeGoToE , com.foxit.sdk.pdf.actions.Action.e_TypeSubmitForm , com.foxit.sdk.pdf.actions.Action.e_TypeResetForm , com.foxit.sdk.pdf.actions.Action.e_TypeHide , com.foxit.sdk.pdf.actions.Action.e_TypeLaunch , com.foxit.sdk.pdf.actions.Action.e_TypeImportData , com.foxit.sdk.pdf.actions.Action.e_TypeRendition 。

返回
  无。

## ◆ setAppearanceState()

void com.foxit.sdk.pdf.annots.Widget.setAppearanceState | ( | String | appearance_state | ) | throws com.foxit.sdk.PDFException

设置注释的外观状态，从外观子字典中选择适用的外观流。

参数

  [in] | appearance_state | 注释的外观状态。

返回
  无。

## ◆ setHighlightingMode()

void com.foxit.sdk.pdf.annots.Widget.setHighlightingMode | ( | int | mode | ) | throws com.foxit.sdk.PDFException

设置高亮模式。

高亮模式是当鼠标按钮在其活动区域内按下或保持按下时使用的视觉效果。

参数

  [in] | mode | 新的高亮模式值。请参考从 com.foxit.sdk.pdf.annots.Annot.e_HighlightingNone 开始的值， 这应该是这些值中的一个。

返回
  无。

## ◆ setLineSpacing()

void com.foxit.sdk.pdf.annots.Widget.setLineSpacing | ( | int | line_spacing_style,
|  | float | line_spacing_value
| ) |  | throws com.foxit.sdk.PDFException

设置当前小部件的行间距。

这仅适用于与包含标志com.foxit.sdk.pdf.interform.Field.e_FlagTextMultiline 的文本字段关联的小部件。 对于其他类型的字段，这将无用。

参数

  [in] | line_spacing_style | 要设置给当前小部件的行间距样式。请参考从com.foxit.sdk.pdf.annots.Widget.e_LineSpacingSingle 开始的值， 这应该是这些值中的一个。
  [in] | line_spacing_value | 当参数line_spacing_style为 com.foxit.sdk.pdf.annots.Widget.e_LineSpacingExactValue 时，要设置给当前小部件的行间距精确值。 当此参数有用时，此参数必须是非负值，单位应为"pt"（称为点）。 如果此值为零，行间距的效果将与单倍行间距相同。

返回
  无。

## ◆ setMKBackgroundColor()

void com.foxit.sdk.pdf.annots.Widget.setMKBackgroundColor | ( | long | color | ) | throws com.foxit.sdk.PDFException

设置 MK 字典中的背景颜色。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

参数

  [in] | color | 要在 MK 字典中设置的背景颜色。值格式：0xRRGGBB。

返回
  无。

## ◆ setMKBorderColor()

void com.foxit.sdk.pdf.annots.Widget.setMKBorderColor | ( | long | color | ) | throws com.foxit.sdk.PDFException

设置 MK 字典中的边框颜色。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。

参数

  [in] | color | 要在 MK 字典中设置的边框颜色。值格式：0xRRGGBB。

返回
  无。

## ◆ setMKDownCaption()

void com.foxit.sdk.pdf.annots.Widget.setMKDownCaption | ( | String | caption | ) | throws com.foxit.sdk.PDFException

设置 MK 字典中的向下标题字符串。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的向下标题（或备用标题）用于在鼠标按钮在其活动区域内按下时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

参数

  [in] | caption | 要在 MK 字典中设置的向下标题字符串。它可以是空字符串。

返回
  无。

## ◆ setMKDownIconBitmap()

void com.foxit.sdk.pdf.annots.Widget.setMKDownIconBitmap | ( | Bitmap | bitmap | ) | throws com.foxit.sdk.PDFException

设置MK字典中的按下图标位图。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK字典中的按下图标（或备用图标）用于在鼠标按钮在其活动区域内 按下时显示。这适用于与按钮字段关联的小部件。 对于其他类型的字段，这将无用。

参数

  [in] | bitmap | 要设置为MK字典中按下图标的有效位图。

返回
  无。

## ◆ setMKDownIconImage()

void com.foxit.sdk.pdf.annots.Widget.setMKDownIconImage | ( | Image | image,
|  | int | frame_index
| ) |  | throws com.foxit.sdk.PDFException

设置指定帧索引的图像作为MK字典中的按下图标。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK字典中的按下图标（或备用图标）用于在鼠标按钮在其活动区域内 按下时显示。这适用于与按钮字段关联的小部件。 对于其他类型的字段，这将无用。

参数

  [in] | image | 图像。其中一帧将被设置为MK字典中的按下图标。 此图像应包含至少一帧，图像类型不应为 com.foxit.sdk.common.Image.e_Unknown 。
  [in] | frame_index | 帧索引。有效范围：从0到(count-1)。 count由函数common.Image.getFrameCount 返回。

## ◆ setMKIconCaptionRelation()

void com.foxit.sdk.pdf.annots.Widget.setMKIconCaptionRelation | ( | int | relation | ) | throws com.foxit.sdk.PDFException

设置MK字典中图标和标题的关系。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 标题和图标的关系位置指定小部件注释标题文本相对于其图标的位置。 这适用于与按钮字段关联的小部件。对于其他类型的字段， 这将无用。

参数

  [in] | relation | 标题和图标的关系位置。请参考从 com.foxit.sdk.pdf.annots.Annot.e_MKRelationNoIcon 开始的值，这应该是这些值中的一个。

返回
  无。

## ◆ setMKIconFit()

void com.foxit.sdk.pdf.annots.Widget.setMKIconFit | ( | IconFit | icon_fit | ) | throws com.foxit.sdk.PDFException

设置MK字典中的图标适合信息。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 图标适合信息指定如何在注释矩形内显示小部件注释的图标。 如果存在，图标适合信息适用于注释的所有图标。 这适用于与按钮字段关联的小部件。对于其他类型的字段， 这将无用。

参数

  [in] | icon_fit | 表示要在MK字典中设置的图标适合信息的图标适合对象。 如果此对象中任何成员的值无效，此函数将抛出异常 com.foxit.sdk.common.Constants.e_ErrParam 。 请参考类IconFit 检查每个成员的有效值范围。

返回
  无。

## ◆ setMKNormalCaption()

void com.foxit.sdk.pdf.annots.Widget.setMKNormalCaption | ( | String | caption | ) | throws com.foxit.sdk.PDFException

设置 MK 字典中的普通标题字符串。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的普通标题用于在小部件不与用户交互时显示。 这适用于与按钮字段、复选框字段或单选按钮字段关联的小部件。 对于其他类型的字段，这将无用。

参数

  [in] | caption | 要在 MK 字典中设置的普通标题字符串。它可以是空字符串。

返回
  无。

## ◆ setMKNormalIconBitmap()

void com.foxit.sdk.pdf.annots.Widget.setMKNormalIconBitmap | ( | Bitmap | bitmap | ) | throws com.foxit.sdk.PDFException

设置一个位图作为 MK 字典中的普通图标。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的普通图标用于在小部件不与用户交互时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

参数

  [in] | bitmap | 要在 MK 字典中设置为普通图标的有效位图。

返回
  无。

## ◆ setMKNormalIconImage()

void com.foxit.sdk.pdf.annots.Widget.setMKNormalIconImage | ( | Image | image,
|  | int | frame_index
| ) |  | throws com.foxit.sdk.PDFException

设置指定帧索引的图像作为 MK 字典中的普通图标。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的普通图标用于在小部件不与用户交互时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

参数

  [in] | image | 图像。其中一帧将被设置为 MK 字典中的普通图标。 此图像应包含至少一帧，且图像类型不应为 com.foxit.sdk.common.Image.e_Unknown 。
  [in] | frame_index | 帧索引。有效范围：从 0 到（count-1）。 count 由函数 common.Image.getFrameCount 返回。

## ◆ setMKRolloverCaption()

void com.foxit.sdk.pdf.annots.Widget.setMKRolloverCaption | ( | String | caption | ) | throws com.foxit.sdk.PDFException

设置 MK 字典中的翻转标题字符串。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的翻转标题用于在用户将光标移动到其活动区域内 但不按下鼠标按钮时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段， 这将无用。

参数

  [in] | caption | 要在 MK 字典中设置的翻转标题字符串。它可以是空字符串。

返回
  无。

## ◆ setMKRolloverIconBitmap()

void com.foxit.sdk.pdf.annots.Widget.setMKRolloverIconBitmap | ( | Bitmap | bitmap | ) | throws com.foxit.sdk.PDFException

设置MK字典中的翻转图标位图。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK字典中的翻转图标用于在用户将光标移动到其活动区域内 但不按下鼠标按钮时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

参数

  [in] | bitmap | 要设置为MK字典中翻转图标的有效位图。

返回
  无。

## ◆ setMKRolloverIconImage()

void com.foxit.sdk.pdf.annots.Widget.setMKRolloverIconImage | ( | Image | image,
|  | int | frame_index
| ) |  | throws com.foxit.sdk.PDFException

设置指定帧索引的图像作为MK字典中的翻转图标。

MK字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK字典中的翻转图标用于在用户将光标移动到其活动区域内 但不按下鼠标按钮时显示。 这适用于与按钮字段关联的小部件。对于其他类型的字段，这将无用。

参数

  [in] | image | 图像。其中一帧将被设置为MK字典中的翻转图标。 此图像应包含至少一帧，图像类型不应为 com.foxit.sdk.common.Image.e_Unknown 。
  [in] | frame_index | 帧索引。有效范围：从0到(count-1)。 count由函数common.Image.getFrameCount 返回。

## ◆ setMKRotation()

void com.foxit.sdk.pdf.annots.Widget.setMKRotation | ( | int | rotation | ) | throws com.foxit.sdk.PDFException

设置 MK 字典中的旋转值。

MK 字典是一个外观特性字典，用于构建动态外观流， 指定注释在页面上的视觉呈现。 MK 字典中的旋转指定了小部件注释相对于页面逆时针旋转的度数。

参数

  [in] | rotation | 要在 MK 字典中设置的旋转值。请参考从 com.foxit.sdk.common.Constants.e_Rotation0 开始的值，这应该是这些值中的一个，除了 com.foxit.sdk.common.Constants.e_RotationUnknown 。特别地，这里的旋转值表示逆时针方向。