11 |
12 |
13 |
14 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Fri Jun 18 17:51:01 IST 2021
2 | distributionBase=GRADLE_USER_HOME
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-bin.zip
4 | distributionPath=wrapper/dists
5 | zipStorePath=wrapper/dists
6 | zipStoreBase=GRADLE_USER_HOME
7 |
--------------------------------------------------------------------------------
/sample/src/main/res/mipmap-anydpi-v26/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/sample/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/.idea/misc.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
--------------------------------------------------------------------------------
/sample/src/main/java/io/github/mddanishansari/sample/html_to_pdf/PdfProvider.kt:
--------------------------------------------------------------------------------
1 | package io.github.mddanishansari.sample.html_to_pdf
2 |
3 | import androidx.core.content.FileProvider
4 |
5 | /**
6 | * We need this class for android.support.v4.content.FileProvider
7 | * Since Android Nougat we need this to be declared in AndroidManifest.xml
8 | * in order to open PDF file in another application
9 | */
10 | class PdfProvider : FileProvider()
--------------------------------------------------------------------------------
/sample/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #FFBB86FC
4 | #FF6200EE
5 | #FF3700B3
6 | #FF03DAC5
7 | #FF018786
8 | #FF000000
9 | #FFFFFFFF
10 |
--------------------------------------------------------------------------------
/html-to-pdf-convertor/src/test/java/io/github/mddanishansari/html_to_pdf/ExampleUnitTest.kt:
--------------------------------------------------------------------------------
1 | package io.github.mddanishansari.html_to_pdf
2 |
3 | import org.junit.Test
4 |
5 | import org.junit.Assert.*
6 |
7 | /**
8 | * Example local unit test, which will execute on the development machine (host).
9 | *
10 | * See [testing documentation](http://d.android.com/tools/testing).
11 | */
12 | class ExampleUnitTest {
13 | @Test
14 | fun addition_isCorrect() {
15 | assertEquals(4, 2 + 2)
16 | }
17 | }
--------------------------------------------------------------------------------
/sample/src/test/java/io/github/mddanishansari/sample/html_to_pdf/ExampleUnitTest.kt:
--------------------------------------------------------------------------------
1 | package io.github.mddanishansari.sample.html_to_pdf
2 |
3 | import org.junit.Test
4 |
5 | import org.junit.Assert.*
6 |
7 | /**
8 | * Example local unit test, which will execute on the development machine (host).
9 | *
10 | * See [testing documentation](http://d.android.com/tools/testing).
11 | */
12 | class ExampleUnitTest {
13 | @Test
14 | fun addition_isCorrect() {
15 | assertEquals(4, 2 + 2)
16 | }
17 | }
--------------------------------------------------------------------------------
/.github/workflows/android.yml:
--------------------------------------------------------------------------------
1 | name: Android CI
2 |
3 | on:
4 | push:
5 | branches: [ "main" ]
6 | pull_request:
7 | branches: [ "main" ]
8 |
9 | jobs:
10 | build:
11 |
12 | runs-on: ubuntu-latest
13 |
14 | steps:
15 | - uses: actions/checkout@v3
16 | - name: set up JDK 11
17 | uses: actions/setup-java@v3
18 | with:
19 | java-version: '11'
20 | distribution: 'temurin'
21 | cache: gradle
22 |
23 | - name: Grant execute permission for gradlew
24 | run: chmod +x gradlew
25 | - name: Build with Gradle
26 | run: ./gradlew build
27 |
--------------------------------------------------------------------------------
/sample/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/html-to-pdf-convertor/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
--------------------------------------------------------------------------------
/html-to-pdf-convertor/src/androidTest/java/io/github/mddanishansari/html_to_pdf/ExampleInstrumentedTest.kt:
--------------------------------------------------------------------------------
1 | package io.github.mddanishansari.html_to_pdf
2 |
3 | import androidx.test.platform.app.InstrumentationRegistry
4 | import androidx.test.ext.junit.runners.AndroidJUnit4
5 |
6 | import org.junit.Test
7 | import org.junit.runner.RunWith
8 |
9 | import org.junit.Assert.*
10 |
11 | /**
12 | * Instrumented test, which will execute on an Android device.
13 | *
14 | * See [testing documentation](http://d.android.com/tools/testing).
15 | */
16 | @RunWith(AndroidJUnit4::class)
17 | class ExampleInstrumentedTest {
18 | @Test
19 | fun useAppContext() {
20 | // Context of the app under test.
21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext
22 | assertEquals("io.github.mddanishansari.html_to_pdf.test", appContext.packageName)
23 | }
24 | }
--------------------------------------------------------------------------------
/sample/src/androidTest/java/io/github/mddanishansari/sample/html_to_pdf/ExampleInstrumentedTest.kt:
--------------------------------------------------------------------------------
1 | package io.github.mddanishansari.sample.html_to_pdf
2 |
3 | import androidx.test.platform.app.InstrumentationRegistry
4 | import androidx.test.ext.junit.runners.AndroidJUnit4
5 |
6 | import org.junit.Test
7 | import org.junit.runner.RunWith
8 |
9 | import org.junit.Assert.*
10 |
11 | /**
12 | * Instrumented test, which will execute on an Android device.
13 | *
14 | * See [testing documentation](http://d.android.com/tools/testing).
15 | */
16 | @RunWith(AndroidJUnit4::class)
17 | class ExampleInstrumentedTest {
18 | @Test
19 | fun useAppContext() {
20 | // Context of the app under test.
21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext
22 | assertEquals("io.github.mddanishansari.sample.pdf_generator", appContext.packageName)
23 | }
24 | }
--------------------------------------------------------------------------------
/sample/src/main/res/values/themes.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
16 |
--------------------------------------------------------------------------------
/sample/src/main/res/values-night/themes.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
16 |
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 | # IDE (e.g. Android Studio) users:
3 | # Gradle settings configured through the IDE *will override*
4 | # any settings specified in this file.
5 | # For more details on how to configure your build environment visit
6 | # http://www.gradle.org/docs/current/userguide/build_environment.html
7 | # Specifies the JVM arguments used for the daemon process.
8 | # The setting is particularly useful for tweaking memory settings.
9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8
10 | # When configured, Gradle will run in incubating parallel mode.
11 | # This option should only be used with decoupled projects. More details, visit
12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
13 | # org.gradle.parallel=true
14 | # AndroidX package structure to make it clearer which packages are bundled with the
15 | # Android operating system, and which are packaged with your app"s APK
16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn
17 | android.useAndroidX=true
18 | # Kotlin code style for this project: "official" or "obsolete":
19 | kotlin.code.style=official
--------------------------------------------------------------------------------
/.idea/androidTestResultsUserPreferences.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
34 |
35 |
--------------------------------------------------------------------------------
/sample/src/main/res/layout/activity_main.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
9 |
18 |
19 |
28 |
29 |
--------------------------------------------------------------------------------
/.idea/jarRepositories.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
--------------------------------------------------------------------------------
/sample/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
13 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
28 |
31 |
32 |
33 |
34 |
--------------------------------------------------------------------------------
/.github/workflows/publish.yml:
--------------------------------------------------------------------------------
1 | name: Publish
2 |
3 | on:
4 | release:
5 | # We'll run this workflow when a new GitHub release is created
6 | types: [published]
7 |
8 | jobs:
9 | publish:
10 | name: Release build and publish
11 | runs-on: ubuntu-latest
12 | steps:
13 | - name: Check out code
14 | uses: actions/checkout@v2
15 | - name: Set up JDK 11
16 | uses: actions/setup-java@v2
17 | with:
18 | distribution: adopt
19 | java-version: 11
20 |
21 | # Builds the release artifacts of the library
22 | - name: Release build
23 | run: ./gradlew :html-to-pdf-convertor:assembleRelease
24 |
25 | # Generates other artifacts (javadocJar is optional)
26 | - name: Source jar and dokka
27 | run: ./gradlew androidSourcesJar javadocJar
28 |
29 | # Runs upload, and then closes & releases the repository
30 | - name: Publish to MavenCentral
31 | run: ./gradlew publishReleasePublicationToSonatypeRepository -Dversion=$GITHUB_REF_NAME --max-workers 1 closeAndReleaseSonatypeStagingRepository
32 | env:
33 | OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
34 | OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
35 | SIGNING_KEY_ID: ${{ secrets.SIGNING_KEY_ID }}
36 | SIGNING_PASSWORD: ${{ secrets.SIGNING_PASSWORD }}
37 | SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
38 | SONATYPE_STAGING_PROFILE_ID: ${{ secrets.SONATYPE_STAGING_PROFILE_ID }}
39 |
--------------------------------------------------------------------------------
/html-to-pdf-convertor/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'com.android.library'
3 | id 'kotlin-android'
4 | }
5 |
6 | ext {
7 | PUBLISH_GROUP_ID = "io.github.mddanishansari"
8 | PUBLISH_VERSION = System.getProperty("version")
9 | PUBLISH_ARTIFACT_ID = "html-to-pdf-convertor"
10 | }
11 |
12 | apply from: "${rootDir}/scripts/publish-module.gradle"
13 |
14 | android {
15 | compileSdk 33
16 |
17 | defaultConfig {
18 | minSdk 19
19 | targetSdk 33
20 |
21 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
22 | consumerProguardFiles "consumer-rules.pro"
23 | }
24 |
25 | buildTypes {
26 | release {
27 | minifyEnabled false
28 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
29 | }
30 | }
31 |
32 | compileOptions {
33 | sourceCompatibility JavaVersion.VERSION_1_8
34 | targetCompatibility JavaVersion.VERSION_1_8
35 | }
36 |
37 | kotlinOptions {
38 | jvmTarget = '1.8'
39 | }
40 |
41 | lintOptions {
42 | abortOnError false
43 | }
44 |
45 | namespace 'io.github.mddanishansari.html_to_pdf'
46 | }
47 |
48 | dependencies {
49 | testImplementation 'junit:junit:4.13.2'
50 |
51 | androidTestImplementation 'androidx.test.ext:junit:1.1.4'
52 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.0'
53 |
54 | implementation 'androidx.core:core-ktx:1.9.0'
55 | }
--------------------------------------------------------------------------------
/sample/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'com.android.application'
3 | id 'kotlin-android'
4 | }
5 |
6 | android {
7 | compileSdk 33
8 |
9 | defaultConfig {
10 | applicationId "io.github.mddanishansari.sample.pdf_generator"
11 | minSdk 19
12 | targetSdk 33
13 | versionCode 1
14 | versionName "1.0"
15 |
16 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
17 | }
18 |
19 | buildTypes {
20 | release {
21 | minifyEnabled false
22 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
23 | }
24 | }
25 |
26 | compileOptions {
27 | sourceCompatibility JavaVersion.VERSION_1_8
28 | targetCompatibility JavaVersion.VERSION_1_8
29 | }
30 |
31 | kotlinOptions {
32 | jvmTarget = '1.8'
33 | }
34 |
35 | buildFeatures {
36 | viewBinding true
37 | }
38 |
39 | lintOptions {
40 | abortOnError false
41 | }
42 |
43 | namespace 'io.github.mddanishansari.sample.html_to_pdf'
44 | }
45 |
46 | dependencies {
47 | testImplementation 'junit:junit:4.13.2'
48 |
49 | androidTestImplementation 'androidx.test.ext:junit:1.1.4'
50 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.0'
51 |
52 | implementation 'androidx.core:core-ktx:1.9.0'
53 | implementation 'com.google.android.material:material:1.7.0'
54 | implementation project(path: ':html-to-pdf-convertor')
55 | }
--------------------------------------------------------------------------------
/scripts/publish-root.gradle:
--------------------------------------------------------------------------------
1 | // Create variables with empty default values
2 | ext["ossrhUsername"] = ''
3 | ext["ossrhPassword"] = ''
4 | ext["sonatypeStagingProfileId"] = ''
5 | ext["signing.keyId"] = ''
6 | ext["signing.password"] = ''
7 | ext["signing.secretKeyRingFile"] = ''
8 |
9 | File secretPropsFile = project.rootProject.file('local.properties')
10 | if (secretPropsFile.exists()) {
11 | // Read local.properties file first if it exists
12 | Properties p = new Properties()
13 | new FileInputStream(secretPropsFile).withCloseable { is -> p.load(is) }
14 | p.each { name, value -> ext[name] = value }
15 | } else {
16 | // Use system environment variables
17 | ext["ossrhUsername"] = System.getenv('OSSRH_USERNAME')
18 | ext["ossrhPassword"] = System.getenv('OSSRH_PASSWORD')
19 | ext["sonatypeStagingProfileId"] = System.getenv('SONATYPE_STAGING_PROFILE_ID')
20 | ext["signing.keyId"] = System.getenv('SIGNING_KEY_ID')
21 | ext["signing.password"] = System.getenv('SIGNING_PASSWORD')
22 | ext["signing.key"] = System.getenv('SIGNING_KEY')
23 | }
24 |
25 | // Set up Sonatype repository
26 | nexusPublishing {
27 | repositories {
28 | sonatype {
29 | stagingProfileId = sonatypeStagingProfileId
30 | username = ossrhUsername
31 | password = ossrhPassword
32 | nexusUrl.set(uri("https://s01.oss.sonatype.org/service/local/"))
33 | snapshotRepositoryUrl.set(uri("https://s01.oss.sonatype.org/content/repositories/snapshots/"))
34 | }
35 | }
36 | }
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Built application files
2 | *.apk
3 | *.aar
4 | *.ap_
5 | *.aab
6 |
7 | # Files for the ART/Dalvik VM
8 | *.dex
9 |
10 | # Java class files
11 | *.class
12 |
13 | # Generated files
14 | bin/
15 | gen/
16 | out/
17 | # Uncomment the following line in case you need and you don't have the release build type files in your app
18 | # release/
19 |
20 | # Gradle files
21 | .gradle/
22 | build/
23 |
24 | # Local configuration file (sdk path, etc)
25 | local.properties
26 |
27 | # Proguard folder generated by Eclipse
28 | proguard/
29 |
30 | # Log Files
31 | *.log
32 |
33 | # Android Studio Navigation editor temp files
34 | .navigation/
35 |
36 | # Android Studio captures folder
37 | captures/
38 |
39 | # IntelliJ
40 | *.iml
41 | .idea/workspace.xml
42 | .idea/tasks.xml
43 | .idea/gradle.xml
44 | .idea/assetWizardSettings.xml
45 | .idea/dictionaries
46 | .idea/libraries
47 | # Android Studio 3 in .gitignore file.
48 | .idea/caches
49 | .idea/modules.xml
50 | # Comment next line if keeping position of elements in Navigation Editor is relevant for you
51 | .idea/navEditor.xml
52 |
53 | # Keystore files
54 | # Uncomment the following lines if you do not want to check your keystore files in.
55 | #*.jks
56 | #*.keystore
57 |
58 | # External native build folder generated in Android Studio 2.2 and later
59 | .externalNativeBuild
60 | .cxx/
61 |
62 | # Google Services (e.g. APIs or Firebase)
63 | # google-services.json
64 |
65 | # Freeline
66 | freeline.py
67 | freeline/
68 | freeline_project_description.json
69 |
70 | # fastlane
71 | fastlane/report.xml
72 | fastlane/Preview.html
73 | fastlane/screenshots
74 | fastlane/test_output
75 | fastlane/readme.md
76 |
77 | # Version control
78 | vcs.xml
79 |
80 | # lint
81 | lint/intermediates/
82 | lint/generated/
83 | lint/outputs/
84 | lint/tmp/
85 | # lint/reports/
86 |
--------------------------------------------------------------------------------
/sample/src/main/res/drawable-v24/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
7 |
8 |
9 |
15 |
18 |
21 |
22 |
23 |
24 |
30 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # HTML to PDF Convertor
2 | A simple HTML to PDF convertor for Android
3 |
4 | ## Download
5 |
6 | Add `mavenCentral()` repository in project's `build.gradle`
7 |
8 | ```gradle
9 | allprojects {
10 | repositories {
11 | // Possibly other repositories
12 | mavenCentral()
13 | }
14 | }
15 | ```
16 |
17 | Add dependency in module's `build.gradle`
18 |
19 | ```gradle
20 | dependencies {
21 | // Possibly other dependencies
22 | // Replace the with actual latest version
23 | implementation 'io.github.mddanishansari:html-to-pdf-convertor:'
24 | }
25 | ```
26 |
27 |
28 |
29 |
30 | ## Usage
31 |
32 | Create an instance of `HtmlToPdfConvertor` class
33 | ```kotlin
34 | val htmlToPdfConvertor = HtmlToPdfConvertor(context)
35 | ```
36 |
37 | Set optional base URL
38 | ```kotlin
39 | htmlToPdfConvertor.setBaseUrl("file:///android_asset/images/") // is null by default
40 | ```
41 |
42 | To generate dynamic content using JS
43 | ```kotlin
44 | htmlToPdfConvertor.setJavaScriptEnabled(true)
45 | ```
46 |
47 |
48 | Start the conversion by calling `convert` function
49 |
50 | ```kotlin
51 | htmlToPdfConvertor.convert(
52 | pdfLocation = pdfLocation, // the file location where pdf should be saved
53 | htmlString = htmlString, // the HTML string to be converted
54 | onPdfGenerationFailed = { exception -> // something went wrong, handle the exception (this param is optional)
55 | exception.printStackTrace()
56 | },
57 | onPdfGenerated = { pdfFile -> // pdf was generated, do whatever you want with it
58 | openPdf(pdfFile)
59 | })
60 | ```
61 |
62 | > Storage permission is required to save pdf file on storage
63 |
64 | Checkout [sample code](sample/src/main/java/io/github/mddanishansari/sample/html_to_pdf/MainActivity.kt#L64), also sample [HTML](assets/html_input.html) and [PDF](assets/pdf_output.pdf)
65 |
--------------------------------------------------------------------------------
/html-to-pdf-convertor/src/main/java/android/print/PdfPrinter.kt:
--------------------------------------------------------------------------------
1 | package android.print
2 |
3 | import android.os.CancellationSignal
4 | import android.os.ParcelFileDescriptor
5 | import android.print.PrintDocumentAdapter.LayoutResultCallback
6 | import android.print.PrintDocumentAdapter.WriteResultCallback
7 | import java.io.File
8 | import java.io.IOException
9 |
10 | class PdfPrinter(private val printAttributes: PrintAttributes) {
11 | fun generate(
12 | printAdapter: PrintDocumentAdapter,
13 | path: File,
14 | onPdfGenerated: (File) -> Unit
15 | ) {
16 |
17 | if (path.exists()) {
18 | path.delete()
19 | }
20 | try {
21 | printAdapter.onLayout(null, printAttributes, null, object : LayoutResultCallback() {
22 | override fun onLayoutFinished(info: PrintDocumentInfo, changed: Boolean) {
23 | printAdapter.onWrite(
24 | arrayOf(PageRange.ALL_PAGES),
25 | getOutputFile(path),
26 | CancellationSignal(),
27 | object : WriteResultCallback() {
28 | override fun onWriteFinished(pages: Array) {
29 | super.onWriteFinished(pages)
30 | onPdfGenerated(path)
31 | }
32 | })
33 | }
34 | }, null)
35 | } catch (e: Exception) {
36 | throw e
37 | }
38 | }
39 |
40 | private fun getOutputFile(file: File): ParcelFileDescriptor? {
41 | val fileDirectory = file.parentFile
42 | if (fileDirectory != null && !fileDirectory.exists()) {
43 | fileDirectory.mkdirs()
44 | }
45 | try {
46 | file.createNewFile()
47 | return ParcelFileDescriptor.open(file, ParcelFileDescriptor.MODE_READ_WRITE)
48 | } catch (e: IOException) {
49 | throw e
50 | }
51 | }
52 |
53 | interface OnPdfGeneratedListener {
54 | fun onPdfGenerated(pdfFilePath: File)
55 | }
56 | }
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/scripts/publish-module.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'maven-publish'
2 | apply plugin: 'signing'
3 |
4 | task androidSourcesJar(type: Jar) {
5 | archiveClassifier.set('sources')
6 | if (project.plugins.findPlugin("com.android.library")) {
7 | // For Android libraries
8 | from android.sourceSets.main.java.srcDirs
9 | from android.sourceSets.main.kotlin.srcDirs
10 | } else {
11 | // For pure Kotlin libraries, in case you have them
12 | from sourceSets.main.java.srcDirs
13 | from sourceSets.main.kotlin.srcDirs
14 | }
15 | }
16 |
17 | tasks.withType(Javadoc).all {
18 | enabled = false
19 | }
20 |
21 | task javadoc(type: Javadoc) {
22 | failOnError false
23 | options.addStringOption('Xdoclint:none', '-quiet')
24 | options.addStringOption('encoding', 'UTF-8')
25 | options.addStringOption('charSet', 'UTF-8')
26 | source = android.sourceSets.main.java.srcDirs
27 | classpath += project.files(android.getBootClasspath().join(File.pathSeparator))
28 | }
29 |
30 | task javadocJar(type: Jar, dependsOn: javadoc) {
31 | from javadoc.destinationDir
32 | archiveClassifier.set("javadoc")
33 | }
34 |
35 | artifacts {
36 | archives javadocJar
37 | archives androidSourcesJar
38 | }
39 |
40 | group = PUBLISH_GROUP_ID
41 | version = PUBLISH_VERSION
42 |
43 | afterEvaluate {
44 | publishing {
45 | publications {
46 | release(MavenPublication) {
47 | groupId PUBLISH_GROUP_ID
48 | artifactId PUBLISH_ARTIFACT_ID
49 | version PUBLISH_VERSION
50 | if (project.plugins.findPlugin("com.android.library")) {
51 | from components.release
52 | } else {
53 | from components.java
54 | }
55 |
56 | artifact androidSourcesJar
57 | artifact javadocJar
58 |
59 | pom {
60 | name = PUBLISH_ARTIFACT_ID
61 | description = 'HTML to PDF convertor for Android'
62 | url = 'https://github.com/mddanishansari/html-to-pdf-convertor'
63 | licenses {
64 | license {
65 | name = 'Apache License 2.0'
66 | url = 'https://github.com/mddanishansari/html-to-pdf-convertor/blob/main/LICENSE'
67 | }
68 | }
69 | developers {
70 | developer {
71 | id = 'danishansari'
72 | name = 'Danish Ansari'
73 | email = 'ansarid567@gmail.com'
74 | }
75 | }
76 | scm {
77 | connection = 'scm:git:github.com/mddanishansari/html-to-pdf-convertor.git'
78 | developerConnection = 'scm:git:ssh://github.com/mddanishansari/html-to-pdf-convertor.git'
79 | url = 'https://github.com/mddanishansari/html-to-pdf-convertor/tree/main'
80 | }
81 | }
82 | }
83 | }
84 | }
85 | }
86 |
87 | ext["signing.keyId"] = rootProject.ext["signing.keyId"]
88 | ext["signing.password"] = rootProject.ext["signing.password"]
89 | ext["signing.secretKeyRingFile"] = rootProject.ext["signing.secretKeyRingFile"]
90 |
91 | signing {
92 | useInMemoryPgpKeys(
93 | rootProject.ext["signing.keyId"],
94 | rootProject.ext["signing.key"],
95 | rootProject.ext["signing.password"],
96 | )
97 | sign publishing.publications
98 | }
--------------------------------------------------------------------------------
/html-to-pdf-convertor/src/main/java/io/github/mddanishansari/html_to_pdf/HtmlToPdfConvertor.kt:
--------------------------------------------------------------------------------
1 | package io.github.mddanishansari.html_to_pdf
2 |
3 | import android.content.Context
4 | import android.os.Build
5 | import android.print.PdfPrinter
6 | import android.print.PrintAttributes
7 | import android.print.PrintAttributes.Resolution
8 | import android.print.PrintDocumentAdapter
9 | import android.webkit.WebChromeClient
10 | import android.webkit.WebView
11 | import androidx.annotation.UiThread
12 | import java.io.File
13 |
14 | class HtmlToPdfConvertor(private val context: Context) {
15 |
16 | private var baseUrl: String? = null
17 | private var enableJavascript: Boolean? = null
18 |
19 | fun setBaseUrl(baseUrl: String) {
20 | this.baseUrl = baseUrl
21 | }
22 |
23 | fun setJavaScriptEnabled(flag: Boolean) {
24 | this.enableJavascript = flag
25 | }
26 |
27 | @UiThread
28 | fun convert(
29 | pdfLocation: File,
30 | htmlString: String,
31 | onPdfGenerationFailed: PdfGenerationFailedCallback? = null,
32 | onPdfGenerated: PdfGeneratedCallback,
33 | ) {
34 |
35 | // maintain pdf generation status
36 | var pdfGenerationStarted = false
37 | try {
38 |
39 | // create new webview
40 | val pdfWebView = WebView(context)
41 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
42 | pdfWebView.settings.safeBrowsingEnabled = false
43 | }
44 |
45 | // set webview enable/ disable javascript property
46 | enableJavascript?.let { pdfWebView.settings.javaScriptEnabled = it }
47 |
48 | // job name
49 | val jobName = Math.random().toString()
50 |
51 | // generate pdf attributes and properties
52 | val attributes = getPrintAttributes()
53 |
54 | // generate print document adapter
55 | val printAdapter = getPrintAdapter(pdfWebView, jobName)
56 |
57 | pdfWebView.webChromeClient = object : WebChromeClient() {
58 | override fun onProgressChanged(view: WebView, newProgress: Int) {
59 | super.onProgressChanged(view, newProgress)
60 |
61 | // some times progress provided by this method is wrong, that's why we are getting progress directly provided by WebView
62 | val progress = pdfWebView.progress
63 |
64 |
65 | // when page is fully loaded, start creating PDF
66 | if (progress == 100 && !pdfGenerationStarted) {
67 |
68 | // change the status of pdf generation
69 | pdfGenerationStarted = true
70 |
71 | // generate pdf
72 | val pdfPrinter = PdfPrinter(attributes)
73 | pdfPrinter.generate(printAdapter, pdfLocation, onPdfGenerated)
74 | }
75 | }
76 | }
77 |
78 | // load html in WebView when it's setup is completed
79 | pdfWebView.loadDataWithBaseURL(baseUrl, htmlString, "text/html", "utf-8", null)
80 |
81 | } catch (e: Exception) {
82 | onPdfGenerationFailed?.invoke(e)
83 | }
84 | }
85 |
86 |
87 | private fun getPrintAdapter(pdfWebView: WebView, jobName: String): PrintDocumentAdapter {
88 | return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP) {
89 | pdfWebView.createPrintDocumentAdapter(jobName)
90 | } else {
91 | pdfWebView.createPrintDocumentAdapter()
92 | }
93 | }
94 |
95 | private fun getPrintAttributes(pdfPageSize: PrintAttributes.MediaSize = PrintAttributes.MediaSize.ISO_A4): PrintAttributes {
96 | return PrintAttributes.Builder().apply {
97 | setMediaSize(pdfPageSize)
98 | setResolution(Resolution("pdf", Context.PRINT_SERVICE, 600, 600))
99 | setMinMargins(PrintAttributes.Margins.NO_MARGINS)
100 | }.build()
101 | }
102 | }
103 |
104 | private typealias PdfGeneratedCallback = (File) -> Unit
105 | private typealias PdfGenerationFailedCallback = (Exception) -> Unit
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/sample/src/main/java/io/github/mddanishansari/sample/html_to_pdf/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package io.github.mddanishansari.sample.html_to_pdf
2 |
3 | import android.Manifest
4 | import android.content.ActivityNotFoundException
5 | import android.content.Intent
6 | import android.content.pm.PackageManager
7 | import android.os.Build
8 | import android.os.Bundle
9 | import android.os.Environment
10 | import android.widget.Toast
11 | import androidx.appcompat.app.AppCompatActivity
12 | import androidx.core.content.FileProvider
13 | import androidx.core.view.isVisible
14 | import io.github.mddanishansari.html_to_pdf.HtmlToPdfConvertor
15 | import io.github.mddanishansari.sample.html_to_pdf.databinding.ActivityMainBinding
16 | import java.io.File
17 |
18 | class MainActivity : AppCompatActivity() {
19 | private lateinit var htmlToPdfConvertor: HtmlToPdfConvertor
20 | private lateinit var binding: ActivityMainBinding
21 |
22 | override fun onCreate(savedInstanceState: Bundle?) {
23 | super.onCreate(savedInstanceState)
24 | binding = ActivityMainBinding.inflate(layoutInflater)
25 | setContentView(binding.root)
26 |
27 | // initialize HtmlToPdfConvertor
28 | htmlToPdfConvertor = HtmlToPdfConvertor(this)
29 |
30 | // set base url
31 | htmlToPdfConvertor.setBaseUrl("file:///android_asset/images/")
32 |
33 | binding.btnConvert.setOnClickListener {
34 | if (shouldAskPermission()) {
35 | requestPermissions(
36 | arrayOf(Manifest.permission.WRITE_EXTERNAL_STORAGE),
37 | STORAGE_PERMISSION_REQUEST
38 | )
39 | } else {
40 | convertHtmlToPdf()
41 | }
42 | }
43 | }
44 |
45 | override fun onRequestPermissionsResult(
46 | requestCode: Int,
47 | permissions: Array,
48 | grantResults: IntArray
49 | ) {
50 | super.onRequestPermissionsResult(requestCode, permissions, grantResults)
51 | if (requestCode == STORAGE_PERMISSION_REQUEST) {
52 | if (grantResults.isNotEmpty() && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
53 | convertHtmlToPdf()
54 | } else {
55 | Toast.makeText(
56 | this,
57 | "Storage permission denied, enabled it from settings",
58 | Toast.LENGTH_SHORT
59 | ).show()
60 | }
61 | }
62 | }
63 |
64 | private fun convertHtmlToPdf() {
65 | // start loading
66 | binding.loader.isVisible = true
67 |
68 | // define output file location and html content
69 | val pdfLocation = File(getPdfFilePath(), "${System.currentTimeMillis()}.pdf")
70 | val htmlString = htmlContent()
71 |
72 | // start conversion
73 | htmlToPdfConvertor.convert(
74 | pdfLocation = pdfLocation,
75 | htmlString = htmlString,
76 | onPdfGenerationFailed = { exception ->
77 | // something went wrong, stop loading and log the exception
78 | binding.loader.isVisible = false
79 | exception.printStackTrace()
80 | Toast.makeText(this, "Check logs for error", Toast.LENGTH_SHORT).show()
81 | },
82 | onPdfGenerated = { pdfFile ->
83 | // pdf was generated, stop the loading and open it
84 | binding.loader.isVisible = false
85 | openPdf(pdfFile)
86 | })
87 | }
88 |
89 | private fun shouldAskPermission(): Boolean {
90 | return Build.VERSION.SDK_INT >= Build.VERSION_CODES.M &&
91 | checkSelfPermission(Manifest.permission.WRITE_EXTERNAL_STORAGE) != PackageManager.PERMISSION_GRANTED
92 | }
93 |
94 | private fun openPdf(pdfFilePath: File) {
95 | try {
96 | val path = FileProvider.getUriForFile(
97 | this,
98 | "$packageName.fileprovider",
99 | pdfFilePath
100 | )
101 | val pdfIntent = Intent(Intent.ACTION_VIEW)
102 | pdfIntent.addFlags(Intent.FLAG_GRANT_READ_URI_PERMISSION)
103 | pdfIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
104 | pdfIntent.setDataAndType(path, "application/pdf")
105 | startActivity(pdfIntent)
106 | } catch (e: ActivityNotFoundException) {
107 | e.printStackTrace()
108 | Toast.makeText(this, "No application found to open pdf file", Toast.LENGTH_SHORT).show()
109 | } catch (e: java.lang.Exception) {
110 | e.printStackTrace()
111 | Toast.makeText(
112 | this,
113 | "Unable to open ${pdfFilePath.name}, please try again later.",
114 | Toast.LENGTH_SHORT
115 | ).show()
116 | }
117 | }
118 |
119 | private fun getPdfFilePath(): File? {
120 | return when {
121 | Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q -> {
122 | getExternalFilesDir(Environment.DIRECTORY_DOCUMENTS)
123 | }
124 | Build.VERSION.SDK_INT >= Build.VERSION_CODES.KITKAT -> {
125 | Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOCUMENTS)
126 | }
127 | else -> {
128 | File(Environment.getExternalStorageDirectory().toString() + "/Documents/")
129 | }
130 | }
131 | }
132 |
133 | private fun htmlContent() =
134 | """
135 |
136 |
137 |
138 |
139 |
140 |
Image from assets
141 |
142 |
My First Heading
143 |
144 |
My first paragraph.
145 |
146 |
147 |
148 |
149 | """.trimIndent()
150 |
151 | companion object {
152 | const val STORAGE_PERMISSION_REQUEST = 1
153 | }
154 | }
--------------------------------------------------------------------------------
/sample/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
7 |
10 |
15 |
20 |
25 |
30 |
35 |
40 |
45 |
50 |
55 |
60 |
65 |
70 |
75 |
80 |
85 |
90 |
95 |
100 |
105 |
110 |
115 |
120 |
125 |
130 |
135 |
140 |
145 |
150 |
155 |
160 |
165 |
170 |
171 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
28 |
29 |
30 | ## Usage
31 |
32 | Create an instance of `HtmlToPdfConvertor` class
33 | ```kotlin
34 | val htmlToPdfConvertor = HtmlToPdfConvertor(context)
35 | ```
36 |
37 | Set optional base URL
38 | ```kotlin
39 | htmlToPdfConvertor.setBaseUrl("file:///android_asset/images/") // is null by default
40 | ```
41 |
42 | To generate dynamic content using JS
43 | ```kotlin
44 | htmlToPdfConvertor.setJavaScriptEnabled(true)
45 | ```
46 |
47 |
48 | Start the conversion by calling `convert` function
49 |
50 | ```kotlin
51 | htmlToPdfConvertor.convert(
52 | pdfLocation = pdfLocation, // the file location where pdf should be saved
53 | htmlString = htmlString, // the HTML string to be converted
54 | onPdfGenerationFailed = { exception -> // something went wrong, handle the exception (this param is optional)
55 | exception.printStackTrace()
56 | },
57 | onPdfGenerated = { pdfFile -> // pdf was generated, do whatever you want with it
58 | openPdf(pdfFile)
59 | })
60 | ```
61 |
62 | > Storage permission is required to save pdf file on storage
63 |
64 | Checkout [sample code](sample/src/main/java/io/github/mddanishansari/sample/html_to_pdf/MainActivity.kt#L64), also sample [HTML](assets/html_input.html) and [PDF](assets/pdf_output.pdf)
65 |
--------------------------------------------------------------------------------
/html-to-pdf-convertor/src/main/java/android/print/PdfPrinter.kt:
--------------------------------------------------------------------------------
1 | package android.print
2 |
3 | import android.os.CancellationSignal
4 | import android.os.ParcelFileDescriptor
5 | import android.print.PrintDocumentAdapter.LayoutResultCallback
6 | import android.print.PrintDocumentAdapter.WriteResultCallback
7 | import java.io.File
8 | import java.io.IOException
9 |
10 | class PdfPrinter(private val printAttributes: PrintAttributes) {
11 | fun generate(
12 | printAdapter: PrintDocumentAdapter,
13 | path: File,
14 | onPdfGenerated: (File) -> Unit
15 | ) {
16 |
17 | if (path.exists()) {
18 | path.delete()
19 | }
20 | try {
21 | printAdapter.onLayout(null, printAttributes, null, object : LayoutResultCallback() {
22 | override fun onLayoutFinished(info: PrintDocumentInfo, changed: Boolean) {
23 | printAdapter.onWrite(
24 | arrayOf(PageRange.ALL_PAGES),
25 | getOutputFile(path),
26 | CancellationSignal(),
27 | object : WriteResultCallback() {
28 | override fun onWriteFinished(pages: Array
142 |