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, and the PdfRenderer class cannot open it. In this sample, we work
20around this by copying the file into the cache directory.
21
22[1]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.html
23[2]: https://developer.android.com/reference/android/os/ParcelFileDescriptor.html
24[3]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.html#openPage(int)
25[4]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.Page.html#render(android.graphics.Bitmap,%20android.graphics.Rect,%20android.graphics.Matrix,%20int)
26[5]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.Page.html
27
28Pre-requisites
29--------------
30
31- Android SDK 27
32- Android Build Tools v27.0.2
33- Android Support Repository
34
35Screenshots
36-------------
37
38<img src="screenshots/main.png" height="400" alt="Screenshot"/>
39
40Getting Started
41---------------
42
43This sample uses the Gradle build system. To build this project, use the
44"gradlew build" command or use "Import Project" in Android Studio.
45
46Support
47-------
48
49- Google+ Community: https://plus.google.com/communities/105153134372062985968
50- Stack Overflow: http://stackoverflow.com/questions/tagged/android
51
52If you've found an error in this sample, please file an issue:
53https://github.com/googlesamples/android-PdfRendererBasic
54
55Patches are encouraged, and may be submitted by forking this project and
56submitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
57
58License
59-------
60
61Copyright 2017 The Android Open Source Project, Inc.
62
63Licensed to the Apache Software Foundation (ASF) under one or more contributor
64license agreements. See the NOTICE file distributed with this work for
65additional information regarding copyright ownership. The ASF licenses this
66file to you under the Apache License, Version 2.0 (the "License"); you may not
67use this file except in compliance with the License. You may obtain a copy of
68the License at
69
70http://www.apache.org/licenses/LICENSE-2.0
71
72Unless required by applicable law or agreed to in writing, software
73distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
74WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
75License for the specific language governing permissions and limitations under
76the License.
77
