Foxit PDF SDK
com.foxit.sdk.addon.xfa.DocProviderCallback类 参考

Public 成员函数

void displayCaret (int page_index, boolean is_visible, RectF rect)
 用于显示或隐藏光标的回调函数。 更多...
 
void exportData (XFADoc doc, String file_path)
 用于将数据导出到文件的回调函数。 更多...
 
int getCurrentPage (XFADoc doc)
 用于获取当前页面索引的回调函数。 更多...
 
long getHighlightColor (XFADoc doc)
 用于获取高亮颜色的回调函数。 更多...
 
boolean getPopupPos (int page_index, float min_popup, float max_popup, RectF rect_widget, RectF inout_rect_popup)
 用于获取弹出位置的回调函数。 更多...
 
String getTitle (XFADoc doc)
 用于获取当前 XFA 文档标题的回调函数。 更多...
 
void gotoURL (XFADoc doc, String url)
 用于转到指定 URL 的回调函数。 更多...
 
void importData (XFADoc doc, String file_path)
 用于从文件导入数据的回调函数。 更多...
 
void invalidateRect (int page_index, RectF rect, int flag)
 用于根据标志无效化矩形的回调函数。 更多...
 
void notifyWidgetChangeInfo (XFADoc doc, XFAWidgetModifyInfo change_info)
 用于通知XFA 控件值的变化的回调函数。 更多...
 
void pageViewEvent (int page_index, int page_view_event_type)
 用于执行页面视图事件的回调函数。 更多...
 
boolean popupMenu (int page_index, PointF rect_popup)
 用于弹出上下文菜单的回调函数。 更多...
 
void print (XFADoc doc, int start_page_index, int end_page_index, int options)
 用于打印的回调函数。 更多...
 
void release ()
 用于释放当前回调对象本身的回调函数。 更多...
 
void setChangeMark (XFADoc doc)
 用于为当前 XFA 文档设置更改标记标志的回调函数。 更多...
 
void setCurrentPage (XFADoc doc, int current_page_index)
 用于设置当前页面索引的回调函数。 更多...
 
void setFocus (XFAWidget xfa_widget, boolean is_relayout)
 用于设置焦点控件的回调函数。 更多...
 
boolean submitData (XFADoc doc, String target, int format, int text_encoding, String content)
 用于提交数据的回调函数。 更多...
 
void widgetEvent (XFAWidget xfa_widget, int widget_event_type)
 用于执行 XFA 控件事件的回调函数。 更多...
 

静态 Public 属性

static final int e_InvalidateFlagAllPages = 0
 无效化所有页面。
 
static final int e_InvalidateFlagCurrentPage = 1
 无效化当前页面。
 
static final int e_PageViewEventTypeAdded = 0
 事件类型:页面视图添加后。
 
static final int e_PageViewEventTypeAllRemoved = 2
 事件类型:所有页面视图被移除。
 
static final int e_PageViewEventTypeRemoved = 1
 事件类型:页面视图移除后。
 
static final int e_PrintOptionAsImage = 0x00000008
 如果设置,以图像方式打印页面;否则,以文本方式打印。
 
static final int e_PrintOptionCanCancel = 0x00000002
 如果设置,表示打印过程可以取消。
 
static final int e_PrintOptionPrintAnnot = 0x00000020
 如果设置,打印注释。
 
static final int e_PrintOptionShowDialog = 0x00000001
 如果设置,显示打印对话框。
 
static final int e_PrintOptionShrinkPage = 0x00000004
 如果设置,缩小页面以适应内容区域。
 
static final int e_SubmitInPDF = 1
 提交数据按 PDF 格式打包,如 PDF 参考中所述。
 
static final int e_SubmitInUrlEncoded = 2
 提交数据按 URL 编码格式打包,如统一资源定位符 (URL) 中所述。
 
static final int e_SubmitInXDP = 0
 提交数据按 XDP 格式打包,如 XDP 规范中所述。
 
static final int e_SubmitInXFD = 3
 提交数据按 XFD 格式打包,如 XFDF 中所述。
 
static final int e_SubmitInXML = 4
 提交数据被翻译并打包为 URL 编码格式。
 
static final int e_TextEncodingBig5 = 1
 文本编码:Big5。
 
static final int e_TextEncodingFontSpecific = 2
 文本编码:字体特定。
 
static final int e_TextEncodingGB18030 = 4
 文本编码:GB18030。
 
static final int e_TextEncodingGB2312 = 5
 文本编码:GB2312。
 
static final int e_TextEncodingGBK = 3
 文本编码:GBK。
 
static final int e_TextEncodingISO8859NN = 6
 文本编码:ISO8859NN。
 
static final int e_TextEncodingKSC5601 = 7
 文本编码:KSC5601。
 
static final int e_TextEncodingNone = 0
 无文本编码。
 
static final int e_TextEncodingShiftJIS = 8
 文本编码:ShiftJIS。
 
static final int e_TextEncodingUCS2 = 9
 文本编码:UCS-2。
 
static final int e_TextEncodingUTF16 = 10
 文本编码:UTF-16。
 
static final int e_TextEncodingUTF8 = 11
 文本编码:UTF-8。
 
static final int e_WidgetEventTypeAdded = 0
 事件类型:XFA 控件添加后。
 
static final int e_WidgetEventTypeBeforeRemoved = 1
 事件类型:XFA 控件移除前。
 

详细描述

此类表示作为 XFA 文档提供程序的回调对象。 此类中的所有函数都用作回调函数。纯虚函数应由用户实现。

成员函数说明

◆ displayCaret()

void com.foxit.sdk.addon.xfa.DocProviderCallback.displayCaret ( int  page_index,
boolean  is_visible,
RectF  rect 
)

用于显示或隐藏光标的回调函数。

参数
[in]page_index页面的索引。
[in]is_visible用于决定光标是否可见:true 表示可见, false 表示不可见。
[in]rect矩形。
返回
无。

◆ exportData()

void com.foxit.sdk.addon.xfa.DocProviderCallback.exportData ( XFADoc  doc,
String  file_path 
)

用于将数据导出到文件的回调函数。

参数
[in]doc当前 XFA 文档。
[in]file_path数据应导出到的文件路径。 如果这是空字符串,用户应指定一个路径作为导出文件路径。 在这种情况下,应用程序可以显示对话框让用户手动选择文件。
返回
无。

◆ getCurrentPage()

int com.foxit.sdk.addon.xfa.DocProviderCallback.getCurrentPage ( XFADoc  doc)

用于获取当前页面索引的回调函数。

参数
[in]doc当前 XFA 文档。
返回
当前页面的索引。

◆ getHighlightColor()

long com.foxit.sdk.addon.xfa.DocProviderCallback.getHighlightColor ( XFADoc  doc)

用于获取高亮颜色的回调函数。

参数
[in]doc当前 XFA 文档。
返回
高亮颜色。

◆ getPopupPos()

boolean com.foxit.sdk.addon.xfa.DocProviderCallback.getPopupPos ( int  page_index,
float  min_popup,
float  max_popup,
RectF  rect_widget,
RectF  inout_rect_popup 
)

用于获取弹出位置的回调函数。

参数
[in]page_index页面的索引。
[in]min_popup下拉框的最小高度。
[in]max_popup下拉框的最大高度。
[in]rect_widget当前控件的矩形。
[in,out]inout_rect_popup矩形。当调用此函数时,这用作输入参数, 指定下拉框的宽度。 当此函数返回时,这用作输出参数,接收 下拉框的高度。
返回
true 表示成功,false 表示失败。

◆ getTitle()

String com.foxit.sdk.addon.xfa.DocProviderCallback.getTitle ( XFADoc  doc)

用于获取当前 XFA 文档标题的回调函数。

参数
[in]doc当前 XFA 文档。
返回
标题。

◆ gotoURL()

void com.foxit.sdk.addon.xfa.DocProviderCallback.gotoURL ( XFADoc  doc,
String  url 
)

用于转到指定 URL 的回调函数。

参数
[in]doc当前 XFA 文档。
[in]urlURL 字符串。
返回
无。

◆ importData()

void com.foxit.sdk.addon.xfa.DocProviderCallback.importData ( XFADoc  doc,
String  file_path 
)

用于从文件导入数据的回调函数。

参数
[in]doc当前 XFA 文档。
[in]file_path数据将从中导入的文件路径。 如果这是空字符串,用户应指定一个路径作为导入文件路径。 在这种情况下,应用程序可以显示对话框让用户手动选择文件。
返回
无。

◆ invalidateRect()

void com.foxit.sdk.addon.xfa.DocProviderCallback.invalidateRect ( int  page_index,
RectF  rect,
int  flag 
)

用于根据标志无效化矩形的回调函数。

此回调函数将在动态 XFA 文档中使用。

参数
[in]page_index页面的索引。
[in]rect要无效化的矩形。
[in]flag无效化标志。请参考从 com.foxit.sdk.addon.xfa.DocProviderCallback.e_InvalidateFlagAllPages 开始的值,这将是这些值之一。
返回
无。

◆ notifyWidgetChangeInfo()

void com.foxit.sdk.addon.xfa.DocProviderCallback.notifyWidgetChangeInfo ( XFADoc  doc,
XFAWidgetModifyInfo  change_info 
)

用于通知XFA 控件值的变化的回调函数。

参数
[in]doc当前的XFA文档。
[in]change_infoXFA控件信息改变。
返回
无。

◆ pageViewEvent()

void com.foxit.sdk.addon.xfa.DocProviderCallback.pageViewEvent ( int  page_index,
int  page_view_event_type 
)

用于执行页面视图事件的回调函数。

参数
[in]page_index页面索引。
[in]page_view_event_type页面视图事件类型。请参考从 com.foxit.sdk.addon.xfa.DocProviderCallback.e_PageViewEventTypeAdded 开始的值,这将是 这些值之一。
返回
无。

◆ popupMenu()

boolean com.foxit.sdk.addon.xfa.DocProviderCallback.popupMenu ( int  page_index,
PointF  rect_popup 
)

用于弹出上下文菜单的回调函数。

参数
[in]page_index页面的索引。
[in]rect_popup弹出菜单的矩形位置。
返回
true 表示成功,否则表示失败。

◆ print()

void com.foxit.sdk.addon.xfa.DocProviderCallback.print ( XFADoc  doc,
int  start_page_index,
int  end_page_index,
int  options 
)

用于打印的回调函数。

参数
[in]doc当前 XFA 文档。
[in]start_page_index起始页面的索引。
[in]end_page_index结束页面的索引。
[in]options打印选项。请参考从 com.foxit.sdk.addon.xfa.DocProviderCallback.e_PrintOptionShowDialog 开始的值,这将是这些值之一或这些值的组合。
返回
无。

◆ release()

void com.foxit.sdk.addon.xfa.DocProviderCallback.release ( )

用于释放当前回调对象本身的回调函数。

返回
无。

◆ setChangeMark()

void com.foxit.sdk.addon.xfa.DocProviderCallback.setChangeMark ( XFADoc  doc)

用于为当前 XFA 文档设置更改标记标志的回调函数。

参数
[in]doc当前 XFA 文档。
返回
无。

◆ setCurrentPage()

void com.foxit.sdk.addon.xfa.DocProviderCallback.setCurrentPage ( XFADoc  doc,
int  current_page_index 
)

用于设置当前页面索引的回调函数。

参数
[in]doc当前 XFA 文档。
[in]current_page_index要设置的索引。
返回
无。

◆ setFocus()

void com.foxit.sdk.addon.xfa.DocProviderCallback.setFocus ( XFAWidget  xfa_widget,
boolean  is_relayout 
)

用于设置焦点控件的回调函数。

参数
[in]xfa_widget要设置焦点的 XFA 控件。
[in]is_relayouttrue 表示布局已更改, false 表示布局未更改。
返回
无。

◆ submitData()

boolean com.foxit.sdk.addon.xfa.DocProviderCallback.submitData ( XFADoc  doc,
String  target,
int  format,
int  text_encoding,
String  content 
)

用于提交数据的回调函数。

参数
[in]doc当前 XFA 文档。
[in]target表示要提交数据的目标的字符串。
[in]format要提交数据的格式。请参考从 com.foxit.sdk.addon.xfa.DocProviderCallback.e_SubmitInXDP 开始的值,这将是这些值之一。
[in]text_encoding要提交数据的文本编码。请参考从 com.foxit.sdk.addon.xfa.DocProviderCallback.e_TextEncodingNone 开始的值,这将是这些值之一。
[in]content要提交数据的内容。
返回
true 表示成功,否则表示失败。

◆ widgetEvent()

void com.foxit.sdk.addon.xfa.DocProviderCallback.widgetEvent ( XFAWidget  xfa_widget,
int  widget_event_type 
)

用于执行 XFA 控件事件的回调函数。

参数
[in]xfa_widget发送事件的 XFA 控件。
[in]widget_event_type控件事件类型。请参考从 com.foxit.sdk.addon.xfa.DocProviderCallback.e_WidgetEventTypeAdded 开始的值, 这将是这些值之一。
返回
无。