运行示例程序
福昕 PDF SDK 安卓版提供了多个示例程序(Demo),帮助开发者快速了解 SDK 的 API 用法以及在实际应用中的集成方式。通过这些 Demo,开发者可以从 PDF 核心能力 入手,逐步过渡到 完整 PDF 阅读器应用 的实现。
在运行 Demo 之前,请确保已正确安装以下开发环境:
- Android Studio(建议使用 Koala | 2024.1.1 及以上版本)
- Android SDK
- JDK
本文档不包含 Android Studio、Android SDK 和 JDK 的安装说明,如尚未安装,请参考 Android 官方开发者文档。
示例程序概览
福昕 PDF SDK 安卓版当前提供以下三类示例程序:
| Demo 类型 | 说明 |
|---|---|
| Function Demo | 演示 PDF 核心 API 的独立功能调用 |
| Viewer Control Demo | 基于 PDFViewCtrl 的 PDF 阅读与交互功能演示 |
| Complete PDF Viewer Demo | 基于 UI Extensions 的完整 PDF 阅读器演示 |
通用运行步骤
以下步骤适用于所有示例程序(如无特殊说明):
- 在 Android Studio 中,通过 File → New → Import Project… 或 File → Open… 导入对应的 Demo 工程。
- 启动 Android 设备或模拟器(AVD),示例以 Android 10.0 模拟器为例。
- 点击 Run → Run 'app' 运行 Demo。
- Demo 安装完成后,如弹出文件访问权限提示,请选择 Allow。
Function Demo(功能示例)
Function Demo 主要用于演示如何通过 福昕 PDF SDK 的 PDF Core API 实现单一、独立的 PDF 功能,适合快速了解和验证具体接口能力。
包含的示例功能如下:
- pdf2txt:将 PDF 文档内容导出为 TXT 文件
- outline:编辑书签(Outline)的标题和显示样式
- annotation:添加注释并导出为 JSON 文件
- docinfo:导出 PDF 文档的基础信息
- render:将指定页面渲染为 Bitmap
- signature:添加签名、签署 PDF 并验证签名
- image2pdf:将图片转换为 PDF 文件
- watermark:添加文本、水印图片或 PDF 页面水印
- search:在 PDF 文档中搜索文本
- graphics_objects:创建包含图形对象的 PDF 文档
运行该 Demo 时,所需的测试文件会从 samples/test_files 自动复制到设备或模拟器中。
在应用界面中点击对应功能按钮,即可执行相应操作并查看结果。
Viewer Control Demo(PDFViewCtrl 示例)
Viewer Control Demo 用于展示基于 PDFViewCtrl(不带 UI 的 Viewer 控件)的典型 PDF 阅读器功能实现方式,适合计划自行实现阅读器 UI 的开发者参考。
主要功能包括:
- 注释操作(高亮、下划线、删除线、波浪线、便签等)
- 页面布局切换
- 文本搜索
- 书签(Outline)
- 页面缩略图
注意
Viewer Control Demo 不会自动复制测试文件。请在运行前,将 samples/test_files 目录下的 Sample.pdf 手动拷贝至设备或模拟器中的 input_files 或 FoxitSDK 目录(具体目录取决于 Demo 配置)。
Demo 运行成功后,点击页面任意位置可唤出上下文操作栏,通过更多操作菜单体验各项功能。
Complete PDF Viewer Demo(UI Extensions 示例)
Complete PDF Viewer Demo 展示了基于 UI Extensions 组件构建的完整 PDF 阅读器,集成了福昕 PDF SDK 提供的全部核心功能和内置 UI 组件。
主要特性包括:
- 内置完整 PDF 阅读器 UI
- 支持多文档浏览(自 v6.0 起)
- 支持页面缩略图、书签、搜索等常用功能
运行步骤与 Function Demo 相同。
版本说明
自 SDK v9.1 起,Android Gradle Plugin(AGP)升级至 8.5.1,Android Studio 需使用 Koala | 2024.1.1 或更高版本。如需继续使用旧版 AGP(4.1.3),请参考:回退 AGP 版本到 4.1.3。
运行 Demo 时,以下文件将自动复制到设备或模拟器的 FoxitSDK 目录中:
complete_pdf_viewer_guide_android.pdfSample.pdf
启动后,首页将显示可用的 PDF 文档列表。
点击切换按钮可进入多文档标签阅读模式,在多个 PDF 文档之间进行切换浏览。