Android轻量级PDF阅读器库——Pdf Viewer 技术文档

Android轻量级PDF阅读器库——Pdf Viewer 技术文档

Pdf-Viewer A Lightweight PDF Viewer Android library which only occupies around 80kb while most of the Pdf viewer occupies up to 16MB space. Pdf-Viewer 项目地址: https://gitcode.com/gh_mirrors/pdf/Pdf-Viewer


安装指南

为了将此轻量级PDF查看器集成到您的Android项目中,请按照以下步骤操作:

  1. 打开您的Android项目的build.gradle(Module: app)文件。

  2. 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")
    }
    
  3. 同步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。
  • 更多属性在库的文档或源码注释中有详细说明。

项目特点与安装方式已详述于上述内容,确保遵循正确的 Gradle 配置与使用步骤,即可轻松集成 Pdf Viewer 到您的Android应用中,享受其高效且功能丰富的PDF查看体验。对于进一步的贡献或者了解谁在使用该库,请参考项目的GitHub页面和贡献指南。

Pdf-Viewer A Lightweight PDF Viewer Android library which only occupies around 80kb while most of the Pdf viewer occupies up to 16MB space. Pdf-Viewer 项目地址: https://gitcode.com/gh_mirrors/pdf/Pdf-Viewer

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

尹良杉Dexter

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值