PdfViewPager项目技术文档

PdfViewPager项目技术文档

【免费下载链接】PdfViewPager Android widget that can render PDF documents stored on SD card, linked as assets, or downloaded from a remote URL. 项目地址: https://gitcode.com/gh_mirrors/pd/PdfViewPager

安装指南

对于支持Android API 21及以上版本的应用

在您的项目build.gradle的dependencies部分添加以下依赖：

implementation 'es.voghdev.pdfviewpager:library:1.1.2'

若您的应用需要兼容旧版并使用android.support库，则应添加：

implementation 'es.voghdev.pdfviewpager:library:1.0.6'

确保您的应用已经配置了正确的仓库来获取此依赖项，通常JCenter或Google Maven已包含在内。

项目使用说明

显示本地PDF（资产目录）

1. 如需从资产目录加载PDF，首先将文件复制到缓存目录。

   CopyAsset copyAsset = new CopyAssetThreadImpl(context, new Handler());
   copyAsset.copy("your_asset_pdf_name", new File(getCacheDir(), "sample.pdf").getAbsolutePath());
   

2. 创建PDFViewPager实例，并传递文件名。

   PDFViewPager pdfViewPager = new PDFViewPager(this, "sample.pdf");
   

或者，在XML布局中声明它：

<es.voghdev.pdfviewpager.library.PDFViewPager
    android:id="@+id/pdfViewPager"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:assetFileName="sample.pdf"/>

处理生命周期

记得在onDestroy()方法中释放资源：

@Override
protected void onDestroy() {
    super.onDestroy();
    ((PDFPagerAdapter) pdfViewPager.getAdapter()).close();
}

使用SD卡上的PDF

创建一个PDFViewPager对象，传入SD卡上的PDF文件路径：

String pdfPath = Environment.getExternalStorageDirectory().concat("/path/to/your/pdf.pdf");
PDFViewPager pdfViewPager = new PDFViewPager(this, pdfPath);

加载远程PDF

1. 添加必要的权限至AndroidManifest.xml：

   <uses-permission android:name="android.permission.INTERNET"/>
   <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
   <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
   

2. 实现DownloadFile.Listener接口处理下载逻辑，并创建RemotePDFViewPager对象。

   RemotePDFViewPager remotePDFViewPager = 
           new RemotePDFViewPager(this, "http://example.com/path/to/pdf.pdf", this);
   

3. 在回调中设置adapter和相应视图内容。

项目API使用文档

• PDFViewPager

  • 构造函数接收PDF文件的路径或资产名称。
  • 自动支持页面缩放和平移。

• PDFPagerAdapter

  • 用于管理PDF页面的适配器，确保在销毁时调用.close()以释放资源。

• RemotePDFViewPager（扩展功能）

  • 接收URL地址，实现监听器模式处理远程PDF的下载、成功、失败和进度更新事件。

注意事项

• 确保对API级别进行检查，因为PdfRenderer仅支持API 21+。
• 对于旧设备，查阅遗留样例代码支持低API版本。
• 更新至最新版本以利用所有功能和修复。

---

本技术文档旨在提供全面指导，帮助开发者快速集成PdfViewPager至其Android项目中，无论是显示本地PDF、SD卡上PDF还是远程PDF文档。正确遵循上述步骤将确保PDF文档流畅且高效地展示给用户。

【免费下载链接】PdfViewPager Android widget that can render PDF documents stored on SD card, linked as assets, or downloaded from a remote URL. 项目地址: https://gitcode.com/gh_mirrors/pd/PdfViewPager