Android轻量级PDF阅读器库——Pdf Viewer 技术文档
安装指南
为了将此轻量级PDF查看器集成到您的Android项目中,请按照以下步骤操作:
-
打开您的Android项目的
build.gradle
(Module: app)文件。 -
在
dependencies
块中,添加以下依赖项(确保替换latest-version
为实际的最新版本号)。Groovy DSL
dependencies { implementation 'io.github.afreakyelf:Pdf-Viewer:latest-version' }
Kotlin DSL
dependencies { implementation("io.github.afreakyelf:Pdf-Viewer:latest-version") }
-
同步Gradle项目以应用更改。
项目使用说明
基本使用
Pdf Viewer 提供了多种打开PDF文档的方式,包括从URL、本地存储和资产目录加载。
从URL加载
在需要展示PDF的活动内,您可以这样调用:
PdfViewerActivity.launchPdfFromUrl(
context = this,
pdfUrl = "https://example.com/document.pdf", // PDF的URL地址
pdfTitle = "文档标题",
saveTo = PdfViewerActivity.saveTo.ASK_EVERYTIME, // 每次询问是否保存
enableDownload = true // 允许下载
)
从本地路径加载
PdfViewerActivity.launchPdfFromPath(
context = this,
path = "/storage/emulated/0/mydoc.pdf", // 文件路径
pdfTitle = "本地文档",
saveTo = PdfViewerActivity.saveTo.ASK_ONCE, // 只询问一次
fromAssets = false // 不是从Asset加载
)
从资产加载
PdfViewerActivity.launchPdfFromPath(
context = this,
path = "docs/document.pdf", // 资产中的文件名
pdfTitle = "资产文档",
saveTo = PdfViewerActivity.saveTo.NEVER, // 不允许保存
fromAssets = true // 从Asset加载
)
在布局文件中嵌入PDF视图
您也可以直接在XML布局中使用PdfRendererView,并在代码中初始化它。
<com.rajat.pdfviewer.PdfRendererView
android:id="@+id/pdfView"
android:layout_width="match_parent"
android:layout_height="match_parent"/>
然后,在对应的Activity或Fragment中初始化:
val pdfView = findViewById<PdfRendererView>(R.id.pdfView)
pdfView.initWithUrl("https://example.com/document.pdf", lifecycleScope, lifecycle)
API使用文档
Pdf Viewer提供了一些可自定义的参数,例如UI主题定制、页面切换指示等。通过创建或修改应用程序的主题,您可以调整如导航图标、工具栏颜色等元素。此外,通过修改strings.xml
可以改变页码显示格式。
自定义属性示例
在styles.xml
中创建或修改主题,比如设置返回按钮图标:
<style name="MyPdfViewerTheme" parent="Theme.PdfView.Light">
<item name="pdfView_backIcon">@drawable/my_custom_back_icon</item>
<item name="pdfView_disableScreenshots">true</item> <!-- 禁止截屏 -->
</style>
并确保在AndroidManifest.xml
中为您的Activity指定这个主题。
页面数字自定义
编辑pdf_view_page_no.xml
布局文件,可以定制页面数目的显示样式。
支持的属性
pdfView_backIcon
: 导航返回图标资源ID。pdfView_downloadIcon
: 下载图标资源ID。- 更多属性在库的文档或源码注释中有详细说明。