Foxit PDF SDK

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

## Public 成员函数
| XFAWidget (XFAWidget other)
| 构造函数，使用另一个 XFA 控件对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
Bitmap | getBitmap () throws com.foxit.sdk.PDFException
| 获取当前 XFA 控件的位图。 更多...
String | getDefaultValue () throws com.foxit.sdk.PDFException
| 获取默认值字符串。 更多...
int | getHAlign () throws com.foxit.sdk.PDFException
| 获取文本水平对齐方式。 更多...
int | getIndex () throws com.foxit.sdk.PDFException
| 获取 XFA 控件在相关 XFA 页面中的索引。 更多...
String | getJavaScript () throws com.foxit.sdk.PDFException
| 获取当前 XFA 控件验证的 JavaScript。 更多...
String | getName (int type) throws com.foxit.sdk.PDFException
| 获取控件名称。 更多...
WidgetChoiceOptionArray | getOptions () throws com.foxit.sdk.PDFException
| 获取选择列表或排斥组（仅用于单选按钮）的选项。 更多...
int | getPresence () throws com.foxit.sdk.PDFException
| 获取 XFA 控件的存在属性。 更多...
RectF | getRect () throws com.foxit.sdk.PDFException
| 获取 XFA 控件的矩形。 更多...
Signature | getSignature () throws com.foxit.sdk.PDFException
| 从当前 XFA 控件获取签名对象。 更多...
String | getToolTip () throws com.foxit.sdk.PDFException
| 获取工具提示字符串。 更多...
int | getType () throws com.foxit.sdk.PDFException
| 获取 XFA 控件的类型。 更多...
int | getVAlign () throws com.foxit.sdk.PDFException
| 获取文本垂直对齐方式。 更多...
String | getValue () throws com.foxit.sdk.PDFException
| 获取值字符串。 更多...
XFAPage | getXFAPage () throws com.foxit.sdk.PDFException
| 获取当前 XFA 控件所属的相关 XFA 页面。 更多...
String | getXMLContent () throws com.foxit.sdk.PDFException
| 获取当前 XFA 控件的 XML 内容。 更多...
boolean | hasEdge (int edge_pos) throws com.foxit.sdk.PDFException
| 检查指定位置的边框是否存在。 更多...
boolean | isAllowRichText () throws com.foxit.sdk.PDFException
| 检查控件是否允许富文本格式。 更多...
boolean | isChecked () throws com.foxit.sdk.PDFException
| 检查当前 XFA 控件是否已选中。 更多...
boolean | isEmpty ()
| 检查当前对象是否为空。 更多...
boolean | isListBox () throws com.foxit.sdk.PDFException
| 检查控件是否为列表框。 更多...
boolean | isReadOnly () throws com.foxit.sdk.PDFException
| 检查控件是否为只读。 更多...
boolean | isRequired () throws com.foxit.sdk.PDFException
| 检查控件在通过提交表单操作导出时是否需要值。 更多...
boolean | isSupportMultiline () throws com.foxit.sdk.PDFException
| 检查控件是否支持多行。 更多...
boolean | isSupportMultiSelect () throws com.foxit.sdk.PDFException
| 检查控件是否支持多选。 更多...
boolean | onChar (int input_char, int flags) throws com.foxit.sdk.PDFException
| 当输入字符代码时调用此函数。 更多...
int | onHitTest (PointF point) throws com.foxit.sdk.PDFException
| 调用此函数对指定点进行命中测试。 更多...
boolean | onKeyDown (int key_code, int flags) throws com.foxit.sdk.PDFException
| 当键盘按键按下时调用此函数。 更多...
boolean | onKeyUp (int key_code, int flags) throws com.foxit.sdk.PDFException
| 当键盘按键释放时调用此函数。 更多...
boolean | onLButtonDoubleClick (PointF point, int flags) throws com.foxit.sdk.PDFException
| 当鼠标左键双击时调用此函数。 更多...
boolean | onLButtonDown (PointF point, int flags) throws com.foxit.sdk.PDFException
| 当鼠标左键按下时调用此函数。 更多...
boolean | onLButtonUp (PointF point, int flags) throws com.foxit.sdk.PDFException
| 当鼠标左键释放时调用此函数。 更多...
boolean | onMouseEnter () throws com.foxit.sdk.PDFException
| 当鼠标进入当前 XFA 控件时调用此函数。 更多...
boolean | onMouseExit () throws com.foxit.sdk.PDFException
| 当鼠标退出时调用此函数。 更多...
boolean | onMouseMove (PointF point, int flags) throws com.foxit.sdk.PDFException
| 当鼠标移动时调用此函数。 更多...
boolean | onRButtonDown (PointF point, int flags) throws com.foxit.sdk.PDFException
| 当鼠标右键按下时调用此函数。 更多...
boolean | onRButtonUp (PointF point, int flags) throws com.foxit.sdk.PDFException
| 当鼠标右键释放时调用此函数。 更多...
void | resetData () throws com.foxit.sdk.PDFException
| 重置 XFA 控件数据。 更多...
void | setCheckState (boolean is_checked) throws com.foxit.sdk.PDFException
| 设置当前 XFA 控件的选中状态。 更多...
void | setDefaultValue (String value) throws com.foxit.sdk.PDFException
| 设置默认值字符串。 更多...
void | setImage (Image image) throws com.foxit.sdk.PDFException
| 为当前 XFA 控件设置图像。 更多...
boolean | setOptions (WidgetChoiceOptionArray option_array) throws com.foxit.sdk.PDFException
| 设置选择列表或排斥组（仅用于单选按钮）的选项。 更多...
void | setValue (String value) throws com.foxit.sdk.PDFException
| 设置值字符串。 更多...
boolean | validateValue (String value, String format) throws com.foxit.sdk.PDFException
| 验证值是否符合当前 XFA 控件的格式。 更多...

## 静态 Public 属性
static final int | e_HitTestAreaClient = 1
| 命中测试区域：客户端。
static final int | e_HitTestAreaHyperLink = 3
| 命中测试区域：超链接。
static final int | e_HitTestAreaTitleBar = 2
| 命中测试区域：标题栏。
static final int | e_HitTestAreaUnknown = 0
| 命中测试区域：未知。
static final int | e_PresenceHidden = 2
| 存在属性：隐藏。参与交互但不参与布局或渲染。
static final int | e_PresenceInactive = 3
| 存在属性：非活动。不参与交互、布局或渲染。
static final int | e_PresenceInvisible = 4
| 存在属性：不可见。参与交互和布局但不参与渲染。
static final int | e_PresenceUnknown = 0
| 存在属性：未知。
static final int | e_PresenceVisible = 1
| 存在属性：可见。参与交互、布局和渲染。
static final int | e_WidgetEdgePositionBottom = 2
| 边缘位置：底部。
static final int | e_WidgetEdgePositionLeft = 3
| 边缘位置：左侧。
static final int | e_WidgetEdgePositionRight = 1
| 边缘位置：右侧。
static final int | e_WidgetEdgePositionTop = 0
| 边缘位置：顶部。
static final int | e_WidgethAlignTypeCenter = 128
| 在可用区域内水平居中文本。
static final int | e_WidgethAlignTypeJustify = 156
| 左对齐最后一行并分散对齐其余行。
static final int | e_WidgethAlignTypeLeft = 252
| 分散对齐所有行以填充可用区域。 更多...
static final int | e_WidgethAlignTypeRadix = 231
| 对齐基数指示符。
static final int | e_WidgethAlignTypeRight = 54
| 将文本对齐到可用区域的右边缘。
static final int | e_WidgetNameTypeCaption = 1
| 名称类型：标题名称。此类型的名称将从标题条目中检索。
static final int | e_WidgetNameTypeField = 0
| 名称类型：字段名称。此类型的名称将从 XFA 控件的名称条目中检索，可能是空字符串。
static final int | e_WidgetNameTypeFullName = 2
| 名称类型：全名。
static final int | e_WidgetTypeArc = 3
| XFA 控件类型：弧形。
static final int | e_WidgetTypeBarcode = 0
| XFA 控件类型：条形码。
static final int | e_WidgetTypeCheckButton = 2
| XFA 控件类型：复选框。
static final int | e_WidgetTypeChoiceList = 7
| XFA 控件类型：选择列表。
static final int | e_WidgetTypeDateTimeEdit = 4
| XFA 控件类型：日期时间编辑。
static final int | e_WidgetTypeExclGroup = 15
| XFA 控件类型：单选按钮的排斥组。
static final int | e_WidgetTypeImage = 16
| XFA 控件类型：图像。
static final int | e_WidgetTypeImageEdit = 8
| XFA 控件类型：图像编辑。
static final int | e_WidgetTypeLine = 9
| XFA 控件类型：线条。
static final int | e_WidgetTypeNumericEdit = 5
| XFA 控件类型：数字编辑。
static final int | e_WidgetTypePasswordEdit = 10
| XFA 控件类型：密码编辑。
static final int | e_WidgetTypePushButton = 1
| XFA 控件类型：按钮。
static final int | e_WidgetTypeRadioButton = 11
| XFA 控件类型：单选按钮。
static final int | e_WidgetTypeRectangle = 12
| XFA 控件类型：矩形。
static final int | e_WidgetTypeSignature = 6
| XFA 控件类型：签名。
static final int | e_WidgetTypeTextEdit = 13
| XFA 控件类型：文本编辑。
static final int | e_WidgetTypeUnknown = 14
| XFA 控件类型：未知。
static final int | e_WidgetvAlignTypeBottom = 85
| 将文本对齐到可用区域的底部。
static final int | e_WidgetvAlignTypeMiddle = 161
| 将文本对齐，使其在可用区域的顶部和底部之间居中。
static final int | e_WidgetvAlignTypeTop = 33
| 将文本对齐到可用区域的顶部。

## 详细描述

类 XFAWidget 表示从 XFA 页面对象中检索的 XFA 控件。
要访问 XFA 控件的菜单，请使用 XFAWidget 对象构造一个 com.foxit.sdk.addon.xfa.WidgetMenu 对象。

参见
  WidgetMenu

## 构造及析构函数说明

## ◆ XFAWidget()

com.foxit.sdk.addon.xfa.XFAWidget.XFAWidget | ( | XFAWidget | other | ) |

构造函数，使用另一个 XFA 控件对象。

参数

  [in] | other | 另一个 XFA 控件对象。

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.addon.xfa.XFAWidget.delete | ( |  | ) |

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

返回
  无。

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

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

## ◆ getBitmap()

Bitmap com.foxit.sdk.addon.xfa.XFAWidget.getBitmap | ( |  | ) | throws com.foxit.sdk.PDFException

获取当前 XFA 控件的位图。

仅适用于当前 XFA 控件类型为 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeImageEdit 或 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeImage 的情况。对于不适用的类型，此函数将 抛出异常 com.foxit.sdk.common.Constants.e_ErrUnsupported 。

返回
  当前 XFA 控件的位图。

## ◆ getDefaultValue()

String com.foxit.sdk.addon.xfa.XFAWidget.getDefaultValue | ( |  | ) | throws com.foxit.sdk.PDFException

获取默认值字符串。

返回
  默认值字符串。

## ◆ getHAlign()

int com.foxit.sdk.addon.xfa.XFAWidget.getHAlign | ( |  | ) | throws com.foxit.sdk.PDFException

获取文本水平对齐方式。

返回
  文本水平对齐方式。请参考从 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgethAlignTypeLeft 开始的值， 这将是这些值中的一个。

## ◆ getIndex()

int com.foxit.sdk.addon.xfa.XFAWidget.getIndex | ( |  | ) | throws com.foxit.sdk.PDFException

获取 XFA 控件在相关 XFA 页面中的索引。

返回
  XFA 控件在相关 XFA 页面中的索引。

## ◆ getJavaScript()

String com.foxit.sdk.addon.xfa.XFAWidget.getJavaScript | ( |  | ) | throws com.foxit.sdk.PDFException

获取当前 XFA 控件验证的 JavaScript。

返回
  当前 XFA 控件验证的 JavaScript。

## ◆ getName()

String com.foxit.sdk.addon.xfa.XFAWidget.getName | ( | int | type | ) | throws com.foxit.sdk.PDFException

获取控件名称。

参数

  [in] | type | 名称类型。请参考从 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetNameTypeField 开始的值， 这应该是这些值之一。

返回
  控件名称字符串。

## ◆ getOptions()

WidgetChoiceOptionArray com.foxit.sdk.addon.xfa.XFAWidget.getOptions | ( |  | ) | throws com.foxit.sdk.PDFException

获取选择列表或排斥组（仅用于单选按钮）的选项。

适用于选择列表和排斥组（仅用于单选按钮）。 对于不适用的类型，此函数将返回空数组。

返回
  选择选项数组。

## ◆ getPresence()

int com.foxit.sdk.addon.xfa.XFAWidget.getPresence | ( |  | ) | throws com.foxit.sdk.PDFException

获取 XFA 控件的存在属性。

存在属性控制关联对象在不同处理阶段的参与。

返回
  XFA 控件的存在属性。

## ◆ getRect()

RectF com.foxit.sdk.addon.xfa.XFAWidget.getRect | ( |  | ) | throws com.foxit.sdk.PDFException

获取 XFA 控件的矩形。

控件矩形在 XFA 坐标系中定义。XFA 坐标系定义为原点在左上角， x 轴指向右，y 轴指向下。

返回
  XFA 控件的矩形。

## ◆ getSignature()

Signature com.foxit.sdk.addon.xfa.XFAWidget.getSignature | ( |  | ) | throws com.foxit.sdk.PDFException

从当前 XFA 控件获取签名对象。

仅适用于当前 XFA 控件表示签名的情况。 对于不适用的类型，此函数将抛出异常 com.foxit.sdk.common.Constants.e_ErrUnsupported 。

返回
  签名对象。

## ◆ getToolTip()

String com.foxit.sdk.addon.xfa.XFAWidget.getToolTip | ( |  | ) | throws com.foxit.sdk.PDFException

获取工具提示字符串。

返回
  工具提示字符串。

## ◆ getType()

int com.foxit.sdk.addon.xfa.XFAWidget.getType | ( |  | ) | throws com.foxit.sdk.PDFException

获取 XFA 控件的类型。

返回
  XFA 控件类型。请参考从 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeBarcode 开始的值， 这将是这些值中的一个。

## ◆ getVAlign()

int com.foxit.sdk.addon.xfa.XFAWidget.getVAlign | ( |  | ) | throws com.foxit.sdk.PDFException

获取文本垂直对齐方式。

返回
  文本垂直对齐方式。请参考从 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetvAlignTypeTop 开始的值， 这将是这些值中的一个。

## ◆ getValue()

String com.foxit.sdk.addon.xfa.XFAWidget.getValue | ( |  | ) | throws com.foxit.sdk.PDFException

获取值字符串。

返回
  值字符串。

## ◆ getXFAPage()

XFAPage com.foxit.sdk.addon.xfa.XFAWidget.getXFAPage | ( |  | ) | throws com.foxit.sdk.PDFException

获取当前 XFA 控件所属的相关 XFA 页面。

返回
  XFA 页面对象。

## ◆ getXMLContent()

String com.foxit.sdk.addon.xfa.XFAWidget.getXMLContent | ( |  | ) | throws com.foxit.sdk.PDFException

获取当前 XFA 控件的 XML 内容。

返回
  当前 XFA 控件的 XML 内容。

## ◆ hasEdge()

boolean com.foxit.sdk.addon.xfa.XFAWidget.hasEdge | ( | int | edge_pos | ) | throws com.foxit.sdk.PDFException

检查指定位置的边框是否存在。

参数

  [in] | edge_pos | 边框位置，用于指定将检查哪个边框。请参考从 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetEdgePositionTop 开始的值，这应该是这些值中的一个。

返回
  true 表示指定位置的边框存在，false 表示不存在此类边框。

## ◆ isAllowRichText()

boolean com.foxit.sdk.addon.xfa.XFAWidget.isAllowRichText | ( |  | ) | throws com.foxit.sdk.PDFException

检查控件是否允许富文本格式。

只有类型为 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeTextEdit 的文本编辑控件支持富文本。

返回
  true 表示控件允许富文本格式，false 表示不允许。

## ◆ isChecked()

boolean com.foxit.sdk.addon.xfa.XFAWidget.isChecked | ( |  | ) | throws com.foxit.sdk.PDFException

检查当前 XFA 控件是否已选中。

适用于复选框或单选按钮作为相关 XFA 控件。 对于不适用的类型，此函数将返回 false。

返回
  true 表示已选中，false 表示未选中或失败。

## ◆ isEmpty()

boolean com.foxit.sdk.addon.xfa.XFAWidget.isEmpty | ( |  | ) |

检查当前对象是否为空。

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

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

## ◆ isListBox()

boolean com.foxit.sdk.addon.xfa.XFAWidget.isListBox | ( |  | ) | throws com.foxit.sdk.PDFException

检查控件是否为列表框。

返回
  true 表示控件是列表框，false 表示不是。

## ◆ isReadOnly()

boolean com.foxit.sdk.addon.xfa.XFAWidget.isReadOnly | ( |  | ) | throws com.foxit.sdk.PDFException

检查控件是否为只读。

返回
  true 表示字段的值不能更改，false 表示可以更改。

## ◆ isRequired()

boolean com.foxit.sdk.addon.xfa.XFAWidget.isRequired | ( |  | ) | throws com.foxit.sdk.PDFException

检查控件在通过提交表单操作导出时是否需要值。

返回
  true 表示字段在通过提交表单操作导出时必须有值， false 表示不需要。

## ◆ isSupportMultiline()

boolean com.foxit.sdk.addon.xfa.XFAWidget.isSupportMultiline | ( |  | ) | throws com.foxit.sdk.PDFException

检查控件是否支持多行。

只有类型为 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeTextEdit 的文本编辑控件支持多行。

返回
  true 表示控件支持多行，false 表示不支持。

## ◆ isSupportMultiSelect()

boolean com.foxit.sdk.addon.xfa.XFAWidget.isSupportMultiSelect | ( |  | ) | throws com.foxit.sdk.PDFException

检查控件是否支持多选。

只有列表框控件支持多选，其类型为 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeChoiceList 且 函数 xfa.XFAWidget.isListBox 的返回值为 true。

返回
  true 表示控件支持多选，false 表示不支持。

## ◆ onChar()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onChar | ( | int | input_char,
|  | int | flags
| ) |  | throws com.foxit.sdk.PDFException

当输入字符代码时调用此函数。

参数

  [in] | input_char | 字符代码，使用 UTF16-LE 编码。
  [in] | flags | 事件标志。请参考从 com.foxit.sdk.pdf.interform.Filler.e_EventFlagShiftKey 开始的值， 这应该是这些值中的一个或组合。

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

## ◆ onHitTest()

int com.foxit.sdk.addon.xfa.XFAWidget.onHitTest | ( | PointF | point | ) | throws com.foxit.sdk.PDFException

调用此函数对指定点进行命中测试。

参数

  [in] | point | 要测试的点。

返回
  命中测试区域。请参考从 com.foxit.sdk.addon.xfa.XFAWidget.e_HitTestAreaUnknown 开始的值， 这将是这些值中的一个。

## ◆ onKeyDown()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onKeyDown | ( | int | key_code,
|  | int | flags
| ) |  | throws com.foxit.sdk.PDFException

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

参数

  [in] | key_code | 键码。请参考从 com.foxit.sdk.pdf.interform.Filler.e_VkeyUnknown 开始的值， 这应该是这些值中的一个。
  [in] | flags | 事件标志。请参考从 com.foxit.sdk.pdf.interform.Filler.e_EventFlagShiftKey 开始的值， 这应该是这些值中的一个或组合。

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

## ◆ onKeyUp()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onKeyUp | ( | int | key_code,
|  | int | flags
| ) |  | throws com.foxit.sdk.PDFException

当键盘按键释放时调用此函数。

参数

  [in] | key_code | 键码。请参考从 com.foxit.sdk.pdf.interform.Filler.e_VkeyUnknown 开始的值， 这应该是这些值中的一个。
  [in] | flags | 事件标志。请参考从 com.foxit.sdk.pdf.interform.Filler.e_EventFlagShiftKey 开始的值， 这应该是这些值中的一个或组合。

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

## ◆ onLButtonDoubleClick()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onLButtonDoubleClick | ( | PointF | point,
|  | int | flags
| ) |  | throws com.foxit.sdk.PDFException

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

参数

  [in] | point | 鼠标左键在 XFA 页面中双击的点，使用 PDF 坐标系统。
  [in] | flags | 事件标志。请参考从 com.foxit.sdk.pdf.interform.Filler.e_EventFlagShiftKey 开始的值， 这应该是这些值中的一个或组合。

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

## ◆ onLButtonDown()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onLButtonDown | ( | PointF | point,
|  | int | flags
| ) |  | throws com.foxit.sdk.PDFException

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

参数

  [in] | point | 鼠标左键在 XFA 页面中按下的点，使用 PDF 坐标系统。
  [in] | flags | 事件标志。请参考从 com.foxit.sdk.pdf.interform.Filler.e_EventFlagShiftKey 开始的值， 这应该是这些值中的一个或组合。

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

## ◆ onLButtonUp()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onLButtonUp | ( | PointF | point,
|  | int | flags
| ) |  | throws com.foxit.sdk.PDFException

当鼠标左键释放时调用此函数。

参数

  [in] | point | 鼠标左键在 XFA 页面中释放的点，使用 PDF 坐标系统。
  [in] | flags | 事件标志。请参考从 com.foxit.sdk.pdf.interform.Filler.e_EventFlagShiftKey 开始的值， 这应该是这些值中的一个或组合。

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

## ◆ onMouseEnter()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onMouseEnter | ( |  | ) | throws com.foxit.sdk.PDFException

当鼠标进入当前 XFA 控件时调用此函数。

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

## ◆ onMouseExit()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onMouseExit | ( |  | ) | throws com.foxit.sdk.PDFException

当鼠标退出时调用此函数。

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

## ◆ onMouseMove()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onMouseMove | ( | PointF | point,
|  | int | flags
| ) |  | throws com.foxit.sdk.PDFException

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

参数

  [in] | point | 鼠标在 XFA 页面中移动的点，使用 PDF 坐标系统。
  [in] | flags | 事件标志。请参考从 com.foxit.sdk.pdf.interform.Filler.e_EventFlagShiftKey 开始的值， 这应该是这些值中的一个或组合。

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

## ◆ onRButtonDown()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onRButtonDown | ( | PointF | point,
|  | int | flags
| ) |  | throws com.foxit.sdk.PDFException

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

参数

  [in] | point | 鼠标右键在 XFA 页面中按下的点，使用 PDF 坐标系统。
  [in] | flags | 事件标志。请参考从 com.foxit.sdk.pdf.interform.Filler.e_EventFlagShiftKey 开始的值， 这应该是这些值中的一个或组合。

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

## ◆ onRButtonUp()

boolean com.foxit.sdk.addon.xfa.XFAWidget.onRButtonUp | ( | PointF | point,
|  | int | flags
| ) |  | throws com.foxit.sdk.PDFException

当鼠标右键释放时调用此函数。

参数

  [in] | point | 鼠标右键在 XFA 页面中释放的点，使用 PDF 坐标系统。
  [in] | flags | 事件标志。请参考从 com.foxit.sdk.pdf.interform.Filler.e_EventFlagShiftKey 开始的值， 这应该是这些值中的一个或组合。

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

## ◆ resetData()

void com.foxit.sdk.addon.xfa.XFAWidget.resetData | ( |  | ) | throws com.foxit.sdk.PDFException

重置 XFA 控件数据。

返回
  无。

## ◆ setCheckState()

void com.foxit.sdk.addon.xfa.XFAWidget.setCheckState | ( | boolean | is_checked | ) | throws com.foxit.sdk.PDFException

设置当前 XFA 控件的选中状态。

适用于复选框或单选按钮作为相关 XFA 控件。 对于不适用的类型，此函数将抛出异常 com.foxit.sdk.common.Constants.e_ErrUnsupported 。

参数

  [in] | is_checked | true 表示当前 XFA 控件将被选中， false 表示不会被选中。

返回
  无。

## ◆ setDefaultValue()

void com.foxit.sdk.addon.xfa.XFAWidget.setDefaultValue | ( | String | value | ) | throws com.foxit.sdk.PDFException

设置默认值字符串。

仅对类型为 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeTextEdit 、com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeNumericEdit 、 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypePasswordEdit 或 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeDateTimeEdit 的 XFA 控件有用。

参数

  [in] | value | 要设置的默认值字符串。可以是空字符串。

返回
  无。

## ◆ setImage()

void com.foxit.sdk.addon.xfa.XFAWidget.setImage | ( | Image | image | ) | throws com.foxit.sdk.PDFException

为当前 XFA 控件设置图像。

仅适用于当前 XFA 控件类型为 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeImageEdit 的情况。 对于不适用的类型，此函数将抛出异常 com.foxit.sdk.common.Constants.e_ErrUnsupported 。

参数

  [in] | image | 将设置到当前 XFA 控件的图像。 目前，此函数仅支持以下图像类型： com.foxit.sdk.common.Image.e_BMP com.foxit.sdk.common.Image.e_PNG com.foxit.sdk.common.Image.e_JPG com.foxit.sdk.common.Image.e_GIF com.foxit.sdk.common.Image.e_TIF 如果尝试设置其他不支持的图像类型，将抛出异常 com.foxit.sdk.common.Constants.e_ErrUnsupported 。

返回
  无。

## ◆ setOptions()

boolean com.foxit.sdk.addon.xfa.XFAWidget.setOptions | ( | WidgetChoiceOptionArray | option_array | ) | throws com.foxit.sdk.PDFException

设置选择列表或排斥组（仅用于单选按钮）的选项。

适用于选择列表和排斥组（仅用于单选按钮）。 对于不适用的类型，此函数将返回 false。

参数

  [in] | option_array | 要设置的选择选项数组。

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

## ◆ setValue()

void com.foxit.sdk.addon.xfa.XFAWidget.setValue | ( | String | value | ) | throws com.foxit.sdk.PDFException

设置值字符串。

仅对类型为 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeTextEdit 、com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeNumericEdit 、 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypePasswordEdit 或 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetTypeDateTimeEdit 的 XFA 控件有用。

参数

  [in] | value | 要设置的值字符串。可以是空字符串。

返回
  无。

## ◆ validateValue()

boolean com.foxit.sdk.addon.xfa.XFAWidget.validateValue | ( | String | value,
|  | String | format
| ) |  | throws com.foxit.sdk.PDFException

验证值是否符合当前 XFA 控件的格式。

此函数可以在函数 XFAWidget.setValue 之前调用，以检查 值是否符合当前 XFA 控件的格式。

参数

  [in] | value | 要验证的字符串值。
  [out] | format | 接收当前 XFA 控件格式的字符串值。如果当前 XFA 控件没有格式， 它将是空字符串。

返回
  true 表示值符合当前 XFA 控件的格式，false 表示不符合。

## 类成员变量说明

## ◆ e_WidgethAlignTypeLeft

final int com.foxit.sdk.addon.xfa.XFAWidget.e_WidgethAlignTypeLeft = 252
| static

分散对齐所有行以填充可用区域。

将文本对齐到可用区域的左边缘。