README.md
1
2Android PdfRendererBasic Sample
3===================================
4
5This sample demonstrates how to display PDF document on screen using
6the PdfRenderer introduced in Android 5.0 Lollipop.
7
8Introduction
9------------
10
11You can now render PDF document pages into bitmap images for printing by using
12the new [PdfRenderer][1] class. You must specify a [ParcelFileDescriptor][2]
13that is seekable (that is, the content can be randomly accessed) on which the
14system writes the the printable content. Your app can obtain a page for
15rendering with [openPage()][3], then call [render()][4] to turn the opened
16[PdfRenderer.Page][5] into a bitmap.
17
18This sample loads the PDF from assets. Contents of assets are compressed by
19default, but we disable it since PdfRenderer class cannot handle it.
20
21```groovy
22android {
23 aaptOptions {
24 noCompress "pdf"
25 }
26}
27```
28
29[1]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.html
30[2]: https://developer.android.com/reference/android/os/ParcelFileDescriptor.html
31[3]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.html#openPage(int)
32[4]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.Page.html#render(android.graphics.Bitmap, android.graphics.Rect, android.graphics.Matrix, int)
33[5]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.Page.html
34
35Pre-requisites
36--------------
37
38- Android SDK 21
39- Android Build Tools v23.0.3
40- Android Support Repository
41
42Screenshots
43-------------
44
45<img src="screenshots/main.png" height="400" alt="Screenshot"/>
46
47Getting Started
48---------------
49
50This sample uses the Gradle build system. To build this project, use the
51"gradlew build" command or use "Import Project" in Android Studio.
52
53Support
54-------
55
56- Google+ Community: https://plus.google.com/communities/105153134372062985968
57- Stack Overflow: http://stackoverflow.com/questions/tagged/android
58
59If you've found an error in this sample, please file an issue:
60https://github.com/googlesamples/android-PdfRendererBasic
61
62Patches are encouraged, and may be submitted by forking this project and
63submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
64
65License
66-------
67
68Copyright 2016 The Android Open Source Project, Inc.
69
70Licensed to the Apache Software Foundation (ASF) under one or more contributor
71license agreements. See the NOTICE file distributed with this work for
72additional information regarding copyright ownership. The ASF licenses this
73file to you under the Apache License, Version 2.0 (the "License"); you may not
74use this file except in compliance with the License. You may obtain a copy of
75the License at
76
77http://www.apache.org/licenses/LICENSE-2.0
78
79Unless required by applicable law or agreed to in writing, software
80distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
81WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
82License for the specific language governing permissions and limitations under
83the License.
84