xref: /aosp_15_r20/developers/build/prebuilts/gradle/PdfRendererBasic/kotlinApp/README.md (revision d353a188ca6ec4b5eba25b5fbd7bcb8ce61322fb)
1*d353a188SXin Li
2*d353a188SXin LiAndroid PdfRendererBasic Sample (Kotlin)
3*d353a188SXin Li========================================
4*d353a188SXin Li
5*d353a188SXin LiThis sample demonstrates how to display PDF document on screen using
6*d353a188SXin Lithe PdfRenderer introduced in Android 5.0 Lollipop.
7*d353a188SXin Li
8*d353a188SXin LiIntroduction
9*d353a188SXin Li------------
10*d353a188SXin Li
11*d353a188SXin LiYou can now render PDF document pages into bitmap images for printing by using
12*d353a188SXin Lithe new [PdfRenderer][1] class. You must specify a [ParcelFileDescriptor][2]
13*d353a188SXin Lithat is seekable (that is, the content can be randomly accessed) on which the
14*d353a188SXin Lisystem writes the the printable content. Your app can obtain a page for
15*d353a188SXin Lirendering with [openPage()][3], then call [render()][4] to turn the opened
16*d353a188SXin Li[PdfRenderer.Page][5] into a bitmap.
17*d353a188SXin Li
18*d353a188SXin LiThis sample loads the PDF from assets. Contents of assets are compressed by
19*d353a188SXin Lidefault, and the PdfRenderer class cannot open it. In this sample, we work
20*d353a188SXin Liaround this by copying the file into the cache directory.
21*d353a188SXin Li
22*d353a188SXin Li[1]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.html
23*d353a188SXin Li[2]: https://developer.android.com/reference/android/os/ParcelFileDescriptor.html
24*d353a188SXin Li[3]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.html#openPage(int)
25*d353a188SXin Li[4]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.Page.html#render(android.graphics.Bitmap,%20android.graphics.Rect,%20android.graphics.Matrix,%20int)
26*d353a188SXin Li[5]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.Page.html
27*d353a188SXin Li
28*d353a188SXin LiPre-requisites
29*d353a188SXin Li--------------
30*d353a188SXin Li
31*d353a188SXin Li- Android SDK 27
32*d353a188SXin Li- Android Support Repository
33*d353a188SXin Li
34*d353a188SXin LiScreenshots
35*d353a188SXin Li-------------
36*d353a188SXin Li
37*d353a188SXin Li<img src="screenshots/main.png" height="400" alt="Screenshot"/>
38*d353a188SXin Li
39*d353a188SXin LiGetting Started
40*d353a188SXin Li---------------
41*d353a188SXin Li
42*d353a188SXin LiThis sample uses the Gradle build system. To build this project, use the
43*d353a188SXin Li"gradlew build" command or use "Import Project" in Android Studio.
44*d353a188SXin Li
45*d353a188SXin LiSupport
46*d353a188SXin Li-------
47*d353a188SXin Li
48*d353a188SXin Li- Google+ Community: https://plus.google.com/communities/105153134372062985968
49*d353a188SXin Li- Stack Overflow: http://stackoverflow.com/questions/tagged/android
50*d353a188SXin Li
51*d353a188SXin LiIf you've found an error in this sample, please file an issue:
52*d353a188SXin Lihttps://github.com/googlesamples/android-PdfRendererBasic
53*d353a188SXin Li
54*d353a188SXin LiPatches are encouraged, and may be submitted by forking this project and
55*d353a188SXin Lisubmitting a pull request through GitHub. Please see CONTRIBUTING.md for more details.
56*d353a188SXin Li
57*d353a188SXin LiLicense
58*d353a188SXin Li-------
59*d353a188SXin Li
60*d353a188SXin LiCopyright 2017 The Android Open Source Project, Inc.
61*d353a188SXin Li
62*d353a188SXin LiLicensed to the Apache Software Foundation (ASF) under one or more contributor
63*d353a188SXin Lilicense agreements.  See the NOTICE file distributed with this work for
64*d353a188SXin Liadditional information regarding copyright ownership.  The ASF licenses this
65*d353a188SXin Lifile to you under the Apache License, Version 2.0 (the "License"); you may not
66*d353a188SXin Liuse this file except in compliance with the License.  You may obtain a copy of
67*d353a188SXin Lithe License at
68*d353a188SXin Li
69*d353a188SXin Lihttp://www.apache.org/licenses/LICENSE-2.0
70*d353a188SXin Li
71*d353a188SXin LiUnless required by applicable law or agreed to in writing, software
72*d353a188SXin Lidistributed under the License is distributed on an "AS IS" BASIS, WITHOUT
73*d353a188SXin LiWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
74*d353a188SXin LiLicense for the specific language governing permissions and limitations under
75*d353a188SXin Lithe License.
76