|
Foxit PDF SDK
|
Public 成员函数 | |
| boolean | addMenuItem (MenuItemConfig menu_item_config, boolean is_prepend) |
| 向菜单添加菜单项的回调函数。 更多... | |
| SearchIndexConfig | addSearchIndex (String di_path, boolean is_selected) |
| 添加搜索索引的回调函数。 更多... | |
| boolean | addSubMenu (MenuItemConfig menu_item_config) |
| 向应用程序添加带有子菜单的菜单项的回调函数。 更多... | |
| boolean | addToolButton (ButtonItem button_item) |
| 添加工具按钮的回调函数。 更多... | |
| int | alert (String msg, String title, int type, int icon) |
| 弹出对话框显示警告或提示的回调函数。 更多... | |
| boolean | beep (int type) |
| 使系统播放声音的回调函数。 更多... | |
| String | browseFile () |
| 显示文件选择对话框的回调函数,选择的文件路径应该被返回。 更多... | |
| String | browseFile (boolean is_open_dialog, String file_format, String file_filter) |
| 显示文件选择对话框的回调函数。 更多... | |
| void | closeDoc (PDFDoc document, boolean is_prompt_to_save) |
| 关闭文档的回调函数。 更多... | |
| PDFDoc | createBlankDoc () |
| 创建空白PDF文档对象的回调函数。 更多... | |
| void | enablePageLoop (boolean is_loop) |
| 设置标志的回调函数,该标志指定在全屏模式下,文档是否会循环回到文档开头以响应页面前进(无论是由鼠标点击、键盘还是计时器生成)。 更多... | |
| boolean | executeNamedAction (PDFDoc document, String named_action) |
| 执行命名操作的回调函数。 更多... | |
| String | getAppInfo (int type) |
| 获取应用程序信息的回调函数。 更多... | |
| String | getAttachmentsFilePath (PDFDoc pdf_doc, String name) |
| 获取附件文件路径的回调函数。 更多... | |
| PDFDoc | getCurrentDoc () |
| 接收当前PDF文档对象的回调函数。 更多... | |
| int | getCurrentPage (PDFDoc document) |
| 用于接收当前页面索引的回调函数。 更多... | |
| boolean | getDocChangeMark (PDFDoc document) |
| 接收更改标记的回调函数,该标记指示文档内容是否已更改。 更多... | |
| String | getExtractedEmbeddedFilePath (PDFDoc pdf_doc, String name) |
| 获取提取的嵌入文件路径的回调函数。 更多... | |
| String | getFilePath (PDFDoc document) |
| 获取当前PDF文档文件路径的回调函数。 更多... | |
| boolean | getFullScreen () |
| 获取是否设置了全屏模式的回调函数。 更多... | |
| IdentityProperties | getIdentityProperties () |
| 获取当前用户身份属性的回调函数。 更多... | |
| int | getLanguage () |
| 获取正在运行的查看器应用程序语言的回调函数。 更多... | |
| int | getLayoutMode () |
| 获取当前文档页面布局的回调函数。 更多... | |
| MenuListArray | getMenuItemNameList () |
| 获取菜单项名称列表的回调函数。 更多... | |
| PointF | getMousePosition () |
| 获取当前鼠标位置的回调函数。 更多... | |
| PDFDoc | getOpenedDoc (int index) |
| 通过索引接收已打开PDF文档对象的回调函数。 更多... | |
| int | getOpenedDocCount () |
| 接收已打开文档数量的回调函数。 更多... | |
| int | getPageRotation (PDFDoc document, int page_index) |
| 用于接收PDF查看器中页面当前显示旋转值的回调函数。 更多... | |
| float | getPageScale () |
| 获取当前页面缩放值的回调函数。 更多... | |
| int | getPageZoomMode () |
| 获取当前页面缩放模式的回调函数。 更多... | |
| WStringArray | getPrinterNameList () |
| 获取打印机名称列表的回调函数。 更多... | |
| WStringArray | getSignatureAPStyleNameList () |
| 获取签名外观样式名称列表的回调函数。 更多... | |
| String | getTemporaryDirectory () |
| 获取临时目录的回调函数。 更多... | |
| String | getTemporaryFileName (PDFDoc document, String file_suffix_name) |
| 获取临时文件路径的回调函数。临时文件名将文档名与文件后缀名组合。 更多... | |
| String | getUntitledBookmarkName () |
| 获取无标题书签新名称的回调函数。 更多... | |
| int | getVisiblePage (PDFDoc document, int index) |
| 获取可见页的回调。 更多... | |
| int | getVisiblePageCount (PDFDoc document) |
| 获取可见页页数的回调。 更多... | |
| boolean | initModifyItem (PDFDoc document, int item_type, int page_index, String dict_name) |
| 初始化修改项的回调。 更多... | |
| boolean | invalidateRect (PDFDoc document, int page_index, RectF pdf_rect) |
| 使指定矩形内的客户区域无效的回调函数。 更多... | |
| boolean | isCurrentDocOpenedInBrowser () |
| 获取标志的回调函数,该标志指定当前文档是否在浏览器中打开。 更多... | |
| boolean | isLocalFile (PDFDoc document) |
| 检查文件是否为本地文件的回调函数。 更多... | |
| boolean | isPageLoop () |
| 获取标志的回调函数,该标志指定文档是否会循环回到文档开头以响应页面前进。 更多... | |
| boolean | launchURL (String url) |
| 启动到指定URL的回调函数。 更多... | |
| boolean | mailData (java.lang.Object data, boolean is_ui, String to, String subject, String cc, String bcc, String message) |
| 发送数据或消息的回调函数,可以带有或不带有用户交互。 更多... | |
| int | mailDoc (PDFDoc document, String to_address, String cc_address, String bcc_address, String subject, String message, boolean is_ui) |
| 将文档作为附件发送邮件的回调函数。 更多... | |
| void | notifyAfterDataChange (PDFDoc document, JavascriptModifyItemInfo modify_item_info) |
| 用于通知JS执行后内容已经被修改的回调函数。 更多... | |
| void | notifyBeginDoJob (PDFDoc document, int event_type) |
| 用于通知JS开始执行的回调函数。 更多... | |
| void | notifyEndDoJob (PDFDoc document, int event_type) |
| 用于通知JS已经执行结束。 更多... | |
| void | onFieldValueChanged (String field_name, int type, WStringArray value_before_changed, WStringArray value_after_changed) |
| 通知字段值变化的回调函数。 更多... | |
| PDFDoc | openDoc (String file_path, String password) |
| 打开PDF文件的回调函数。 更多... | |
| MediaPlayerCallback | openMediaPlayer (PlayerArgs player_args) |
| 打开媒体播放器的回调函数。 更多... | |
| String | popupMenu (MenuListArray menus, java.lang.Boolean is_selected_item) |
| 弹出菜单窗口的回调函数。 更多... | |
| MenuItemEx | popupMenuEx (MenuItemExArray menus, java.lang.Boolean is_selected_item) |
| 弹出菜单窗口的回调函数。 更多... | |
| void | postMessageToHtml (WStringArray message) |
| 向PDF文档的宿主容器的消息处理程序异步发送消息的回调函数。 更多... | |
| boolean | print (PDFDoc document, boolean is_ui, Range page_range, boolean is_silent, boolean is_shrunk_to_fit, boolean is_printed_as_image, boolean is_reversed, boolean is_to_print_annots) |
| 打印指定索引范围内页面的回调函数。 更多... | |
| boolean | print (PDFDoc document, PrintParams print_params) |
| 使用打印参数打印文档的回调函数。 更多... | |
| void | query (String keywords, int search_scope, SearchOption search_option, String di_path) |
| 查询文本关键字的回调函数。 更多... | |
| void | release () |
| 用于释放当前回调对象本身的回调函数。 更多... | |
| boolean | removeSearchIndex (SearchIndexConfig search_index_config) |
| (保留,尚不支持)移除搜索索引的回调函数。 更多... | |
| boolean | removeToolButtom (String button_name) |
| 移除通过函数 ActionCallback.addToolButton 添加的工具按钮的回调函数。 更多... | |
| void | resetModifyItem (PDFDoc document) |
| 重置修改项的回调。 更多... | |
| String | response (String question, String title, String default_value, String label, boolean is_password) |
| 显示包含问题和输入字段供用户回复问题的对话框的回调函数。 更多... | |
| void | scroll (PointF point) |
| 将当前页面上指定点滚动到当前视图中央的回调函数。 更多... | |
| void | selectPageNthWord (int page_index, int start_offset, int end_offset, boolean is_show_selection) |
| 更改当前页码并选择页面上指定单词的回调函数。 更多... | |
| void | setCurrentPage (PDFDoc document, Destination destination) |
| 用于根据目标设置当前页面的回调函数。 更多... | |
| void | setCurrentPage (PDFDoc document, int page_index) |
| 用于通过索引设置当前页面的回调函数。 更多... | |
| void | setDefaultPageTransitionMode (String trans_type, String trans_di) |
| 设置全屏模式下默认页面过渡模式的回调函数。 更多... | |
| boolean | setDocChangeMark (PDFDoc document, boolean change_mark) |
| 设置更改标记的回调函数,该标记指示文档内容是否已更改。 更多... | |
| void | setFullScreen (boolean is_full_screen) |
| 设置全屏模式的回调函数。 更多... | |
| boolean | setIdentityProperties (IdentityProperties identity_properties) |
| 设置当前用户身份属性的回调函数。 更多... | |
| void | setLayoutMode (int layout_mode, boolean is_cover_mode) |
| 设置当前文档页面布局的回调函数。 更多... | |
| boolean | setPageRotation (PDFDoc document, int page_index, int rotation) |
| 用于在PDF查看器中设置页面旋转值的回调函数。 更多... | |
| void | setPageScale (int zoom_mode, Destination dest) |
| 设置当前页面缩放值的回调函数。 更多... | |
| boolean | showDialog (DialogDescriptionConfig dlg_config) |
| 显示对话框的回调函数。 更多... | |
| SOAPResponseInfo | soapRequest (SOAPRequestProperties request_params) |
| 启动远程过程调用 (RPC) 或向 SOAP HTTP 端点发送 XML 消息。 更多... | |
| boolean | submitForm (PDFDoc document, byte[] form_data, String url, int file_format_type) |
| 向指定URL提交表单数据的回调函数。 更多... | |
| void | updateLogicalLabel () |
| 更新逻辑标签的回调函数。 更多... | |
| int | verifySignature (PDFDoc document, Signature pdf_signature) |
| 验证指定签名的回调函数。 更多... | |
静态 Public 属性 | |
| static final int | e_AppInfoTypeAppVersion = 0x04 |
| 应用程序的应用版本信息。 | |
| static final int | e_AppInfoTypeFormsVersion = 0x0 |
| 应用程序的表单版本信息。 | |
| static final int | e_AppInfoTypeViewerType = 0x01 |
| 应用程序的查看器类型信息。 | |
| static final int | e_AppInfoTypeViewerVariation = 0x02 |
| 应用程序的查看器变体信息。 | |
| static final int | e_AppInfoTypeViewerVersion = 0x03 |
| 应用程序的查看器版本信息。 | |
| static final int | e_JSFieldValueChangedByCalculation = 1 |
| JavaScript字段值变更类型:计算。 | |
| static final int | e_JSFieldValueChangedByFillColor = 4 |
| JavaScript字段值变更类型:字段填充颜色。 | |
| static final int | e_JSFieldValueChangedByFormat = 0 |
| JavaScript字段值变更类型:格式化。 | |
| static final int | e_JSFieldValueChangedBySetReadOnly = 3 |
| JavaScript字段值变更类型:字段设置只读属性。 | |
| static final int | e_JSFieldValueChangedBySetValue = 2 |
| JavaScript字段值变更类型:字段设置值。 | |
| static final int | e_JSMailResultFailed = 0 |
| 邮件结果:邮件发送失败。 | |
| static final int | e_JSMailResultSuccess = 1 |
| 邮件结果:邮件发送成功。 | |
| static final int | e_JSMailResultUserAbort = 2 |
| 邮件结果:用户中止。 | |
| static final int | e_JSMediaPlayerStateClose = 1 |
| 媒体播放器状态:关闭。 | |
| static final int | e_JSMediaPlayerStateOpen = 0 |
| 媒体播放器状态:打开。 | |
| static final int | e_JSMediaPlayerStatePlaying = 2 |
| 媒体播放器状态:播放中。 | |
| static final int | e_JSMediaPlayerStateStop = 3 |
| 媒体播放器状态:停止。 | |
| static final int | e_JSMediaPlayerStateSuspend = 4 |
| 媒体播放器状态:暂停。 | |
| static final int | e_LanguageCHS = 1 |
| 简体中文。 | |
| static final int | e_LanguageCHT = 2 |
| 繁体中文。 | |
| static final int | e_LanguageDAN = 3 |
| 丹麦语。 | |
| static final int | e_LanguageDEU = 4 |
| 德语。 | |
| static final int | e_LanguageENU = 5 |
| 英语。 | |
| static final int | e_LanguageESP = 6 |
| 西班牙语。 | |
| static final int | e_LanguageFRA = 7 |
| 法语。 | |
| static final int | e_LanguageITA = 8 |
| 意大利语。 | |
| static final int | e_LanguageJPN = 10 |
| 日语。 | |
| static final int | e_LanguageKOR = 9 |
| 韩语。 | |
| static final int | e_LanguageNLD = 11 |
| 荷兰语。 | |
| static final int | e_LanguageNOR = 12 |
| 挪威语。 | |
| static final int | e_LanguagePTB = 13 |
| 巴西葡萄牙语。 | |
| static final int | e_LanguageSUO = 14 |
| 芬兰语。 | |
| static final int | e_LanguageSVE = 15 |
| 瑞典语。 | |
| static final int | e_LanguageUnknown = 0 |
| 未知语言。 | |
| static final int | e_LayoutModeContinuous = 1 |
| 布局模式:连续页面。 | |
| static final int | e_LayoutModeContinuousFacing = 3 |
| 布局模式:连续双页。 | |
| static final int | e_LayoutModeFacing = 2 |
| 布局模式:双页。 | |
| static final int | e_LayoutModeSinglePage = 0 |
| 布局模式:单页。 | |
| static final int | e_MailTypeDoc = 0 |
| 邮寄数据类型:文档。 | |
| static final int | e_MailTypeForm = 1 |
| 邮寄数据类型:表单。 | |
| static final int | e_MailTypeMsg = 2 |
| 邮寄数据类型:字符串消息。 | |
| static final int | e_SearchScopeActiveDoc = 0 |
| 搜索范围:活动文档。 | |
| static final int | e_SearchScopeActiveIndexes = 3 |
| 搜索范围:活动索引。 | |
| static final int | e_SearchScopeFolder = 1 |
| 搜索范围:文件夹。 | |
| static final int | e_SearchScopeIndex = 2 |
| 搜索范围:索引。 | |
此类表示执行PDF动作的回调对象。 此类中的所有纯虚函数都用作回调函数,应由用户实现, 以执行PDF动作,如JavaScript动作。
| boolean com.foxit.sdk.ActionCallback.addMenuItem | ( | MenuItemConfig | menu_item_config, |
| boolean | is_prepend | ||
| ) |
向菜单添加菜单项的回调函数。
此回调函数将由JavaScript方法"app.addMenuItem"触发。
| [in] | menu_item_config | 菜单项的配置。 |
| [in] | is_prepend | 确定新菜单项相对于由 MenuItemConfig.getPos 或 MenuItemConfig.getPos_str 指定位置的位置。 默认值为 false。如果此参数为 true,插入规则如下:
|
| SearchIndexConfig com.foxit.sdk.ActionCallback.addSearchIndex | ( | String | di_path, |
| boolean | is_selected | ||
| ) |
添加搜索索引的回调函数。
此回调函数将由JavaScript方法"search.addIndex"触发。此回调函数是可选的, 因此可以实现为不做任何事情。
| [in] | di_path | 用户硬盘上索引文件的设备无关路径。 |
| [in] | is_selected | 指定是否应选择索引进行搜索。默认值:true。 |
| boolean com.foxit.sdk.ActionCallback.addSubMenu | ( | MenuItemConfig | menu_item_config | ) |
向应用程序添加带有子菜单的菜单项的回调函数。
此回调函数将由JavaScript方法"app.addSubMenu"触发。
| [in] | menu_item_config | 菜单项的配置。 |
| boolean com.foxit.sdk.ActionCallback.addToolButton | ( | ButtonItem | button_item | ) |
添加工具按钮的回调函数。
此回调函数将由JavaScript方法"app.addToolButton"触发。
| [in] | button_item | 工具按钮的 ButtonItem 对象。 |
| int com.foxit.sdk.ActionCallback.alert | ( | String | msg, |
| String | title, | ||
| int | type, | ||
| int | icon | ||
| ) |
弹出对话框显示警告或提示的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | msg | 要在对话框中显示的消息字符串。 |
| [in] | title | 对话框的标题。 |
| [in] | type | 按钮组类型。它应该是以下值之一:
|
| [in] | icon | 图标类型。它应该是以下值之一:
|
| boolean com.foxit.sdk.ActionCallback.beep | ( | int | type | ) |
使系统播放声音的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | type | 声音类型。值应为以下值之一:
|
| String com.foxit.sdk.ActionCallback.browseFile | ( | ) |
显示文件选择对话框的回调函数,选择的文件路径应该被返回。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| String com.foxit.sdk.ActionCallback.browseFile | ( | boolean | is_open_dialog, |
| String | file_format, | ||
| String | file_filter | ||
| ) |
显示文件选择对话框的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | is_open_dialog | 布尔值,指定对话框是用于打开文件还是保存文件。 true 表示对话框应用于打开文件,false 表示 对话框应用于保存文件。 |
| [in] | file_format | 文件格式字符串。 |
| [in] | file_filter | 文件过滤器字符串。 |
| void com.foxit.sdk.ActionCallback.closeDoc | ( | PDFDoc | document, |
| boolean | is_prompt_to_save | ||
| ) |
关闭文档的回调函数。
此回调函数将由JavaScript方法"Doc.closeDoc"触发。 此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | is_prompt_to_save | true 表示显示保存提示,false 表示不显示。 |
| PDFDoc com.foxit.sdk.ActionCallback.createBlankDoc | ( | ) |
创建空白PDF文档对象的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| void com.foxit.sdk.ActionCallback.enablePageLoop | ( | boolean | is_loop | ) |
设置标志的回调函数,该标志指定在全屏模式下,文档是否会循环回到文档开头以响应页面前进(无论是由鼠标点击、键盘还是计时器生成)。
此回调函数将由JavaScript属性"app.fs.loop"触发。 此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | is_loop | true 表示循环回到文档开头,false 表示不循环。 |
| boolean com.foxit.sdk.ActionCallback.executeNamedAction | ( | PDFDoc | document, |
| String | named_action | ||
| ) |
执行命名操作的回调函数。
请参考<PDF Reference 1.7>第8.5.3节中"命名操作"的描述以获取更多详细信息。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | named_action | 指定命名操作的字符串。 |
| String com.foxit.sdk.ActionCallback.getAppInfo | ( | int | type | ) |
获取应用程序信息的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
对于数字信息,如 com.foxit.sdk.ActionCallback.e_AppInfoTypeViewerVersion 、com.foxit.sdk.ActionCallback.e_AppInfoTypeAppVersion 和 com.foxit.sdk.ActionCallback.e_AppInfoTypeFormsVersion ,请使用字符串来表示。
| [in] | type | 信息类型。请参考从 com.foxit.sdk.ActionCallback.e_AppInfoTypeFormsVersion 开始的值,它应该是这些值中的一个。 |
| String com.foxit.sdk.ActionCallback.getAttachmentsFilePath | ( | PDFDoc | pdf_doc, |
| String | name | ||
| ) |
获取附件文件路径的回调函数。
此回调函数将由JavaScript方法"Doc.importDataObject"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | pdf_doc | PDF文档对象。它将嵌入一个数据对象。 |
| [in] | name | 与数据对象关联的名称。这是方法"Doc.importDataObject"的参数"cName"。 |
| PDFDoc com.foxit.sdk.ActionCallback.getCurrentDoc | ( | ) |
接收当前PDF文档对象的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| int com.foxit.sdk.ActionCallback.getCurrentPage | ( | PDFDoc | document | ) |
用于接收当前页面索引的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| boolean com.foxit.sdk.ActionCallback.getDocChangeMark | ( | PDFDoc | document | ) |
接收更改标记的回调函数,该标记指示文档内容是否已更改。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| String com.foxit.sdk.ActionCallback.getExtractedEmbeddedFilePath | ( | PDFDoc | pdf_doc, |
| String | name | ||
| ) |
获取提取的嵌入文件路径的回调函数。
此回调函数将由JavaScript方法"Doc.exportDataObject"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | pdf_doc | PDF文档对象。它将作为数据对象嵌入到文件中。 |
| [in] | name | 要提取的数据对象的名称。这是方法"Doc.exportDataObject"的参数"cName"。 |
| String com.foxit.sdk.ActionCallback.getFilePath | ( | PDFDoc | document | ) |
获取当前PDF文档文件路径的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| boolean com.foxit.sdk.ActionCallback.getFullScreen | ( | ) |
获取是否设置了全屏模式的回调函数。
此回调函数将由JavaScript属性"app.fullScreen"或"app.fs.isFullScreen"触发。
| IdentityProperties com.foxit.sdk.ActionCallback.getIdentityProperties | ( | ) |
获取当前用户身份属性的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| int com.foxit.sdk.ActionCallback.getLanguage | ( | ) |
获取正在运行的查看器应用程序语言的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| int com.foxit.sdk.ActionCallback.getLayoutMode | ( | ) |
获取当前文档页面布局的回调函数。
此回调函数将由JavaScript属性"Doc.layout"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| MenuListArray com.foxit.sdk.ActionCallback.getMenuItemNameList | ( | ) |
获取菜单项名称列表的回调函数。
此回调函数将由JavaScript方法"app.listMenuItems"触发。
| PointF com.foxit.sdk.ActionCallback.getMousePosition | ( | ) |
获取当前鼠标位置的回调函数。
此回调函数将由JavaScript属性"doc.mouseX"或"doc.mouseY"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| PDFDoc com.foxit.sdk.ActionCallback.getOpenedDoc | ( | int | index | ) |
通过索引接收已打开PDF文档对象的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | index | 已打开PDF文档的索引。有效范围:从0到 count-1。 count 由回调函数 ActionCallback.getOpenedDocCount 返回; |
| int com.foxit.sdk.ActionCallback.getOpenedDocCount | ( | ) |
接收已打开文档数量的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| int com.foxit.sdk.ActionCallback.getPageRotation | ( | PDFDoc | document, |
| int | page_index | ||
| ) |
用于接收PDF查看器中页面当前显示旋转值的回调函数。
此回调函数是可选的,可以实现为不执行任何操作, 仅返回一个无用的值。
| [in] | document | PDF文档对象。该对象应当是有效的。 |
| [in] | page_index | 页面索引,用于指定要获取旋转值的页面。 索引从0开始,应小于指定文档的页面总数。 |
| float com.foxit.sdk.ActionCallback.getPageScale | ( | ) |
获取当前页面缩放值的回调函数。
此回调函数将由JavaScript属性"Doc.zoom"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| int com.foxit.sdk.ActionCallback.getPageZoomMode | ( | ) |
获取当前页面缩放模式的回调函数。
此回调函数将由JavaScript属性"Doc.zoom"或"Doc.zoomType"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| WStringArray com.foxit.sdk.ActionCallback.getPrinterNameList | ( | ) |
获取打印机名称列表的回调函数。
此回调函数将由JavaScript属性"app.printerNames"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| WStringArray com.foxit.sdk.ActionCallback.getSignatureAPStyleNameList | ( | ) |
获取签名外观样式名称列表的回调函数。
此回调函数将由JavaScript方法"SecurityHandler.appearances"触发。 此回调函数是可选的,因此可以实现为不做任何事情。
| String com.foxit.sdk.ActionCallback.getTemporaryDirectory | ( | ) |
获取临时目录的回调函数。
此回调函数将由JavaScript方法"Doc.extractpages"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| String com.foxit.sdk.ActionCallback.getTemporaryFileName | ( | PDFDoc | document, |
| String | file_suffix_name | ||
| ) |
获取临时文件路径的回调函数。临时文件名将文档名与文件后缀名组合。
此回调函数将由JavaScript方法"Doc.mailForm"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | file_suffix_name | 文件后缀名。 |
| String com.foxit.sdk.ActionCallback.getUntitledBookmarkName | ( | ) |
获取无标题书签新名称的回调函数。
当JavaScript方法"bookmark.createChild"的参数"cName"为空字符串时, 将触发此回调函数。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| int com.foxit.sdk.ActionCallback.getVisiblePage | ( | PDFDoc | document, |
| int | index | ||
| ) |
获取可见页的回调。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| [in] | index | 可见页索引。 有效范围: 从 0 到 (count-1)。 count 由接口 返回。 |
| int com.foxit.sdk.ActionCallback.getVisiblePageCount | ( | PDFDoc | document | ) |
获取可见页页数的回调。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| boolean com.foxit.sdk.ActionCallback.initModifyItem | ( | PDFDoc | document, |
| int | item_type, | ||
| int | page_index, | ||
| String | dict_name | ||
| ) |
初始化修改项的回调。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| [in] | item_type | 修改项类型。请参考值从 ActionCallback::e_ModifyItemTypeNone , 它的值应该是这些值中的一个。 |
| [in] | page_index | 被修改的页面索引。 |
| [in] | dict_name | 字典名称。 |
| boolean com.foxit.sdk.ActionCallback.invalidateRect | ( | PDFDoc | document, |
| int | page_index, | ||
| RectF | pdf_rect | ||
| ) |
使指定矩形内的客户区域无效的回调函数。
所有位置都以PDF"用户空间"测量。实现应调用函数 common.Renderer.startRender 来重绘指定的页面区域。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | page_index | 页面索引。它应该从0开始,小于指定文档的页数。 |
| [in] | pdf_rect | 指定中页面区域的矩形。 如果这是一个空矩形,表示刷新整个页面。 |
| boolean com.foxit.sdk.ActionCallback.isCurrentDocOpenedInBrowser | ( | ) |
获取标志的回调函数,该标志指定当前文档是否在浏览器中打开。
此回调函数将由JavaScript属性"doc.hostContainer"触发。 此回调函数是可选的,因此可以实现为不做任何事情。
| boolean com.foxit.sdk.ActionCallback.isLocalFile | ( | PDFDoc | document | ) |
检查文件是否为本地文件的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| boolean com.foxit.sdk.ActionCallback.isPageLoop | ( | ) |
获取标志的回调函数,该标志指定文档是否会循环回到文档开头以响应页面前进。
此回调函数将由JavaScript属性"app.fs.loop"触发。 此回调函数是可选的,因此可以实现为不做任何事情。
| boolean com.foxit.sdk.ActionCallback.launchURL | ( | String | url | ) |
启动到指定URL的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | url | 一个URL。 |
| boolean com.foxit.sdk.ActionCallback.mailData | ( | java.lang.Object | data, |
| boolean | is_ui, | ||
| String | to, | ||
| String | subject, | ||
| String | cc, | ||
| String | bcc, | ||
| String | message | ||
| ) |
发送数据或消息的回调函数,可以带有或不带有用户交互。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | data | 要发送的数据。 数据的值和类型取决于参数 data_type:
|
| [in] | is_ui | true 表示其余参数用于 填充显示给用户的新消息编写窗口。 false 表示参数 to 是必需的,其他所有参数 都是可选的。 |
| [in] | to | 指定消息收件人的分号分隔列表的字符串。 |
| [in] | subject | 指定消息主题的字符串。 此字符串长度限制为 64 KB。 |
| [in] | cc | 指定消息抄送收件人的分号分隔列表的字符串。 |
| [in] | bcc | 指定消息密送收件人的分号分隔列表的字符串。 |
| [in] | message | 指定消息内容的字符串。 此字符串长度限制为 64 KB。 |
| int com.foxit.sdk.ActionCallback.mailDoc | ( | PDFDoc | document, |
| String | to_address, | ||
| String | cc_address, | ||
| String | bcc_address, | ||
| String | subject, | ||
| String | message, | ||
| boolean | is_ui | ||
| ) |
将文档作为附件发送邮件的回调函数。
此回调函数将由JavaScript方法"Doc.mailDoc"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | to_address | 收件人地址。 |
| [in] | cc_address | 抄送地址。 |
| [in] | bcc_address | 密送地址。 |
| [in] | subject | 邮件主题。 |
| [in] | message | 邮件消息。 |
| [in] | is_ui | true 表示显示邮件对话框,false 表示不显示。 |
| void com.foxit.sdk.ActionCallback.notifyAfterDataChange | ( | PDFDoc | document, |
| JavascriptModifyItemInfo | modify_item_info | ||
| ) |
用于通知JS执行后内容已经被修改的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| [in] | modify_item_info | JavascriptModifyItemInfo 对象,它包含修改细节。 |
| void com.foxit.sdk.ActionCallback.notifyBeginDoJob | ( | PDFDoc | document, |
| int | event_type | ||
| ) |
用于通知JS开始执行的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| [in] | event_type | JS事件类型。请参考值 com.foxit.sdk.JavascriptModifyItemInfo.e_JavascriptEventTypeUnknown , 它的值应该是这些值中的一个。 |
| void com.foxit.sdk.ActionCallback.notifyEndDoJob | ( | PDFDoc | document, |
| int | event_type | ||
| ) |
用于通知JS已经执行结束。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| [in] | event_type | JS事件类型。请参考值 com.foxit.sdk.JavascriptModifyItemInfo.e_JavascriptEventTypeUnknown , 它的值应该是这些值中的一个。 |
| void com.foxit.sdk.ActionCallback.onFieldValueChanged | ( | String | field_name, |
| int | type, | ||
| WStringArray | value_before_changed, | ||
| WStringArray | value_after_changed | ||
| ) |
通知字段值变化的回调函数。
当字段的值通过JavaScript更改时,将触发此回调函数。
| [in] | field_name | 指定字段名称的字符串。 |
| [in] | type | 字段值变化类型。请参考从 com.foxit.sdk.ActionCallback.e_JSFieldValueChangedByFormat 开始的值,它应该是这些值中的一个。 |
| [in] | value_before_changed | 指定字段变化前值的字符串数组。 对于列表框,该参数表示同时被选择的字段的一个或多个项目。 |
| [in] | value_after_changed | 指定字段变化后值的字符串数组。 对于列表框,该参数表示同时被选择的字段的一个或多个项目。 |
| PDFDoc com.foxit.sdk.ActionCallback.openDoc | ( | String | file_path, |
| String | password | ||
| ) |
打开PDF文件的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | file_path | 现有PDF文件的完整路径。 |
| [in] | password | 输入PDF文件的密码。这可能是一个空字符串。 |
| MediaPlayerCallback com.foxit.sdk.ActionCallback.openMediaPlayer | ( | PlayerArgs | player_args | ) |
打开媒体播放器的回调函数。
此回调函数将由JavaScript方法"app.media.openPlayer"或"app.media.createPlayer"触发。
| [in] | player_args | PlayerArgs 对象。 |
| String com.foxit.sdk.ActionCallback.popupMenu | ( | MenuListArray | menus, |
| java.lang.Boolean | is_selected_item | ||
| ) |
弹出菜单窗口的回调函数。
菜单窗口的位置与光标的位置相同。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | menus | 菜单列表对象的数组。 |
| [out] | is_selected_item | 输出参数,接收菜单项是否被选择的值。 true 表示菜单项被选择,false 表示菜单项未被选择。 |
| MenuItemEx com.foxit.sdk.ActionCallback.popupMenuEx | ( | MenuItemExArray | menus, |
| java.lang.Boolean | is_selected_item | ||
| ) |
弹出菜单窗口的回调函数。
菜单窗口的位置与光标的位置相同。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | menus | MenuItemEx 对象的数组。 |
| [out] | is_selected_item | 输出参数,接收菜单项是否被选择的值。 true 表示菜单项被选择,false 表示菜单项未被选择。 |
| void com.foxit.sdk.ActionCallback.postMessageToHtml | ( | WStringArray | message | ) |
向PDF文档的宿主容器的消息处理程序异步发送消息的回调函数。
要传递此消息,宿主容器(例如,HTML页面中的<OBJECT>元素)必须 通过设置其messageHandler属性来注册通知。
此回调函数将由JavaScript方法"doc.hostContainer.postMessage"触发。 此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | message | 指定要发布的消息的字符串数组。 |
| boolean com.foxit.sdk.ActionCallback.print | ( | PDFDoc | document, |
| boolean | is_ui, | ||
| Range | page_range, | ||
| boolean | is_silent, | ||
| boolean | is_shrunk_to_fit, | ||
| boolean | is_printed_as_image, | ||
| boolean | is_reversed, | ||
| boolean | is_to_print_annots | ||
| ) |
打印指定索引范围内页面的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | is_ui | true 表示应向用户显示UI 以获取打印信息并确认操作。 |
| [in] | page_range | 指定打印页面范围的范围对象。 此范围中表示的所有索引都从0开始, 小于指定文档的页面数。 |
| [in] | is_silent | true 表示在文档打印时 应禁止显示取消对话框。 |
| [in] | is_shrunk_to_fit | true 表示页面应缩小(如果需要) 以适应打印页面的区域。 |
| [in] | is_printed_as_image | true 表示页面应作为图像打印。 |
| [in] | is_reversed | true 表示打印顺序应从参数 end 到 参数 start。 |
| [in] | is_to_print_annots | true 表示注释应与页面一起打印。 |
| boolean com.foxit.sdk.ActionCallback.print | ( | PDFDoc | document, |
| PrintParams | print_params | ||
| ) |
使用打印参数打印文档的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | print_params | 一个 PrintParams 对象。 |
| void com.foxit.sdk.ActionCallback.query | ( | String | keywords, |
| int | search_scope, | ||
| SearchOption | search_option, | ||
| String | di_path | ||
| ) |
查询文本关键字的回调函数。
此回调函数将由JavaScript方法"search.query"触发。此回调函数是可选的, 因此可以实现为不做任何事情。
| [in] | keywords | 要搜索的文本内容。 |
| [in] | search_scope | 指定文本应在何处搜索。请参考从 com.foxit.sdk.ActionCallback.e_SearchScopeActiveDoc 开始的值,它应该是这些值中的一个。 |
| [in] | search_option | 表示搜索选项的 SearchOption 对象。 |
| [in] | di_path | 用户计算机上文件夹或搜索索引的设备无关路径。此参数是 可选的。当 search_scope 为 com.foxit.sdk.ActionCallback.e_SearchScopeFolder 或 com.foxit.sdk.ActionCallback.e_SearchScopeIndex 时,此参数是必需的。 |
| void com.foxit.sdk.ActionCallback.release | ( | ) |
用于释放当前回调对象本身的回调函数。
| boolean com.foxit.sdk.ActionCallback.removeSearchIndex | ( | SearchIndexConfig | search_index_config | ) |
(保留,尚不支持)移除搜索索引的回调函数。
此回调函数将由JavaScript方法"search.removeIndex"触发。此回调函数是可选的, 因此可以实现为不做任何事情。
| [in] | search_index_config | 表示搜索索引配置的 SearchIndexConfig 。 |
| boolean com.foxit.sdk.ActionCallback.removeToolButtom | ( | String | button_name | ) |
移除通过函数 ActionCallback.addToolButton 添加的工具按钮的回调函数。
此回调函数将由JavaScript方法"app.removeToolButton"触发。
| [in] | button_name | 工具按钮的名称。 |
| void com.foxit.sdk.ActionCallback.resetModifyItem | ( | PDFDoc | document | ) |
重置修改项的回调。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象,它应该有效。 |
| String com.foxit.sdk.ActionCallback.response | ( | String | question, |
| String | title, | ||
| String | default_value, | ||
| String | label, | ||
| boolean | is_password | ||
| ) |
显示包含问题和输入字段供用户回复问题的对话框的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | question | 指定向用户提出的问题的字符串。 |
| [in] | title | 指定对话框标题的字符串。 |
| [in] | default_value | 指定作为问题答案的默认值的字符串。 如果未指定答案,则不显示默认值。 |
| [in] | label | 指定在编辑文本字段前面显示的短字符串。 |
| [in] | is_password | 布尔值,指示用户的响应是否应被掩码显示: true 表示用户的响应应显示为星号 (*) 或项目符号 (?) 来掩码响应,这可能是敏感信息。 |
| void com.foxit.sdk.ActionCallback.scroll | ( | PointF | point | ) |
将当前页面上指定点滚动到当前视图中央的回调函数。
此回调函数将由JavaScript方法"Doc.scroll"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | point | 指定的点[PDF坐标系统]。 |
| void com.foxit.sdk.ActionCallback.selectPageNthWord | ( | int | page_index, |
| int | start_offset, | ||
| int | end_offset, | ||
| boolean | is_show_selection | ||
| ) |
更改当前页码并选择页面上指定单词的回调函数。
此回调函数将由JavaScript方法"Doc.selectPageNthWord"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | page_index | 页面索引。 |
| [in] | start_offset | 起始单词偏移量。 |
| [in] | end_offset | 结束单词偏移量。 |
| [in] | is_show_selection | true 表示显示选择,false 表示不显示。 |
| void com.foxit.sdk.ActionCallback.setCurrentPage | ( | PDFDoc | document, |
| Destination | destination | ||
| ) |
用于根据目标设置当前页面的回调函数。
此回调函数是可选的,可以实现为不执行任何操作。
| [in] | document | PDF文档对象。该对象应当是有效的。 |
| [in] | destination |
| void com.foxit.sdk.ActionCallback.setCurrentPage | ( | PDFDoc | document, |
| int | page_index | ||
| ) |
用于通过索引设置当前页面的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | page_index | 用于更改当前页面的页面索引。 索引应该从0开始,小于指定文档的页数。 |
| void com.foxit.sdk.ActionCallback.setDefaultPageTransitionMode | ( | String | trans_type, |
| String | trans_di | ||
| ) |
设置全屏模式下默认页面过渡模式的回调函数。
此回调函数将由JavaScript属性"app.fs.defaultTransition"触发。 此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | trans_type | 指定过渡效果类型的字符串。请参考以下值: "Split", "Box", "Fly", "Blinds", "Push", "Wipe", "Glitter", "Cover", "Uncover", "Dissolve", "Replace", "Fade"。 |
| [in] | trans_di | 指定过渡效果方向的字符串。
|
| boolean com.foxit.sdk.ActionCallback.setDocChangeMark | ( | PDFDoc | document, |
| boolean | change_mark | ||
| ) |
设置更改标记的回调函数,该标记指示文档内容是否已更改。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | change_mark | 指示文档内容是否已更改的布尔值。 |
| void com.foxit.sdk.ActionCallback.setFullScreen | ( | boolean | is_full_screen | ) |
设置全屏模式的回调函数。
当JavaScript属性"app.fullScreen"或"app.fs.isFullScreen"要被设置时,将触发此回调函数。
| [in] | is_full_screen | true 表示设置全屏模式,false 表示不设置。 |
| boolean com.foxit.sdk.ActionCallback.setIdentityProperties | ( | IdentityProperties | identity_properties | ) |
设置当前用户身份属性的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | identity_properties | 要设置的身份属性对象。 |
| void com.foxit.sdk.ActionCallback.setLayoutMode | ( | int | layout_mode, |
| boolean | is_cover_mode | ||
| ) |
设置当前文档页面布局的回调函数。
此回调函数将由JavaScript属性"Doc.layout"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | layout_mode | 布局模式。请参考从 com.foxit.sdk.ActionCallback.e_LayoutModeSinglePage 开始的值, 它应该是这些值中的一个。 |
| [in] | is_cover_mode | true 表示封面将始终单独显示,false 表示不单独显示。 |
| boolean com.foxit.sdk.ActionCallback.setPageRotation | ( | PDFDoc | document, |
| int | page_index, | ||
| int | rotation | ||
| ) |
用于在PDF查看器中设置页面旋转值的回调函数。
此回调函数是可选的,可以实现为不执行任何操作。
| [in] | document | PDF文档对象。该对象应当是有效的。 |
| [in] | page_index | 页面索引,用于指定要更改旋转的页面。 索引从0开始,应小于指定文档的页面总数。 |
| [in] | rotation | 新的旋转值。请参考从 com.foxit.sdk.common.Constants.e_Rotation0 开始的值, 应当是这些值中的一个,但不能是 com.foxit.sdk.common.Constants.e_RotationUnknown 。 |
| void com.foxit.sdk.ActionCallback.setPageScale | ( | int | zoom_mode, |
| Destination | dest | ||
| ) |
设置当前页面缩放值的回调函数。
此回调函数将由JavaScript属性"Doc.zoom"或"Doc.zoomType"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | zoom_mode | 缩放模式。请参考从 com.foxit.sdk.pdf.actions.Destination.e_ZoomXYZ 开始的值,它应该是这些值中的一个。 |
| [in] | dest | 表示目标数据的 com.foxit.sdk.pdf.actions.Destination 对象。 |
| boolean com.foxit.sdk.ActionCallback.showDialog | ( | DialogDescriptionConfig | dlg_config | ) |
显示对话框的回调函数。
此回调函数将由JavaScript方法"app.execDialog"触发。
| [in] | dlg_config | DialogDescriptionConfig 对象。 |
| SOAPResponseInfo com.foxit.sdk.ActionCallback.soapRequest | ( | SOAPRequestProperties | request_params | ) |
启动远程过程调用 (RPC) 或向 SOAP HTTP 端点发送 XML 消息。
该方法要么等待端点回复(同步处理),要么调用 通知对象上的方法(异步处理)。
此回调函数将由JavaScript方法"SOAP.request"触发。 此回调函数是可选的,因此可以实现为不做任何事情。
| [in] | request_params | 包含 SOAP 请求属性参数的 SOAPRequestProperties 对象。 |
| boolean com.foxit.sdk.ActionCallback.submitForm | ( | PDFDoc | document, |
| byte[] | form_data, | ||
| String | url, | ||
| int | file_format_type | ||
| ) |
向指定URL提交表单数据的回调函数。
此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | form_data | 要提交的表单数据缓冲区。 |
| [in] | url | 表单数据将被提交到的URL。 |
| [in] | file_format_type | 提交表单的文件格式类型。请参考从 com.foxit.sdk.common.Constants.e_FileFormatTypeFDF 开始的值, 它应该是这些值中的一个。 |
| void com.foxit.sdk.ActionCallback.updateLogicalLabel | ( | ) |
更新逻辑标签的回调函数。
此回调函数将由JavaScript方法"Doc.setPageLabels"触发。 此回调函数是可选的,因此可以实现为不做任何事情, 只返回一个无用的值。
验证指定签名的回调函数。
当动作需要验证签名时,将触发此回调函数。 如果用户不想验证签名,只需实现此函数不做任何事情, 只返回 com.foxit.sdk.pdf.Signature.e_StateUnknown 。 建议用户使用类 com.foxit.sdk.pdf.LTVVerifier 来验证已签名的签名是否有效。
| [in] | document | PDF文档对象。它应该是有效的。 |
| [in] | pdf_signature | 已签名的PDF签名。此签名属于输入参数 document。 |