Table of Content

Related

Requirements

How to Make an Android PDF Viewer in Java

Video Guide:Build an Android PDF Editor in Java

Create a New Project

Installation

Integrate With Gradle

dependencyResolutionManagement {    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)    repositories {        google()+       mavenCentral()    }}

dependencies {  implementation'com.compdf:compdfkit:2.4.3'  implementation'com.compdf:compdfkit-ui:2.4.3'}

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

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

Integrate Manually

...dependencies {/*ComPDFKit SDK*/    implementation(fileTree('libs'))...}...

dependencies {...//glide    implementation'com.github.bumptech.glide:glide:4.12.0'    annotationProcessor'com.github.bumptech.glide:compiler:4.12.0'    implementation'androidx.documentfile:documentfile:1.0.1'}

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

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

Apply the License Key

<!-- Each ComPDFKit license is bound to a specific applicationId--><!-- For example: com.compdfkit.pdfviewer--><meta-dataandroid:name="compdfkit_key_online"android:value="Your ComPDFKit Key" />

CPDFSdk.init(context,"your compdfkit license",false);

<!-- Each ComPDFKit license is bound to a specific applicationId--><!-- For example: com.compdfkit.pdfviewer--><meta-dataandroid:name="compdfkit_key"android:value="Your ComPDFKit Key" />

CPDFSdk.init(context,"your compdfkit license");

Add Proguard Rules

-keep class com.compdfkit.ui.** {*;}-keep class com.compdfkit.core.** {*;}

Display a PDF Document

<!-- Your activity_main.xml file--><?xml version="1.0" encoding="utf-8"?><androidx.constraintlayout.widget.ConstraintLayoutxmlns:android="http://schemas.android.com/apk/res/android"xmlns:app="http://schemas.android.com/apk/res-auto"xmlns:tools="http://schemas.android.com/tools"android:layout_width="match_parent"android:layout_height="match_parent"tools:context=".MainActivity"><!-- Create a CPDFReaderView-->    <com.compdfkit.ui.reader.CPDFReaderViewandroid:id="@+id/readerview"android:layout_width="match_parent"android:layout_height="match_parent" /></androidx.constraintlayout.widget.ConstraintLayout>

// Your MainActivity.java filepackagecom.compdfkit.pdfviewer;importandroidx.appcompat.app.AppCompatActivity;importandroid.os.Bundle;importcom.compdfkit.ui.reader.CPDFReaderView;publicclassMainActivityextendsAppCompatActivity {@OverrideprotectedvoidonCreate(BundlesavedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);// Get CPDFReaderView from xml.CPDFReaderViewreaderView =findViewById(R.id.readerview);// Code to create CPDFReaderView.// CPDFDocument readerView = new CPDFReaderView(content);    }}

// Your MainActivity.java file...//importspublicclassMainActivityextendsAppCompatActivity {// Copy the PDF file from the assets folder to the cache folder.privatevoidcopyPdfFromAssetsToCache(StringfileName) {try {InputStreaminputStream =getAssets().open(fileName);FileoutputFile =newFile(getCacheDir(),fileName);FileOutputStreamoutputStream =newFileOutputStream(outputFile);byte[]buffer =newbyte[1024];intbytesRead;while ((bytesRead =inputStream.read(buffer)) != -1) {outputStream.write(buffer,0,bytesRead);            }inputStream.close();outputStream.flush();outputStream.close();        }catch (IOExceptione) {e.printStackTrace();        }    }@OverrideprotectedvoidonCreate(BundlesavedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);CPDFReaderViewreaderView =findViewById(R.id.readerview);// Code to create CPDFReaderView.// CPDFDocument readerView = new CPDFReaderView(content);//Create a document object.CPDFDocumentdocument =newCPDFDocument(this);newThread(() -> {StringfileName ="Quick Start Guide.pdf";copyPdfFromAssetsToCache(fileName);Filefile =newFile(getCacheDir(),fileName);StringfilePath =file.getAbsolutePath();//Open document.CPDFDocument.PDFDocumentErrorerror =document.open(filePath);if (error ==CPDFDocument.PDFDocumentError.PDFDocumentErrorPassword) {//The document is encrypted and requires a password to open.error =document.open(filePath,"password");            }if (error ==CPDFDocument.PDFDocumentError.PDFDocumentErrorSuccess) {//The document is opened successfully and data can be parsed and manipulated.            }else {//The PDF file failed to open. You can refer to the API file for specific error            }        }).start();    }}

// Your MainActivity.java file...// importspublicclassMainActivityextendsAppCompatActivity {// Create a handler to run the code on the main thread.privateHandlermainThreadHandler =newHandler(Looper.getMainLooper());...if (error ==CPDFDocument.PDFDocumentError.PDFDocumentErrorSuccess) {// The document is opened successfully and data can be parsed and manipulated.mainThreadHandler.post(() -> {// Set the document content for UI.readerView.setPDFDocument(document);        });    }else {// The PDF file failed to open. You can refer to the API file for specific error    }...}

// Your MainActivity.java file...// importspublicclassMainActivityextendsAppCompatActivity {// Create a handler to run the code on the main thread.privateHandlermainThreadHandler =newHandler(Looper.getMainLooper());// Copy the PDF file from the assets folder to the cache folder.privatevoidcopyPdfFromAssetsToCache(StringfileName) {try {InputStreaminputStream =getAssets().open(fileName);FileoutputFile =newFile(getCacheDir(),fileName);FileOutputStreamoutputStream =newFileOutputStream(outputFile);byte[]buffer =newbyte[1024];intbytesRead;while ((bytesRead =inputStream.read(buffer)) != -1) {outputStream.write(buffer,0,bytesRead);            }inputStream.close();outputStream.flush();outputStream.close();        }catch (IOExceptione) {e.printStackTrace();        }    }@OverrideprotectedvoidonCreate(BundlesavedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);CPDFReaderViewreaderView =findViewById(R.id.readerview);//Create a document object.CPDFDocumentdocument =newCPDFDocument(this);newThread(() -> {StringfileName ="Quick Start Guide.pdf";copyPdfFromAssetsToCache(fileName);Filefile =newFile(getCacheDir(),fileName);StringfilePath =file.getAbsolutePath();//Open document.CPDFDocument.PDFDocumentErrorerror =document.open(filePath);if (error ==CPDFDocument.PDFDocumentError.PDFDocumentErrorPassword) {//The document is encrypted and requires a password to open.error =document.open(filePath,"password");            }if (error ==CPDFDocument.PDFDocumentError.PDFDocumentErrorSuccess) {//The document is opened successfully and data can be parsed and manipulated.mainThreadHandler.post(() -> {//Set the document to the reader view.readerView.setPDFDocument(document);                });            }else {//The PDF file failed to open. You can refer to the API file for specific error            }        }).start();    }}

<!-- Your activity_main.xml file--><?xml version="1.0" encoding="utf-8"?><androidx.constraintlayout.widget.ConstraintLayoutxmlns:android="http://schemas.android.com/apk/res/android"xmlns:app="http://schemas.android.com/apk/res-auto"xmlns:tools="http://schemas.android.com/tools"android:layout_width="match_parent"android:layout_height="match_parent"tools:context=".MainActivity">    <com.compdfkit.ui.reader.CPDFReaderViewandroid:id="@+id/readerview"android:layout_width="match_parent"android:layout_height="match_parent" /></androidx.constraintlayout.widget.ConstraintLayout>

Support

License