blob: f8607b27c48289ebcb6387d19ba0974e74c5618c [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2014 The Android Open Source Project
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<sample>
<name>PdfRendererBasic</name>
<group>UI</group>
<package>com.example.android.pdfrendererbasic</package>
<!-- change minSdk if needed-->
<minSdk>21</minSdk>
<compileSdkVersion>21</compileSdkVersion>
<strings>
<intro>
<![CDATA[
This sample demonstrates how to use PdfRenderer to display PDF documents on the screen.
]]>
</intro>
</strings>
<aapt>
<noCompress>pdf</noCompress>
</aapt>
<template src="base"/>
<metadata>
<status>PUBLISHED</status>
<categories>UI, Graphics</categories>
<technologies>Android</technologies>
<languages>Java</languages>
<solutions>Mobile</solutions>
<level>BEGINNER</level>
<icon>screenshots/icon-web.png</icon>
<screenshots>
<img>screenshots/main.png</img>
</screenshots>
<api_refs>
<android>android.graphics.pdf.PdfRenderer</android>
</api_refs>
<description>
<![CDATA[
This sample demonstrates how to display PDF document on screen using
the PdfRenderer introduced in Android 5.0 Lollipop.
]]>
</description>
<intro>
<![CDATA[
You can now render PDF document pages into bitmap images for printing by using
the new [PdfRenderer][1] class. You must specify a [ParcelFileDescriptor][2]
that is seekable (that is, the content can be randomly accessed) on which the
system writes the the printable content. Your app can obtain a page for
rendering with [openPage()][3], then call [render()][4] to turn the opened
[PdfRenderer.Page][5] into a bitmap.
This sample loads the PDF from assets. Contents of assets are compressed by
default, but we disable it since PdfRenderer class cannot handle it.
```groovy
android {
aaptOptions {
noCompress "pdf"
}
}
```
[1]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.html
[2]: https://developer.android.com/reference/android/os/ParcelFileDescriptor.html
[3]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.html#openPage(int)
[4]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.Page.html#render(android.graphics.Bitmap, android.graphics.Rect, android.graphics.Matrix, int)
[5]: https://developer.android.com/reference/android/graphics/pdf/PdfRenderer.Page.html
]]>
</intro>
</metadata>
</sample>