Changelog for Android

Model

• Fixed
  Fixes occasional crashes when annotation-heavy documents are closed before UI initialization completes. (J#ANDR-1307)

Examples

• Fixed
  Fixes slow annotation selection and rendering in examples due to a high-res image in the welcome document. (#47915)

Migration guide(opens in a new tab).

UI

• Added
  Adds setters to make useCubicInterpolationForInkAnnotations configurable in PdfConfiguration and PdfActivityConfiguration. (J#ANDR-1330)
• Added
  Adds support for selecting existing annotations while in creation mode for certain annotation types. (J#ANDR-1031)
• Changed
  Optimizes the character layout calculation for edited text blocks in the content editing feature. (J#ANDR-1309)
• Fixed
  Fixes a lifecycle issue with the save dialog of the content editing feature. (J#ANDR-1311)
• Fixed
  Fixes a regression in form field check boxes and selection boxes where the selection wasn't visible until leaving the form editing UI. (J#ANDR-1317)
• Fixed
  Fixes an issue where adjusting the opacity slider on certain annotations didn't correctly update the alpha of the annotation. (J#ANDR-1275)
• Fixed
  Fixes an issue where the DocumentEditor glitched if it was invoked before the initial UI layout was done. (J#ANDR-1305)
• Fixed
  Fixes an occasional crash that occurred when entering the content editing mode and immediately switching pages. (J#ANDR-1310)
• Fixed
  Fixes content editing line height calculation for paragraphs with multiple font sizes. (J#ANDR-1318)
• Fixed
  Fixes the issue where PDF content is partially hidden behind the toolbar on initial load. (J#ANDR-1285)
• Fixed
  Fixes the issue where bookmarks fail to respect reordering after the list is closed. (J#ANDR-865)
• Fixed
  Fixes the issue where custom theme colors are ignored and Signature Dialog UI elements aren't picking the correct color attributes. Adds new style attributes that allow for customization of Signature Dialog UI elements such as 'pspdf__selectImageTextColor', 'pspdf__replaceImageTextColor', 'pspdf__clearSignatureTextColor', 'pspdf__selectedTabIndicatorColor', 'pspdf__typeSignatureFontColor', and 'pspdf__circleButtonBorderColor'. (J#ANDR-1329)
• Fixed
  Fixes the issue where the last letter of the text annotation isn't included in the highlight or underline operation. (J#ANDR-1276)
• Fixed
  Fixes the issue where vertical offset is applied in the signature dialog when drawing in portrait mode. (J#ANDR-1303)
• Fixed
  Fixes the problem where an extra status bar is added between the toolbar and the document in situations where an extra layout is provided above the document view. (J#ANDR-1297)
• Fixed
  Fixes an issue where setting EdgeToEdge.enable inside the SDK causes layouting issues with our cross platform libraries. (J#ANDR-1302)
• Fixed
  Fixes the status bar colour so it does not change when opening any of the contextual toolbars and cover the status bar icons. (J#ANDR-1356)

Model

• Added
  Adds the option automaticallyInvertColorsForNightTheme to PdfConfiguration and PdfActivityConfiguration to disable the automatic color inversion when switching to the night theme. (J#ANDR-1315)
• Changed
  Improves error handling for document loading. Previously, the loading screen was dismissed only when the cause was an Exception. It now also handles Errors, ensuring the screen is closed on any load failure. (J#ANDR-1308)
• Changed
  Improves font embedding behavior. Fonts will be embedded more often, resulting in better experience when viewed in outside viewers. (J#CORE-850)
• Changed
  Changes annotation listener APIs slightly. There are different package names and methods to register/deregister listeners. Refer to the migration guide(opens in a new tab) for details. (#47611)
• Removed
  Removes the use of setAllowFileAccess on WebSettings due to a security risk. setAllowFileAccess can be set to true using WebViewSecurityPolicy. (J#ANDR-1306)
• Fixed
  Fixes an issue where form fields weren't formatted correctly at all times. (J#CORE-676)
• Fixed
  Fixes an issue where some CA certificates weren't recognized as such. (J#CORE-857)
• Fixed
  Fixes an issue where the status of some long-term validation signatures may be 'invalid.' (J#CORE-858)
• Fixed
  Fixes a crash when creating a text parser for a page if verbose logging is enabled. (J#CORE-859)
• Fixed
  Fixes a modified annotations error in Adobe Reader after signing documents with ink and highlight annotations. (J#CORE-837)
• Fixed
  Fixes small ink signatures not being detected as overlapping when only covering a small portion of a signature form field. (Z#124893)
• Fixed
  Fixes the UrlDataProvider to work properly with image documents. (J#ANDR-1313)
• Fixed
  Fixes the issue where the application crashes during custom stamp signature creation. Disables signature constructor usage by making it private and forces signature creation via two static methods (createInkSignature and createStampSignature). (J#ANDR-1304)

Examples

• Changed
  Improves colors in the default example document for better annotating and editing. (J#DESIGN-1467)
• Changed
  Merges Kotlin example code and activity code into one file. This makes it easier to follow a single example and allows us to show the examples on the website more easily. (#47749)
• Fixed
  Fixes the issue in the simple Java example where the status bar color turned white in annotation editing mode. (J#ANDR-1296)

Migration guide(opens in a new tab).

UI

• Changed
  Changes the type of all textBlockId function parameters in the content editing feature from UUID to String. (J#ANDR-1284)
• Fixed
  Fixes an issue where, when long-pressing an annotation to show the popup toolbar, the popup was instantly dismissed. (J#ANDR-1273)
• Fixed
  Fixes an issue with a missing page refresh after performing an undo operation in context with annotation creation. (J#ANDR-1280)
• Fixed
  Fixes the layout issues on the Document Comparison screen. (J#ANDR-1195)

Model

• Added
  Adds support for preserving PDF/UA tags when using the document editor. (J#CORE-750)
• Added
  Adds support for the Acrobat JavaScript AFTime_KeystrokeEx API. (J#CORE-639)
• Added
  Adds support for the PDF JavaScript 'global' object. (J#CORE-801)
• Changed
  Improves appearance stream rendering in single line callout and free text annotations to better fit the bounding box. (J#CORE-819)
• Changed
  Improves the responsiveness of starting Content Editor on pages with complex vector graphics like building plans. (#47157)
• Fixed
  Fixes a regression where certain OCR-processed PDFs could no longer be read correctly. (J#CORE-825)
• Fixed
  Fixes an issue where TIFF files that switched between page sizes were rendered incorrectly. (J#CORE-820)
• Fixed
  Fixes an issue where certain form field flags weren't considered correctly. (J#CORE-838)
• Fixed
  Fixes an issue where the 'Widget' tab order was calculated incorrectly. (J#CORE-818)
• Fixed
  Fixes an issue where the message 'Unknown additional action trigger: Type' may appear repeatedly in logs. (J#CORE-801)
• Fixed
  Fixes an issue where the primary language of the document wasn't preserved when using the document editor. (J#CORE-840)
• Fixed
  Fixes occasional empty pages when trying to restore the page index. (J#ANDR-1110)

Instant

• Added
  Adds AI Assistant support for Instant. (J#ANDR-1250)

UI

• Fixed
  Fixes a layout issue with the PdfOutlineView in a Jetpack Compose environment. (J#ANDR-1230)
• Fixed
  Fixes occasional flickering during the creation of ink annotations. (J#ANDR-1187)
• Fixed
  Fixes some memory leaks in context with internal Compose views. (J#ANDR-1163)
• Fixed
  Fixes an issue where, in some cases, form fields weren't properly recognized as time or date fields. (J#ANDR-1231)
• Fixed
  Fixes the issue where form field content isn't rendered unless focused. (J#ANDR-1247)
• Fixed
  Fixes an issue where the popup toolbar was immediately dismissed after long-pressing an annotation. (ANDR-1273)

Model

• Added
  Adds support for passing numbers to fields.setItems() in PDF JavaScript. (J#CORE-794)
• Added
  Adds the ability to update the configuration and set the custom document source in DocumentState for Compose's DocumentView. (J#ANDR-1238)
• Changed
  Changes the GoToAction to set the destination to the page reference instead of the page index. This means the GoToAction follows the page even if pages are moved or deleted. (J#CORE-813)
• Changed
  Moves some classes for content editing to the public API to fix issues with obfuscation. (J#ANDR-1245)
• Fixed
  Fixes an issue where calling setAdditionalAction on a WidgetAnnotation didn't mark the document as modified. (J#ANDR-1237)
• Fixed
  Fixes an issue where rebuilding the cross reference table on certain invalid PDFs didn't work correctly. (J#CORE-815)
• Fixed
  Fixes an issue where sometimes invalid trailer data was written when using saveAs. (J#CORE-815)
• Fixed
  Fixes an issue with decoding certain Unicode text. (J#CORE-771)
• Fixed
  Fixes an issue with manual initialization throwing an exception incorrectly when using nutrient_automatic_initialize or pspdfkit_automatic_initialize. (J#ANDR-1242)

Examples

• Added
  Adds a dialog when launching an AIA example to allow entering the IP address of the server running AI Assistant. (J#ANDR-1211)
• Fixed
  Fixes the form field listener management in CombineElectronicSignaturesWithDigitalSigningExample. (J#ANDR-1164)

UI

• Fixed
  Fixes an issue where, in some cases, form fields were not properly recognized as time or date fields. (J#ANDR-1231)

Model

• Fixed
  Fixes an issue with manual initialization throwing an exception incorrectly when using nutrient_automatic_initialize or pspdfkit_automatic_initialize. (J#ANDR-1242)

UI

• Added
  Adds AI Assistant, which can be used to summarize, translate, and ask questions about documents. This requires you to run Nutrient AI Assistant on your server. Once that’s set up, enable it in your PdfActivityConfiguration and add your AiAssistant instance to PdfDocument. If you’d like to try this, get in touch(opens in a new tab). (J#ANDR-964)
• Added
  Adds an option to PdfConfiguration to switch between quadratic (faster) and cubic Bézier (slower) interpolation for ink annotations. (J#ANDR-1131)
• Added
  Adds new Material color scheme for Nutrient SDK and examples. (J#ANDR-1080)
• Added
  Adds the ability to configure windowInsets in the Compose MainToolbar. (J#ANDR-1196)
• Changed
  Improves the positioning of text block resize handles, and fixes some clipping issues when dragging a text block over other ones. (J#ANDR-1156)
• Changed
  Improves view initialization when the user interface is initially hidden. (J#ANDR-1124)
• Fixed
  Fixes a Parcelize crash that occurs when using the signature database to store an image or stamp signature. (J#ANDR-1128)
• Fixed
  Fixes a content editing crash, which affected devices running Android 12 or lower. (J#ANDR-1157)
• Fixed
  Fixes an issue when picking an image for a signature annotation where duplicate "Media" buttons would show in the media source selection UI. (J#ANDR-1130)
• Fixed
  Fixes an issue where, when long-pressing an annotation to show the popup toolbar, it was too easy to dismiss when the touch moved only 1 pixel. (J#ANDR-1116)
• Fixed
  Fixes an issue with positioning the page number overlay after the thumbnail height has been manually changed. (J#ANDR-1113)
• Fixed
  Fixes line height calculation for content editing for devices running Android 15 and above. (J#ANDR-1188)
• Fixed
  Fixes multiline free text line spacing calculation on Android 15+. (J#ANDR-839)
• Fixed
  Fixes the crash when DialogFragment, including PdfFragment, gets dismissed. (J#ANDR-1160)
• Fixed
  Fixes the enabled state and default coloring of the buttons in the styling bar of the content editor. (J#ANDR-1209)
• Fixed
  Fixes the enabled state of the "+" button in the bookmarks list view. (J#ANDR-1208)
• Fixed
  Fixes the issue where a custom stamp preview wasn't properly rendered in the selector dialog. (J#ANDR-1133)
• Fixed
  Fixes the shadows in the bookmarks list view. (J#ANDR-1135)

Model

• Added
  Adds Nutrient-named strings for AndroidManifest.xml: nutrient_license_key, nutrient_font_path, and nutrient_automatic_initialize. The PSPDFKit-branded strings are still supported. (J#ANDR-1127)
• Added
  Adds PdfDocument.isEncrypted(), which indicates if a document is password protected or not. (J#ANDR-1120)
• Added
  Adds the ability to increase the size of images that can be used in the SDK by overriding the pspdf__max_image_memory_ratio float dimension resource. (J#ANDR-1155)
• Added
  Adds the ability to perform digital signing in two steps using the getDataToSign and embedSignature methods in SigningManager. (J#ANDR-1094)
• Changed
  Improves memory usage when decoding large page streams, allowing better out-of-memory handling. (J#CORE-253)
• Fixed
  Fixes a crash when aligning documents using points on a straight line. (J#CORE-758)
• Fixed
  Fixes an issue where parsing certain kinds of timestamp certificates may cause a crash. (J#CORE-788)
• Fixed
  Fixes an issue with opening certain PDFs that have a broken encryption descriptor. (J#CORE-776)
• Fixed
  Fixes an issue when regenerating 'off' checkbox and radio button appearances. (J#CORE-773)
• Fixed
  Fixes the isAutosaveEnabled option on Android 15 when the app is closed via the app switcher. (J#ANDR-1126)

Examples

• Added
  Adds a Catalog example showing how to display multiple documents in tabs using a Compose HorizontalPager. The example is called DocumentPagerExample. (J#ANDR-1191)

Model

• Fixed
  Fixes an issue with compose.material and compose.material3 Maven dependency resolution since migrating to Material 3. (J#ANDR-1173)

Model

• Fixed
  Fixes a crash when aligning documents using points on a straight line. (J#CORE-758)
• Fixed
  Fixes an issue where a Freetext annotation exported in XFDF from the Nutrient Web SDK with rich-text enabled and edited in Android, did not show the updated contents when imported again in Web. (J#CORE-774)

Nutrient Android SDK 10! This contains a fundamental rebranding change, which updates our Maven dependency name to io.nutrient:nutrient. In addition, we reverted back to the major.minor.patch versioning scheme. We changed some public APIs, consisting of some deprecations and some breaking changes. Refer to the migration guide(opens in a new tab) for all the details!

UI

• Fixed
  Fixes an issue in the annotation list where items were clipped at the bottom. (J#ANDR-1071)
• Fixed
  Fixes an issue on the annotation toolbar where the buttons were not correctly selected when in vertical layout. (J#ANDR-1045)
• Fixed
  Fixes an issue where disabling the scrollbars in the configuration caused a CalledFromWrongThreadException. (J#ANDR-755)
• Fixed
  Fixes an issue where signature form fields could not be signed when other already signed adjacent signature form fields where present. (J#ANDR-1030)
• Fixed
  Fixes an issue where the PdfScrollableThumbnailBar lost the selection marker when the size of its parent view changed. (J#ANDR-1083)
• Fixed
  Fixes an issue where the measurements magnifier view was not removed when the PdfFragment was destroyed. (J#ANDR-1044)
• Fixed
  Fixes an issue where the user is able to add or edit bookmarks when the respective functionality is disabled. (J#ANDR-1086)
• Fixed
  Fixes an occasional exception when scrollbars were disabled in the PdfConfiguration. (J#ANDR-755)
• Fixed
  Fixes edge-to-edge issues in Android 15 in the note creation and stamp picker screens. (J#ANDR-1046)
• Fixed
  Fixes the issue when eraser tool works inefficiently with overlapping ink strokes. (J#ANDR-1070)
• Fixed
  Fixes unwanted vertical scrolling in horizontal continuous and paginated layout when full page height is visible. (J#ANDR-1066)
• Fixed
  Fixes a crash that occurred when trying to digitally sign a signature form field whose name and fqn where different. (J#ANDR-1081)
• Fixed
  Fixes security issue related to WebView File Access. (J#ANDR-1106)
• Fixed
  Fixes double-tap gesture when already zoomed in so we don't auto-scale to full page if the user wants to manually double-tap scale with one finger. (J#ANDR-1112)
• Changed
  Improves the UX for deleting bookmarks and annotations from the bookmark/annotation list views. (J#ANDR-1092)

Model

• Added
  Adds PdfDocument.isEncrypted(), which indicates if a document is password protected or not. (J#ANDR-1120")
• Changed
  Disables keyboard word caching on sensitive text fields such as share screen document title and annotation author name. (J#ANDR-1076)
• Changed
  Updates our core PSPDFKit API to Nutrient(opens in a new tab) and various other rebrand changes, of which the most impactful are outlined in the migration guide(opens in a new tab). (J#ANDR-1090)
• Changed
  Updates the Botan library to version 3.6.1. (J#CORE-683)
• Changed
  Updates AGP to 8.8.0. (#46386)
• Changed
  Updates Compose BOM to 2025.01.01. (J#ANDR-1107)
• Fixed
  Fixes an R8 ProGuard error pertaining to the kotlinx.parcelize package. (J#ANDR-1082)
• Fixed
  Fixes an issue when content editing type3 fonts where some text boxes appeared far too small. (J#CORE-754)
• Fixed
  Fixes an issue where, in certain PDFs, the outline/bookmarks weren't preserved when using the document editor. (J#CORE-753, J#CORE-707)
• Fixed
  Fixes an issue where manually calling PSPDFKit.initialize with a valid license key would cause the trial mode warning to pop up incorrectly. (J#ANDR-1078)
• Fixed
  Fixes an issue where the document IDs of some documents may be incorrectly truncated. (J#AI-123)
• Fixed
  Fixes note annotation comment restoration after JSON import with the DocumentJsonFormatter. (J#ANDR-1007)
• Fixed
  Fixes a content editing issue where moving a piece of text with a subsetted font could cause a character swap in some viewers. (J#CORE-577)
• Fixed
  Fixes a crash when opening a PDF with malformed forms. (J#CORE-745)
• Fixed
  Fixes an issue with TIFF images with 0 DPI. (J#CORE-770)
• Fixed
  Fixes crash when dealing with malformed embedded files. (J#CORE-728)
• Fixed
  Fixes slowdown when decoding certain TIFF images. (J#CORE-757)
• Fixed
  Fixes an issue with KDoc API docs where classes and methods that were supposed to be hidden were not hidden. (46507)
• Fixed
  Fixes an issue where some annotations weren't drawn correctly on pages with transparency. (J#CORE-783)
• Changed
  Improves handling of specific broken PDF forms, where multiple instances of the same form are combined into a single PDF. (J#CORE-646)

Examples

• Changed
  Updates our example apps with Nutrient brand icons and test documents. (J#ANDR-1093)

This version should not be used! It's here to warn library consumers who haven't read this that they should upgrade to version 10+ and change the Gradle package name. Refer to the migration guide(opens in a new tab) for more information.

• Added
  Adds a runtime error message prompting users to change the dependency to io.nutrient:nutrient version 10+ and follow the migration guide.

UI

• Fixed
  Fixes an issue where text form fields were occasionally clipped at the bottom. (J#ANDR-1024)

Migration guide(opens in a new tab).

UI

• Added
  Adds a search integration example for the DocumentView composable. (J#ANDR-882)
• Added
  Adds option to turn on/off the bookmark list view edit button and changes the PdfOutlineView APIs slightly. Refer to the migration guide for more details. (J#ANDR-1000)
• Changed
  Exposes form field listeners to Compose DocumentView using the formListener parameter of DocumentManager. (J#ANDR-897)
• Removed
  Removes the two edit handles from callout annotations that cannot be edited. (J#ANDR-1013)
• Fixed
  Fixes a crash that can happen when opening the bookmarks screen in multiple documents when using the PdfTabBar. (J#ANDR-1028)
• Fixed
  Fixes an issue in the outline list views (bookmark list, annotation list, embedded files list, etc.) where data can get duplicated when displaying multiple documents in the same activity. (J#ANDR-1012)
• Fixed
  Fixes an issue where free text annotations were not automatically deleted when empty once the editing operation ended. (J#ANDR-951)
• Fixed
  Fixes an issue where setting automaticallyGenerateLinks to true in the configuration did not create links properly, leaving them unclickable. (J#ANDR-1015)
• Fixed
  Fixes an issue where touching an annotation on top of a link annotation would often cause the link to be clicked incorrectly. (J#ANDR-1005)
• Fixed
  Fixes an issue with calling PdfOutlineView#hide() when the view is/has disappeared — for example, when switching tabs in ViewPager2. (J#ANDR-749)
• Fixed
  Fixes an issue with the outline view being too wide when its parent width is < 480DP. (J#ANDR-1029)
• Fixed
  Fixes page change animation when scrolling and releasing touch. (#45872)

Model

• Added
  Adds UrlDataProvider which implements support for loading documents from a remote URL. (J#ANDR-481)
• Added
  Adds an API to retrieve all annotations of a page in JSON format. This is much faster than converting each annotation to JSON. See AnnotationProvider#getAnnotationsJson(int pageIndex). (J#ANDR-993)
• Added
  Adds an API to save a document from Composable DocumentView. (J#ANDR-840)
• Changed
  Updates the default watermark on visible digital signatures. (J#HG-1468)
• Changed
  Upgrades dependencies: (#45822)

  • Changed
    AGP to 8.7.2
  • Changed
    Compose to 1.7.5
• Fixed
  Fixes an issue where PDFs with a large amount of unique fonts take up a lot of memory, especially during indexing. (J#CORE-748)
• Fixed
  Fixes an issue where callout annotations weren't rendered correctly in other PDF readers. (J#ANDR-937)
• Fixed
  Fixes lockup/crash issues when opening certain malformed PDF forms. (J#CORE-726)
• Fixed
  Fixes an issue with GoTo Remote and Goto Embedded actions. (J#CORE-751)

Patch release that fixes a regression in the Signature class creation API (J#ANDR-1016). In version 2024.8, we removed the API to create a signature using a Bitmap. Use the Signature companion method, Signature.createStampSignature, or createInkSignature, to create these objects. Note that some constructor arguments in Signature have changed slightly or been removed, as they weren’t necessary.

Migration guide(opens in a new tab).

UI

• Added
  Adds a color correction filter to improve colors when inverted rendering is active. (J#ANDR-809)
• Added
  Adds the ability to use the "fling" gesture with two fingers. This is useful when, for example, drawing an annotation with one finger and navigating to another page or part of the page with two fingers. (J#ANDR-914)
• Changed
  Improves typing and drawing signature layouts to make use of the full screen width in landscape mode. (J#ANDR-945)
• Added
  Adds the ability to add items in overflow menu in the Compose MainToolbar. (J#ANDR-864)
• Changed
  Shrinks the measurement text to fit inside the shape. (J#ANDR-798)
• Fixed
  Fixes an issue on Samsung devices where scrolling with two fingers was incorrectly recognized as a pinch/zoom. (J#ANDR-914)
• Fixed
  Fixes an issue on Samsung devices where zooming can cause the zoom center point to be locked to the top-left corner of the page instead of between the fingers. (J#ANDR-914)
• Fixed
  Fixes an issue with paginated layout managers where the displayed pages jumped briefly after a resize of the window. (J#ANDR-938)
• Fixed
  Fixes annotations count in the Annotations list tab. (J#ANDR-926)
• Fixed
  Fixes the pages preview in Document Editor when duplicating or adding more pages. (J#ANDR-928)
• Fixed
  Fixes the item colors of the bookmark list in dark mode. (J#ANDR-942)
• Fixed
  Fixes the text color of the Clear All annotations dialog in dark mode. (J#ANDR-941)
• Fixed
  Fixes the text colors for the embedded files list in dark mode. (J#ANDR-919)

Model

• Added
  Adds an API to control what Edits are added to the undo/redo stack. This can be controlled via the OnAddNewEditListener, which needs to be added to the UndoManager via UndoManager#setOnAddNewEditListener. (J#ANDR-899)
• Added
  Adds support for reading the widget tab order. (J#CORE-660)
• Changed
  Improves text extraction by replacing invalid characters with the Unicode Replacement Character (0xFFFD). (J#CORE-701)
• Added
  Adds NavHost Compatibility with Compose DocumentView. (J#ANDR-912)
• Changed
  Changes BiometricSignatureData to a Kotlin data class and removes its Builder. It must be constructed using the constructor. (J#ANDR-852)
• Changed
  Changes PdfConfiguration and PdfActivityConfiguration to Kotlin data classes. Builder API is still there, although there are slight modifications to the APIs. See the migration guide for more details. (J#ANDR-852)
• Changed
  Changes SearchConfiguration to a data class and removes its Builder. (J#ANDR-852)
• Changed
  Changes SignatureAppearance to a Kotlin data class and removes the Builder. SignatureAppearance must be created via its constructor. (J#ANDR-852)
• Changed
  Changes Signature to a Kotlin data class. Static methods must be called with its companion object from Java code. (J#ANDR-852)
• Changed
  Changes the search type to an enum, SearchType, which replaces the integer constants defined in PdfActivityConfiguration (PdfActivityConfiguration.SEARCH_INLINE, PdfActivityConfiguration.SEARCH_MODULAR). (#45404)
• Fixed
  Fixed back button behavior in the Compose wrapper. (J#ANDR-870)
• Removed
  Removes the PdfConfiguration option to set SignatureAppearance. This is no longer used internally. The signature appearance is set via the DigitalSignatureMetadata class and passed to SignerOptions. (J#ANDR-852)
• Changed
  Updates the HarfBuzz library to version 10.0.1. (J#CORE-693)
• Fixed
  Fixes a crash that may happen when saving LTV information in a document. (J#CORE-710)
• Fixed
  Fixes a potential ProGuard error related to kotlinx.parcelize since v2024.7. (J#ANDR-936)
• Fixed
  Fixes an issue retrieving the text of a highlight annotation on rotated pages. (J#CORE-449)
• Fixed
  Fixes an issue where a misleading exception was thrown when trying to open an invalid URI. (J#ANDR-883)
• Fixed
  Fixes an issue where certain license keys couldn't be read correctly. (J#CORE-725)
• Fixed
  Fixes an issue where handwritten signatures may appear unexpectedly cropped. (J#CORE-713)
• Fixed
  Fixes an issue where the signature validation status after certificate revocation checks may be invalid if the document has multiple digital signatures. (J#AND-842)
• Fixed
  Fixes an issue where the tab index of signature fields wasn't calculated correctly. (J#CORE-660)
• Fixed
  Fixes an issue where too much memory was used when decoding JPEG2000 image masks. (J#CORE-636)
• Fixed
  Fixes the annotations count in the Annotations tab. (J#ANDR-926)
• Fixed
  Fixes issues with Type 3 fonts and text extraction. (J#CORE-703)
• Fixed
  Fixes the watermark not showing in the Thumbnail Bar when using Scrollable mode. (J#ANDR-845)

Migration guide.

UI

• Added
  Adds the ability to disable the stylus button on the AnnotationCreationToolbar using annotationCreationToolbar.setShouldShowStylusButton(false), which can be accessed via the OnContextualToolbarLifecycleListener#onPrepareContextualToolbar interface. (J#ANDR-812)
• Added
  Adds the ability to move the crosshair in document comparison mode so you can easily select points all over the document for alignment. (J#ANDR-894)
• Changed
  Improves free text annotation rendering when zooming in and out while using PLATFORM_RENDERING. (J#ANDR-835)
• Changed
  Improves the default appearance of callout annotations. (J#ANDR-836)
• Added
  Adds ContextualToolbarListener to configure menu items in the Compose DocumentView state. (J#ANDR-868)
• Fixed
  Fixes an issue with missing text when adding new lines to a multiline callout annotation. (J#ANDR-841)
• Fixed
  Fixes the overflow menu visibility in the Compose main toolbar if overflow menu items are empty. (J#ANDR-869)
• Fixed
  Fixes issues with zooming performance on devices with more than 2 GB RAM. We now default most annotations to use AP stream rendering, which is more performant and does not have fidelity issues. This can be overridden using PdfFragment#setOverlaidAnnotationTypes and specifying the rendering strategy with setAnnotationOverlayRenderStrategy. (J#ANDR-884)

Model

• Fixed
  Fixes back button behavior in the Compose wrapper. (J#ANDR-870)
• Changed
  Reintroduces ProGuard to hide our internal APIs and reduce API misuse. If you have any ProGuard-related issues, contact us. (J#ANDR-810)
• Removed
  Removes Builder classes from ElectronicSignatureOptions and SignatureOptions. Internally, these are migrated to Kotlin’s data class to remove the @AutoValue annotation. (J#ANDR-848)
• Changed
  Upgrades various key c (J#ANDR-838)

  • Changed
    Android Gradle Plugin: 8.6.0
  • Changed
    Kotlin: 2.0.20
  • Changed
    Compose: 1.7.1
• Fixed
  Fixes an issue when parsing timestamp policies with short OIDs in digital signatures. (J#SERVER-1231)
• Fixed
  Fixes an issue where digitally signing a document may trigger an error in Adobe Acrobat about a modified page. (J#CORE-45204)
• Fixed
  Fixes an issue where digitally signing with the SHA384 hashing algorithm didn’t work. (Z#116874)
• Fixed
  Fixes an issue where form contents may be rotated after exporting and then importing from Instant JSON. (J#CORE-647)
• Fixed
  Fixes an issue where form flags were overwritten when using the processor and NeedAppearances was set in the PDF. (J#CORE-45331)
• Fixed
  Fixes an issue where handwritten signatures may show distorted in some page orientations. (J#ANDR-824)
• Fixed
  Fixes an issue where some annotations may lose their font color when you export them to XFDF and import them again. (J#CORE-680)
• Fixed
  Fixes an issue where the blend mode wasn’t read correctly. (J#CORE-691)
• Fixed
  Fixes a rare crash due to concurrent access in the AnnotationFlatbufferWriter. (J#ANDR-895)
• Fixed
  Fixes an issue where PDFs with millions of outline elements could exhaust the memory. (J#CORE-694)

Patch release containing some important fixes for adding digital signatures on certain documents.

Model

• Fixed
  Fixes an issue where PDF JavaScript may report an error when setting a custom value to a combo box form field. (J#CORE-675)
• Fixed
  Fixes an issue where digitally signing a document may trigger an error in Adobe Acrobat about a modified page. (J#CORE-682)
• Fixed
  Fixes an issue where some signatures with Long-Term Validation information may be incorrectly reported as invalid. (J#CORE-654)
• Fixed
  Fixes an issue where the same font was embedded multiple times when entering diacritics, leading to a massive file size. (J#CORE-634)

Migration guide(opens in a new tab).

UI

• Added
  Adds a pspdf__scaleListItemCheckColor attribute to set the color of the selected item check mark in the measurement scales list. (J#ANDR-822)
• Added
  Adds the ability to set the line thickness to 0 in the UI. Internally, we set this to 0.5f, which is the thinnest we support in our backend. (J#ANDR-674)
• Changed
  Exposes the PdfUi interface in the DocumentConnection. (J#ANDR-811)
• Fixed
  Fixes a regression where selecting an annotation via the outline annotation list view causes a crash if the user does not have annotation editing licensed. (J#ANDR-815)
• Fixed
  Fixes an issue where certain annotations that have separate alpha for fill and stroke color were displayed as opaque. Also adds an API to set the fill alpha independently from the overall alpha with Annotation#setFillAlpha. (J#ANDR-804)
• Fixed
  Fixes an issue where text editing was immediately canceled when the UI was configured with vertical continuous scrolling. (J#ANDR-823)
• Fixed
  Fixes an issue where the initial position of a page is incorrect if the previous page has a different orientation. (J#ANDR-672)
• Fixed
  Fixes an issue where the pages were improperly laid out after a resize of the PdfFragment. (J#ANDR-817)
• Fixed
  Fixes vertical centering of the displayed PDF page after the height of its containing view was changed. (J#ANDR-805)

Model

• Added
  Adds git history to public example app repositories. Beginning with this release, people can see what has changed from the last release. (J#ANDR-620)
• Added
  Adds the ability to reinitialize PdfFragment with PdfFragment#refreshPages when a document's childViews (pages) are cleared. (J#ANDR-786)
• Changed
  Improve evaluation experience. (J#CORE-667)
• Changed
  Replaces the old simple example with the Compose wrapper example app, which can be found here https://github.com/PSPDFKit/pspdfkit-jetpack-compose-pdf-viewer. (J#ANDR-790)
• Changed
  Upgrades NDK to 27 from 25. (J#ANDR-183)
• Fixed
  Fixes a very rare potential corrupt file case when using PdfFragment#save. save is now blocking and safe. saveAsync has been added for original functionality, which doesn't block the UI, and a spinner is shown during the saving process. (J#ANDR-541)
• Fixed
  Fixes an issue where a PDF rendered incorrectly. (J#CORE-643)
• Fixed
  Fixes an issue where annotations exported to XFDF and then imported again may lose their text color. (J#CORE-648)
• Fixed
  Fixes an issue where converting a bitonal TIFF with a lot of pages consumed too much memory. (J#CORE-621)
• Fixed
  Fixes an issue where opening image files with broken XMP/EXIF headers may crash the app. (J#CORE-665)
• Fixed
  Fixes an issue where signatures on rotated documents were displayed incorrectly. (J#CORE-672)
• Fixed
  Fixes an issue with highlight shape when adding text highlights on rotated pages. Text highlights now cover only the rectangle of the relevant text, without using curved edges. (J#ANDR-313, J#ANDR-314, J#ANDR-194)

• Changed
  Improves the evaluation experience. (J#CORE-667)

Version 2024.5 is a routine release with a few upgrades, fixes, and small features, outlined below.

UI

• Added
  Adds a pspdf__scaleListItemBackgroundColor attribute to set the color of the list item background of the measurement scales list. (J#ANDR-772)
• Added
  Adds a feature to configure the hidden and visible state of the VerticalScrollbar view. (J#ANDR-750)
• Fixed
  Fixes an issue where ink annotations can get clipped slightly when the tool is deselected. (J#ANDR-679)
• Fixed
  Fixes an issue where the document text search was very slow after changing the search query string. (J#ANDR-618)
• Fixed
  Fixes an issue where the saving spinner would never get dismissed when redaction saving failed. (J#ANDR-530)
• Fixed
  Fixes an issue where the virtual keyboard was wrongly hidden during content editing. (J#ANDR-608)
• Fixed
  Fixes an issue with the virtual keyboard in the context of a vertical continuous scrolling page configuration. (J#ANDR-419)

Model

• Changed
  Updates HarfBuzz library to 9.0.0. (J#CORE-625)
• Fixed
  Fixes a potential crash when clearing listeners in the DocumentView if it happens before the document has been loaded. (J#ANDR-753)
• Fixed
  Fixes an case where a custom DataProvider that doesn't support appending was writing with append during redaction application, in turn causing failed redaction. (J#ANDR-530)

Instant

• Fixed
  Fix an issue where the Instant client incorrectly removes the path segment from a server URL when parsing it. (J#ANDR-757)

Migration guide(opens in a new tab). Version 2024.4 adds support for Android 15 and 16KB page sizes, better ink annotation rendering, and many more fixes, improvements, upgrades, and small features, which are outlined below.

It's important to note that the deprecation period for the legacy digital signature APIs has passed, and users now have to use the new API. See the migration guide linked above for details.

UI

• Added
  Adds a button to the date and time pickers to clear form fields with dates when said fields aren't empty. (J#ANDR-436)
• Added
  Adds the ability to fix the aspect ratio for free text annotations using the setKeepAspectRatioEnabled(opens in a new tab) API. (J#ANDR-579)
• Added
  Adds a feature to configure expanded and collapsed state of outline elements. (J#ANDR-546)
• Added
  Adds a feature to update the style with the Material Theme for MainToolbar Composable. (J#ANDR-524)
• Added
  Adds the eraser tool to the tools that are supported by the palm rejection mode. (J#ANDR-598)
• Changed
  Changes the default state of the stylus to be disabled so that stylus-only input will be activated once an annotation has been made using the stylus and so that enableStylusOnDetection() in the configuration is set to true. (J#ANDR-542)
• Changed
  Exposes AnnotationConfigurationRegistry in the DocumentConnection interface of our Jetpack Compose SDK. (J#ANDR-585)
• Changed
  Moves the stylus button from the document settings to the toolbar during annotation creation and editing. (J#ANDR-582)
• Changed
  Uses overlay paint with alpha instead of MULTIPLY blend mode for in-page search results to work better on documents with dark backgrounds. (J#ANDR-630)
• Fixed
  Fixes UI layout issues after device rotation with certain activity configurations. (J#ANDR-652)
• Fixed
  Fixes a rare crash caused by the annotation eraser tool. (J#ANDR-589)
• Fixed
  Fixes a regression from 2024.2 where zooming out of the page at a scale of 1 always bounced the page to the same location instead of a location relative to the pinch gesture center point. (J#ANDR-597)
• Fixed
  Fixes an error where ThumbnailGridView displayed the page thumbnails with an incorrect height after device rotation. (J#ANDR-651)
• Fixed
  Fixes an issue where cloudy borders change size when first created and deselected. (J#ANDR-600)
• Fixed
  Fixes an issue where deleting selected annotations did not properly exit the annotation editing mode. (J#ANDR-676)
• Fixed
  Fixes an issue where ink annotation render changes drastically when the tool is deselected. (J#ANDR-220)
• Fixed
  Fixes an issue where the PdfThumbnailGrid displayed the wrong amount of columns after a device rotation. (J#ANDR-583)
• Fixed
  Fixes an issue where the size of an ellipse or rectangle annotation changes when you select and deselect it after setting the border style to/from cloudy. (J#ANDR-536)
• Fixed
  Fixes free text annotation shrinking in size when deselected. (J#ANDR-599)
• Fixed
  Fixes free text annotation wobble when zooming in and out of a page. (J#ANDR-599)
• Fixed
  Fixes an issue where an annotation drawn on top of a LinkAnnotation doesn't intercept a click event first. (J#ANDR-490)
• Fixed
  Fixes a rare crash that happens when AnnotationCreatorInputDialogFragment is opened for some devices. (J#ANDR-542)
• Fixed
  Fixes an issue where the annotation editing mode didn't automatically exit when the current selection was deleted (and thus left the toolbar in an invalid state). (J#ANDR-625)
• Fixed
  Fixes an issue where undoing the deletion of a custom stamp annotation didn't restore its bitmap. (J#ANDR-544)
• Fixed
  Fixes an issue where ink annotations can get clipped slightly when the tool is deselected. (J#ANDR-679)

Model

• Added
  Adds a Catalog example to show how to detect when a document has been scrolled to the end and how to add a page after scrolling to the end. (J#ANDR-548)
• Added
  Adds support for 16KB page size devices in Android 15. (J#ANDR-644)
• Added
  Adds support for Android 15! (J#ANDR-660)
• Added
  Adds support for RegExp.$1 to RegExp.$9 to allow accessing regular expression capturing groups from PDF scripts. (J#CORE-567)
• Added
  Adds support for parsing custom colors in PDF JavaScript and converting color spaces by using the color.convert API. (J#CORE-580)
• Changed
  Improves TIFF image document quality by respecting the embedded DPI values. (J#CORE-522)
• Changed
  Improves the performance of the snapping tool with construction documents. (J#CORE-536)
• Added
  Adds DataProvider support in compose DocumentView. (J#ANDR-653)
• Removed
  Removes the deprecated legacy digital signatures code, as well as a few related classes and APIs. Full details in the migration guide(opens in a new tab). (J#ANDR-203)
• Changed
  Renames the internal OutOfMemory thread to MemoryHandling to reduce confusion in stack traces. (J#CORE-581)
• Changed
  Replaces the Uri API for output documents in the digital signatures signDocument API with a fully customizable DataProvider parameter. This can be used for encryption or any other file writing customizations that might be required when saving a signed document. (J#ANDR-488)
• Changed
  Updates the Botan library to version 2.19.5. (J#CORE-633)
• Changed
  Updates the HarfBuzz library to version 8.5.0. (J#CORE-583)
• Changed
  Updates the STB library to version 2.30. (J#CORE-570)
• Changed
  Updates Android Gradle Plugin from 8.2.1 to 8.5.1 and Gradle to 8.7. (J#ANDR-646)
• Changed
  Updates various transitive dependencies: (J#ANDR-649)

  • Changed
    Kotlin 1.9.20 -> 1.9.24
  • Changed
    fragmentKtx 1.6.2 -> 1.8.1
  • Changed
    AppCompat 1.6.1 -> 1.7.0
  • Changed
    Material 1.11.0 -> 1.12.0
  • Changed
    ViewPager2 1.0.0 -> 1.1.0
  • Changed
    WebKit 1.1.0 -> 1.11.0
  • Changed
    Compose 1.5.4 -> 1.6.8
• Fixed
  Fixes a crash when editing the content of some documents. (J#CORE-601)
• Fixed
  Fixes a potential crash when accessing a ShapeAnnotationView Annotation object if the view has !=1 annotation associated. (J#ANDR-540)
• Fixed
  Fixes an issue where OnAnnotationSelectedListener.onAnnotationSelectionFinished wasn't called under certain circumstances. (J#ANDR-537)
• Fixed
  Fixes an issue where a comment status may not show when a saved file is open in third-party software like Adobe Acrobat. (J#CORE-610)
• Fixed
  Fixes an issue where, after redacting, some images were displaying wrong (e.g. black instead of white). (J#CORE-561)
• Fixed
  Fixes an issue where changing to cloudy border style via the inspector resulted in a shape disappearing. (J#ANDR-536)
• Fixed
  Fixes an issue where exporting and importing Instant JSON may incorrectly move annotations or forms. (J#CORE-589)
• Fixed
  Fixes an issue where redaction didn't handle certain text objects correctly, resulting in some displaced text. (J#CORE-612)
• Fixed
  Fixes an issue where some digital signatures may incorrectly report as invalid. (J#CORE-597)
• Fixed
  Fixes an issue where some digital signatures may not be validated correctly. (J#CORE-607)
• Fixed
  Fixes an issue where the value property of the Field object in JavaScript may return an incorrect type in some cases. (J#CORE-582)
• Fixed
  Fixes an issue where the date and time pickers weren't added reliably. (J#CORE-520)
• Fixed
  Fixes an issue where the line dash pattern was rendered differently from other PDF readers. (J#CORE-540)
• Fixed
  Fixes an issue where the page labels may be incorrect in some documents. (J#CORE-560)
• Fixed
  Fixes an issue where too many fonts were added to the PDF in certain rare circumstances, causing crashes. (J#CORE-605)
• Fixed
  Fixes an issue where, in some cases, PDF JavaScript that changes the value of a form field wasn't executed correctly. (J#CORE-590)
• Fixed
  Fixes an issue where custom fonts aren't loaded. (J#ANDR-613)
• Fixed
  Fixes an issue where a signature image is incorrectly rotated on a rotated page. (J#ANDR-632)

A routine patch release focusing on the following issues reported by customers:

UI

• Changed
  Exposes the AnnotationConfigurationRegistry in the DocumentConnection interface of our Jetpack Compose SDK. (J#ANDR-585)
• Fixed
  Fixes an issue where the PdfThumbnailGrid displayed the wrong amount of columns after a device rotation. (J#ANDR-583)
• Fixed
  Fixes an issue where the size of an ellipse or rectangle annotation changes when you select and deselect it after setting the border style to/from cloudy. (J#ANDR-536)
• Fixed
  Fixes an issue where an annotation drawn on top of a LinkAnnotation does not intercept a click event first. (J#ANDR-490)
• Fixed
  Fixes an issue where cloudy borders change size when first created and deselected. (J#ANDR-600)

Model

• Changed
  Improves the performance of the snapping tool with construction documents. (J#CORE-536)
• Fixed
  Fixes a potential crash when accessing a ShapeAnnotationView Annotation object if the view has !=1 annotation associated. (J#ANDR-540)
• Fixed
  Fixes an issue where OnAnnotationSelectedListener.onAnnotationSelectionFinished wasn't called under certain circumstances. (J#ANDR-537)
• Fixed
  Fixes an issue where, after redacting, some images were displaying wrong (e.g. black instead of white). (J#CORE-561)
• Fixed
  Fixes an issue where changing to cloudy border style via the inspector resulted in the shape disappearing. (J#ANDR-536)
• Fixed
  Fixes an issue where exporting and importing Instant JSON may incorrectly move annotations or forms. (J#CORE-589)
• Fixed
  Fixes an issue where the 'value' property of the 'Field' object in JavaScript may return an incorrect type in some cases. (J#CORE-582)
• Fixed
  Fixes an issue where the line dash pattern was rendered differently from other PDF readers. (J#CORE-540)
• Fixed
  Fixes an issue where the page labels may be incorrect in some documents. (J#CORE-560)
• Fixed
  Fixes an issue where too many fonts were added to the PDF in certain rare circumstances, causing crashes. (J#CORE-605)
• Fixed
  Fixes an issue where, in some cases, PDF JavaScript that changes the value of a form field was not executed correctly. (J#CORE-590)
• Fixed
  Fixes an issue where some digital signatures may incorrectly report as invalid. (J#CORE-597)
• Fixed
  Fixes an issue where some digital signatures may not be validated correctly. (J#CORE-607)

Migration guide(opens in a new tab). Version 2024.3 introduces snappier page transitions, as well as proper stylus handling and palm rejection. You can now draw annotations with the stylus while moving the page or switching pages with a finger. There are more bug fixes and improvements. See details below.

UI

• Added
  Adds a configuration option to disable the annotation popup toolbar when you long-press a selected annotation (see annotationPopupToolbarEnabled). (J#ANDR-468)
• Added
  Adds palm rejection handling on all devices. (J#ANDR-88)
• Added
  Adds the ability to draw with a stylus and pan or scroll a document with a finger once the setting has been enabled. (J#ANDR-457)
• Changed
  Exposes onDocumentScroll to the DocumentView composable, which can help with handling touch events on Compose container views containing a document. (J#ANDR-470)
• Fixed
  Fixes a crash that might occur when the default MeasurementValueConfiguration has a fractional precision. (J#ANDR-497)
• Fixed
  Fixes a gesture issue where zooming less than 100 percent of a page can cause it not to snap back to full width. (J#ANDR-468)
• Fixed
  Fixes a regression where selecting a free text annotation would occasionally not display all the text until the bounding box is updated. (J#ANDR-460)
• Fixed
  Fixes an issue on Samsung devices where you can't scroll a page while in annotation editing mode. (J#ANDR-468)
• Fixed
  Fixes an issue where the scrollbars aren't displayed relative to the page after zooming in when using the jump transition. (J#ANDR-449)
• Fixed
  Fixes an issue where zooming out of an already zoomed out page may cause the page to travel up or down. (J#ANDR-468)
• Fixed
  Fixes an occasional issue where the popup toolbar doesn't get dismissed properly. (J#ANDR-468)
• Fixed
  Fixes an issue where the inspector view didn't show a preview when switching the border style to CLOUDY. (J#ANDR-451)
• Fixed
  Fixes an issue where an annotation drawn on top of a LinkAnnotation does not intercept a click event first. (J#ANDR-490)

Model

• Added
  Adds the ability to toggle PSPDFKit view components from Compose's DocumentView. (J#ANDR-407)
• Changed
  Improves the PDFUIFragment Catalog example by showing how to hook into the document listener before the document is loaded. (Z#111597)
• Changed
  Improves the content editing functionality in documents that contain tables. (J#CORE-506)
• Changed
  Improves the logging system used in PSPDFKit for Android by making it more consistent. (J#ANDR-188)
• Changed
  Exposes documentId and documentIdString in PdfDocument. (J#ANDR-446)
• Changed
  Updates Annotation#toInstantJson() to use the Instant JSON protocol V2 instead of V1. (J#ANDR-463)
• Changed
  Updates the HarfBuzz library to version 8.4.0. (J#CORE-559)
• Fixed
  Fixes a memory leak in the context of device rotation. (J#ANDR-465)
• Fixed
  Fixes an issue where an incorrect note icon may show on top of highlight annotations with comment replies. (J#CORE-527)
• Fixed
  Fixes an issue where converting a stamp annotation with a custom AP stream to JSON returns null in onAnnotationCreated(). (J#ANDR-479)
• Fixed
  Fixes an issue where deleting the value of a form field may incorrectly show the previous value in some situations. (J#CORE-531)
• Fixed
  Fixes an issue where measurement labels on rotated pages weren't exported correctly. (J#CORE-529)
• Fixed
  Fixes an issue where pages could be rendered too small. (J#CORE-550)
• Fixed
  Fixes an issue where pages could be rendered upside down. (J#CORE-545)
• Fixed
  Fixes an issue where redaction annotations could not be applied by third-party software like Adobe Acrobat. (J#CORE-555)
• Fixed
  Fixes an issue where text highlights were split when there was a tiny gap in a sentence. (J#CORE-510)
• Fixed
  Fixes an issue where the email preset didn't mark some email addresses for redaction. (J#CORE-514)
• Fixed
  Fixes an issue where the redaction tool may redact a bigger area than necessary in some documents. (J#CORE-562)
• Fixed
  Fixes an issue where the text in a callout annotation may appear in the wrong position. (J#CORE-466)
• Fixed
  Fixes an issue where the text selection rectangle was too big, resulting in squashed text. (J#CORE-496)
• Fixed
  Fixes an issue with PDF comparison when the content stream didn't contain any stroke color commands. (J#CORE-533)
• Fixed
  Fixes an issue where the page labels may be incorrect in some documents. (J#CORE-560)

Instant

• Fixed
  Fixes a deadlock when syncing annotations on a certain document containing stamp annotations in PSPDFKit Instant. (J#ANDR-277)

UI

• Fixed
  Fixes a regression where selecting a free text annotation would occasionally not display all the text until the bounding box is updated. (J#ANDR-460)

Welcome to the second major release of PSPDFKit for Android in 2024! We've fixed a lot of bugs (see below), and we added some great improvements and features:

• Changed
  Jetpack Compose!

  • Added
    New Jetpack Compose main toolbar! This makes it super easy to add and remove custom buttons and customize the toolbar however you want.
  • Changed
    We also migrated some of our UI to Jetpack Compose: the document information screen, and the settings menu.
• Changed
  Annotation Multi-Selection!

  • Changed
    A new toolbar item has appeared! You can use it to select multiple annotations and group, move, copy, or resize them all at once! This brings us up to par with our iOS product, which also has this feature.
• Changed
  We've cleaned up our SDK initialize API (refer to the migration guide linked below).
• Changed
  Our free text and callout annotations now render much more cleanly and with better performance.
• Changed
  We've expanded the customization options for measurement annotations.
• Changed
  Loads more bug fixes and improvements — see the list below.
• Changed
  Enjoy!

Migration guide(opens in a new tab).

UI

• Added
  Adds FreeTextAnnotations to the list of annotations that obey the NOZOOM flag. (J#ANDR-365)
• Added
  Adds an extra tab in the outline screen to view and open any PDF files embedded in an open document. This tab is only displayed if the document has embedded PDF files. (J#ANDR-403)
• Added
  Adds annotation multi-selection and grouping functionalities. (J#ANDR-264)
• Added
  Adds customization options for the lines and shapes used for measurement annotations. (J#ANDR-298)
• Added
  Adds a new composable main toolbar, allowing users to easily customize it, including adding and removing custom buttons and text. (J#ANDR-289)
• Added
  Adds the ability to auto save updated SettingsView configurations on exit, and removes the save button. (J#ANDR-344)
• Added
  Adds style attributes for configuring margin and selection width in the PdfScrollableThumbnailBar. (J#ANDR-308)
• Changed
  Enables scrolling with two fingers while in annotation creation mode and not zooming. (J#ANDR-401)
• Removed
  Removes the deprecated SettingsModePicker from the codebase. SettingsDialog should be used instead. (J#ANDR-370)
• Changed
  Replaces the document info view with a Jetpack Compose screen. (J#ANDR-345)
• Changed
  Replaces the settings view with a Jetpack Compose screen. (J#ANDR-344)
• Changed
  Improves the performance for compound undo/redo operations. (J#ANDR-380)
• Fixed
  Fixes a rare crash when highlighting text on a rotated page after long-pressing a text block. (J#ANDR-368)
• Fixed
  Fixes an issue where it wasn’t possible to input a comma as a decimal separator into form fields on certain Samsung devices. (J#ANDR-357)
• Fixed
  Fixes an issue where snapping and guide helpers were incorrectly used for callout annotations. (J#ANDR-394)
• Fixed
  Fixes an issue where the border of a free text annotation changes size when selected and deselected. (J#ANDR-410)
• Fixed
  Fixes a bug where choosing only one SignatureCreationMode showed a blank screen. (J#ANDR-406)
• Fixed
  Fixes a crash that happens when trying to add comments after long-pressing a piece of text while using Instant. (J#ANDR-420)
• Fixed
  Fixes an issue where the inspector view didn't show a preview when switching the borderstyle to CLOUDY. (J#ANDR-451)
• Fixed
  Fixes render artifacts in free text and callout annotations when selected vs. deselected. (J#ANDR-294)
• Fixed
  Fixes rotated callout annotation rendering. (J#ANDR-294)
• Fixed
  Fixes the pop-up toolbar appearing away from the touch point when long pressing the page. (J#ANDR-414)

Model

• Added
  Adds support for editing the content of PDF documents that use Type3 fonts. (J#CORE-478)
• Removed
  Deprecates AnnotationEditingController.getCurrentlySelectedAnnotation. New methods getCurrentlySelectedAnnotations, getCurrentSingleSelectedAnnotation and hasCurrentlySelectedAnnotations should be used instead. The OnAnnotationSelectedListener interface got a new method onAnnotationSelectionFinished() which is called after all annotations of the current selection process have been selected. (J#ANDR-437)
• Changed
  Organises the Jetpack Compose classes in a clearer package structure. This is a breaking API change. See migration guide for v2024.2. (J#ANDR-373)
• Added
  Adds an API to rotate callout annotations programmatically by 90, 180, or 270 degrees. (J#ANDR-294)
• Added
  Adds appearance stream generation for link annotations. This means any set borders will be rendered now. (J#CORE-483)
• Added
  Adds one PSPDFKit.initialize method to rule them all. This takes InitializationOptions. All other initialize methods are deprecated and will be removed in 2025. (J#ANDR-142)
• Added
  Adds the AnnotationViewsListener interface, which informs listeners about the EditText widget used to edit free text annotations. (J#ANDR-342)
• Added
  Adds the ability to exclude certain annotations or annotation types from a page render call using PageRenderConfiguration. (J#ANDR-201)
• Changed
  Updates the HarfBuzz library to version 8.3.1. (J#CORE-524)
• Changed
  Ensures adding and removing annotations from a page programmatically now adds the operations to the undo stack. (J#ANDR-415)
• Removed
  Removes useless rotation functions from the `FreeTextAnnotation rotation API in favor of one rotation function that takes a rotation parameter. (J#ANDR-294)
• Removed
  Removes deprecated methods to do with accessing measurement scale/precision (can be replaced with the MeasurementValueConfiguration API) and isValidForEditing, which is replaced with isWritableAndCanSave. (J#ANDR-370)
• Fixed
  Fixes an issue where Instant sync failed due to unsupported objects being received. (J#CORE-407)
• Fixed
  Fixes a memory leak in PdfStaticThumbnailBar (used in PdfFragment) related to a layout listener. (J#ANDR-353)
• Fixed
  Fixes a memory leak related to the NavigationBackStack when destroying and recreating PdfFragment's in a view pager. (J#ANDR-393)
• Fixed
  Fixes a potential crash when unparcelling document sources. (J#ANDR-391)
• Fixed
  Fixes a potential crash when using PdfFragment if you don't call PdfOutlineView#setDocument when a new document is loaded. We now continue and show a log error message. (J#ANDR-431)
• Fixed
  Fixes a rare crash in certain PDF documents with JavaScript. (J#CORE-500)
• Fixed
  Fixes an error message that may appear in the logs when using the snapping tool. (J#CORE-391)
• Fixed
  Fixes an issue that was causing conflicts with duplicate files in external SDKs. (J#ANDR-367)
• Fixed
  Fixes an issue with PDF comparison when the content stream didn't contain any stroke color commands. (J#CORE-533)
• Fixed
  Fixes an issue where annotations may be incorrectly selected in some cases. (J#CORE-464)
• Fixed
  Fixes an issue where calling Field.value in a PDF JS script may return the wrong value. (J#CORE-450)
• Fixed
  Fixes an issue where calling the PDF JS API field.setItems may not change the form's value. (J#CORE-430)
• Fixed
  Fixes an issue where extracted text was garbled due to incomplete reading order information in the PDF. (J#CORE-385)
• Fixed
  Fixes an issue where intermittent rendering errors occurred while zooming in and out, resulting in incomplete page displays. (J#CORE-447)
• Fixed
  Fixes an issue where listing embedded files in rare PDFs could cause a crash. (J#CORE-493)
• Fixed
  Fixes an issue where opening a document with a digital signature may report additional changes. (J#CORE-473)
• Fixed
  Fixes an issue where redacting some kind of documents may corrupt them. (J#CORE-375)
• Fixed
  Fixes an issue where refreshing the LTV information of some signed documents may fail. (J#CORE-499)
• Fixed
  Fixes an issue where shape annotations imported via Instant JSON may incorrectly show a black border. (J#CORE-392)
• Fixed
  Fixes an issue where text blocks were split when encountering two or more narrow characters. (J#CORE-380)
• Fixed
  Fixes an issue where text with the FL and FI ligatures wasn't extracted correctly. (J#CORE-443)
• Fixed
  Fixes an issue where the appearance of unsigned signature form fields may ignore some property changes, like their border width. (J#CORE-417, J#CORE-412)
• Fixed
  Fixes an issue where the text selection of italic characters was too large. (J#CORE-444)
• Fixed
  Fixes an issue where validating some documents with LTV information may incorrectly return that the revocation status couldn't be checked. (J#WEB-1042)
• Fixed
  Fixes an issue where deletion of all comments for an annotation caused the annotation to disappear. Also fixes a related crash when clicking on the bin icon to delete all comments for an annotation. (J#ANDR-371)
• Fixed
  Fixes an issue where stamp annotations created using vector images have the wrong type when converted to Instant JSON. (J#ANDR-422)
• Fixed
  Fixes an issue where text with negative font sizes caused the text to vanish in the content editor. (J#CORE-438)
• Fixed
  Fixes an unnecessary annotation update on the comment layout dismissal. (J#ANDR-329)

This patch offers a crash fix for instant users with non-Latin names. There is also a fix for a crash that happens when the typing mode for signatures is opened.

UI

• Fixed
  Fixes crash when opening the type signature screen. (J#ANDR-379)

Instant

• Fixed
  Fixes an issue where JWT tokens with Base64 URL safe encoding in the payload part didn't parse correctly. (J#CORE-492)

A few bugfixes here and there. Most notably J#ANDR-367 which can cause build failures if you are using R8 minify enabled.

UI

• Fixed
  Fixes a rare crash when highlighting text on a rotated page after long-pressing a text block. (J#ANDR-368)
• Fixed
  Fixes an issue where it wasn’t possible to input comma as decimal separator into form fields on certain Samsung devices. (J#ANDR-357)

Model

• Fixed
  Fixes an issue where text with negative font sizes caused the text to vanish in the content editor. (J#CORE-438)
• Fixed
  Fixes a memory leak in PdfStaticThumbnailBar (used in PdfFragment) related to a layout listener. (J#ANDR-353)
• Fixed
  Fixes an issue that was causing conflicts with duplicate files in external SDKs. (J#ANDR-367)
• Fixed
  Fixes an issue where the appearance of unsigned signature form fields may ignore some property changes, like their border width. (J#CORE-412)
• Fixed
  Fixes unnecessary annotation update on the comment layout dismissal. (J#ANDR-329)

PSPDFKit for Android 2024.1! Welcome to our new versioning system. We have opted for yyyy.version.patch over semantic versioning. We have expanded on our Content Editing component with paragraph editing, resize text blocks, drag and drop, text alignment, line spacing, and more. Our Digital Signatures feature now has support for Long-Term-Validation for CAdES advanced digital signatures (B-LT). Jetpack Compose is getting some much needed attention. We have added more functionality such as annotation and document listeners, plus a new public example application. See https://github.com/PSPDFKit/pspdfkit-jetpack-compose-pdf-viewer. Check out the details below for all the many fixes and improvements we have made in this release. Enjoy!

UI

• Added
  Adds dedicated section for Jetpack Compose samples in Catalog Example. (J#ANDR-216)
• Added
  Adds the ability to change the color of the PDFActivity title overlay label. (J#ANDR-278)
• Changed
  Extends the content editing feature with paragraph editing, which includes copying, pasting, creating, moving, resizing and deleting text blocks. (J#ANDR-65)
• Added
  Adds customisation options for the lines and shapes used for measurement annotations. (J#ANDR-298)
• Added
  Adds style attributes for configuring margin and selection width in the PdfScrollableThumbnailBar. (J#ANDR-308)
• Fixed
  Fixes a bug in context with text form fields and input of decimal numbers. (J#ANDR-243)
• Fixed
  Fixes a memory-leak within the DefaultBookmarkAdapter implementation. (J#ANDR-286)
• Fixed
  Fixes an issue in the Compose DocumentView where we animate to the previously opened page instead of just opening it. (J#ANDR-303)
• Fixed
  Fixes an issue where snapping was incorrectly applied to ink annotations. (J#ANDR-267)
• Fixed
  Fixes an issue where zooming was disabled when creating shape annotations. (J#ANDR-113)

Model

• API
  Adds API to add long term validation information to an existing digital signature to turn it into PAdES B-LT. (J#ANDR-283)
• API
  Adds API to use a PrivateKey object for signing instead of PrivateKeyEntry as well as loading from PEM file helper function. (#42828)
• API
  Adds TrustedKeyStore object which replaces the APIs to add and remove trusted certificates in the deprecated SignatureManager. Used for validating digital signatures. (J#ANDR-223)
• Added
  Adds a dedicated example application to showcase our new and improved Jetpack Compose APIs. This can be found in the release zip under examples/jetpack-compose and here https://github.com/PSPDFKit/pspdfkit-jetpack-compose-pdf-viewer. (J#ANDR-58)
• Added
  Adds digital signature Long-Term-Validaiton support to the document validation methods which will insert LTV data to the signature on validation if it can be retrieved. (J#ANDR-222)
• Added
  Adds support for adding annotations programmatically with the Jetpack Compose DocumentView. (J#ANDR-207)
• Added
  Adds a new example project to demonstrate new supported Jetpack Compose features. (J#ANDR-180)
• Added
  Adds support for annotation listeners in the DocumentView composable. (J#ANDR-62)
• Added
  Adds support for document listeners in the DocumentView composable. (J#ANDR-61)
• Changed
  Changes API for the customSigning lambda in SigningManager.signDocument to take non-null hash algorithm string instead of nullable. (J#ANDR-245)
• Changed
  Enables LTV (Long-Term-Validation) in PAdES signatures during the signing flow using SigningManager#signDocument creating a PAdES level B-LT digital signature. (J#ANDR-140)
• Fixed
  Fixes file access permission in Catalog for Android 11+. (J#ANDR-192)
• Changed
  Improves Document Editor performance when dealing with large documents. (#42927)
• Changed
  Migrates all the example build scripts to .kts. (J#ANDR-292)
• Removed
  Removes the usesClearTextTraffic permission from the Catalog app. This is no longer needed and causes the app to be flagged as a security risk. (#43073)
• Changed
  Upgrades project to AGP 8.2 plus various internal dependencies to latest. (J#ANDR-272)
• Fixed
  Fixes freetext annotation callout line ends when importing from XFDF. (J#CORE-297)
• Fixed
  Fixes freetext callout rendering and rich text link render on rotated pages. (J#CORE-297)
• Fixed
  Fixes vertical alignment of free text annotations when using rich text. (#42793)
• Fixed
  Fixes a crash that may happen when parsing certain kinds of outlines. (J#CORE-356)
• Fixed
  Fixes a crash while looking up character codes. (J#CORE-348)
• Fixed
  Fixes a potential IllegalStateException in the DocumentCreationFragment in very rare situations. (J#ANDR-239)
• Fixed
  Fixes a potential crash when generating AP streams. (J#CORE-364)
• Fixed
  Fixes an issue signing some kind of pre-existing form fields. (J#CORE-327)
• Fixed
  Fixes an issue where the cross-reference table may be invalid after saving a file. (J#CORE-321)
• Fixed
  Fixes an issue with file paths when using Android SAF picker to choose a file save destination. (J#ANDR-261)
• Fixed
  Fixes an issue with the instant Catalog example crashing in release mode. (J#ANDR-269)
• Fixed
  Fixes scrolling issue in Compose DocumentView. (J#ANDR-206)

UI

• Added
  Adds an option to PdfConfiguration to control the automatic invocation of the note editor after a new note annotation was created. (J#ANDR-184)
• Added
  Adds extra string translations for measurement tools. (J#ANDR-123)
• Added
  Adds support for showing the signer's timezone in the appearance of signed signature fields. (J#CORE-263)
• Added
  Adds camera option on image field click event. (J#ANDR-137)
• Fixed
  Fixes a bug which caused an IndexOutOfBoundException when updating the content of a text formfield. (J#ANDR-173)
• Fixed
  Fixes an incorrectly thrown exception when adding a note to a measurement annotation. (J#ANDR-172)
• Fixed
  Fixes bug in rendering cloudy annotations after drawing is finished. (J#ANDR-121)
• Fixed
  Fixes a bug with text form fields and input of decimal numbers. (J#ANDR-243)
• Fixed
  Fixes scrolling issue in Compose DocumentView. (J#ANDR-206)

Model

• Added
  Adds an ignorePageRotation boolean parameter to the XfdfFormatter methods. (J#ANDR-152)
• Changed
  Improves performance loading a document if automatic link extraction is enabled. (J#CORE-215)
• Changed
  Updates the default signature watermark for signed documents. (J#WEB-308)
• Changed
  Upgrades dependencies (J#ANDR-210, J#ANDR-122)

  • Changed
    Kotlin to 1.9.20
  • Changed
    Android Gradle Plugin to 8.1.3
  • Changed
    Compose 1.5
  • Changed
    Target & Compile SDK to 34
  • Changed
    And various other internal and transitive dependencies to the latest.
• Changed
  Upgrades Harfbuzz to 8.2.2. (J#CORE-275)
• Fixed
  Fixes an error 'Assertion failed: Annotation ID is already known' which may happen when opening a document. (J#WEB-233)
• Fixed
  Fixes border style selection for shape annotations in Instant JSON when strokeDashArray is not present. (J#CORE-270)
• Fixed
  Fixes rendering of tiling patterns when zooming. (J#CORE-195)
• Fixed
  Fixes XFDF export of dashed borders when cloudy borders were previously set. (J#CORE-185)
• Fixed
  Fixes Proguard consumer rules incorrectly trying to use optimize rules. (J#ANDR-167)
• Fixed
  Fixes a bug where a paste operation created the wrong annotation. (J#ANDR-208)
• Fixed
  Fixes a potential crash when showing the PopupToolbar and when initialising measurement tools. (J#ANDR-202)
• Fixed
  Fixes a rare exception when the annotation font name property may be incorrectly stored in the PDF when non-UTF-8. (J#ANDR-132)
• Fixed
  Fixes an issue where loading link annotations may incorrectly log an error. (J#CORE-281)
• Fixed
  Fixes an issue where measurement properties weren't correctly applied when importing XFDF. (J#CORE-225)
• Fixed
  Fixes an issue where text annotations imported from XFDF may not render correctly. (J#CORE-279)
• Fixed
  Fixes an issue where the wrong rich text was rendered. (J#CORE-315)
• Fixed
  Fixes an issue with the util.scand and util.printd functions of the Adobe PDF JavaScript API, which in some cases returned the wrong result. (J#CORE-271)
• Fixed
  Fixes package names for the new digital signature APIs. (#42536)
• Fixed
  Fixes an issue with the instant Catalog example crashing in release mode. (J#ANDR-269)
• Fixed
  Fixes an issue with file paths when using Android SAF picker to choose a file save destination. (J#ANDR-261)
• Fixed
  Fix file access permission in Catalog for Android 11+. (J#ANDR-192)
• Fixed
  Fixes freetext annotation callout line ends when importing from XFDF. (J#CORE-297)

Emergency patch release to fix an issue with one of our cross-platform product's license key handling.

Model

• Fixed
  Fixes a bug with cross-platform initialization. (J#ANDR-191)

See the announcement post(opens in a new tab).

Migration guide(opens in a new tab).

UI

• Added
  Adds a confirmation dialog when calibrating a measurement scale as clearer UX to show a scale was added to the list. (J#ANDR-12)
• Added
  Adds date and time picker support for form fields. (J#ANDR-87)
• Added
  Adds resize-to-fit-text functionality to the FreeTextAnnotation class. (J#ANDR-89)
• Fixed
  Fixes an issue with freetext annotations, where the text was painted over with the background color. (J#ANDR-93)
• Fixed
  Fixes vertical positioning of popup toolbars. (J#ANDR-124)
• Fixed
  Fixes and issue where selecting small amounts of text with the redaction tool causes the text to stop getting selected. (J#ANDR-105)

Model

• Added
  Adds new, simpler APIs for Digital Signatures, SigningManager. Providing PAdES level B-B (basic CAdES advances signing) and B-T (basic + timestamping) signatures. (J#ANDR-19)

  • Changed
    See our Catalog(opens in a new tab) examples DigitalSignatureExample and ManualSigningExample for examples on how to use the new API.
  • Changed
    See the migration guide(opens in a new tab) for details on migrating from our previous signature APIs.
• Changed
  Improves low memory logging and OS signal handling. (#41805)
• Changed
  Improves (reduces) memory usage on pages with a lot of vector graphics. (J#CORE-210)
• Changed
  Updates the HarfBuzz library to 8.2.1. (J#CORE-229)
• Fixed
  Fixes broken Kotlin API docs which can be accessed here https://pspdfkit.com/api/android/kdoc/. (#41683)
• Fixed
  Fixes an issue where embedded files were not transferred when using the PdfProcessor. (J#CORE-205)
• Fixed
  Fixes an issue where some color was lost when redacting documents. (J#CORE-201)
• Fixed
  Fixes an issue where the font name was incorrectly inherited in certain form hierarchies. (J#CORE-69)
• Fixed
  Fixes an issue with dependency clash when upgrading to Jetpack Compose 1.5+. (J#ANDR-94)

Instant

• Fixed
  Fixes the unsetting of annotation flags via Instant JSON. (J#CORE-183)

UI

• Fixed
  Fixes an error where a stamp annotation wasn't rendered under certain circumstances. (#41776)
• Fixed
  Fixes bug where multi-line free-text annotations are being cut off at the bottom. (J#ANDR-38)
• Fixed
  Fixes bug where the PDFOutlineView occasionally crashes when hiding. (J#ANDR-35)
• Fixed
  Fixes crash where the initialisation of the MeasurementScaleView caused a crash even when measurement tools deactivated. (J#ANDR-84)
• Fixed
  Fixes the QR code scanner in the InstantExample. (#41733)

Model

• Added
  Adds a WavWriter class which can be used to extract audio data from sound annotations and other audio sources. (#41680) Also adds a Catalog example to show how it works SoundAnnotationDataExtractionExample.
• Fixed
  Fixes a crash when trying to use the calibration tool and the tool is not enabled in the toolbar. (J#ANDR-55)
• Fixed
  Fixes an issue where rich text was converted to plain text incorrectly, missing content after new lines. (J#CORE-136)

Instant

• Fixed
  Fixes fetching of image annotation assets upon initial opening of Instant document. (J#CORE-12)

See the announcement post(opens in a new tab).

Migration guide(opens in a new tab).

Measurement Tools Improvements

• Added
  Adds support to store and select from multiple measurement scales per document. (#41035)
• Added
  Adds the ability to view measurements in fractional precision. (#40085)
• Added
  Adds support for naming scales. (#40563)
• Added
  Adds a new UI button to access measurement scales. (#40563)
• Added
  Adds a new calibration tool to help create scales. (#40563)
• Added
  Adds numerous shape drawing helpers to help draw angular lines and align points to other parts of the shape. (#40563)
• Changed
  Improves measurement unit rendering by enabling fractions such as "¹⁵⁄₁₆" instead of "15/16", and "²" instead of "sq" as well as better formatting for feet, inches, and yards. (#40960)

UI

• Added
  Adds a double click to close a polygon or polyline and finishes drawing the current shape. (#40347, #40090)
• Added
  Adds a red x hint to snap close a polyline or a polygon during creation. (#40495)
• Added
  Adds helper guides and snapping to the line shape drawing UI to make it easier for users to draw horizontal, vertical, and diagonal lines. (#40594)
• Added
  Adds shape drawing helpers to make it easier to line up points to other points on the shape. (#40746)
• Added
  Adds bold and italic style button in the ContentEditingStylingBar are now disabled if they would change the style to a font without a matching characteristics. (#39937)
• Changed
  Improves performance of annotation scale and resize code. (#40018)
• Changed
  Improves UI by hiding the PdfOutlineView and the PdfDocumentInfoView whenever the user interface is being hidden. (#39542)
• Changed
  Updates the styling and behaviour of the RedactionView button. (#40796)
• Fixed
  Fixes a bug where free text annotation text can be clipped by the border when resizing if the border is thicker than 1. (#40018)
• Fixed
  Fixes bug related to rendering of FreeTextAnnotations with multiple lines. (#40660)
• Fixed
  Fixes not being able to shrink a free text annotation easily in the UI. (#40018)

Model

• Added
  Adds additional flags invisible, readOnly, locked, toggleNoView and lockedContents to the flags property of annotations in InstantJSON. (#41335)
• Added
  Adds support for OpenType collection fonts (.otc). (J#CORE-91)
• Added
  Adds support for digitally signing a document and include a certificate chain. (#40352)
• Changed
  Improves AP stream generation to generate more optimal text rendering commands. (J#CORE-101)
• Changed
  Improves the performance of the snapping feature in complex documents. (#40414)
• Changed
  Improves embedding of OpenType CFF fonts. (#40481)
• Changed
  Improves our example applications' dependency handling using Version Catalogs as well as simplifying the structure by removing the shared module. (#40007)
• Changed
  Improves text rendering, particularly for languages that do not use the Latin alphabet. (#39812)
• Changed
  Applies patch to libtiff to fix CVE-2023-2731. (#40657)
• Removed
  Removes duplicate Java code examples that are also in Kotlin from the Catalog app. Also removes language preference option. (#40081)
• Changed
  Updates HarfBuzz to 8.0.1. (J#CORE-129)
• Changed
  Updates the Botan library to version 2.19.3. (#40107)
• Changed
  Updates the measurement snapping threshold from 20dp to 4dp. (#40917)
• Changed
  Changes the enum name FloatPrecision to MeasurementPrecision. (#40085)
• Fixed
  Fixes an issue if the content editor is used on a page without a font dictionary. (#40803)
• Fixed
  Fixes a potential crash in the Android font subsystem by switching to the more battle-tested Linux font subsystem. (#40587)
• Fixed
  Fixes a potential crash when parsing the reading order in an invalidly tagged PDF. (#40419)
• Fixed
  Fixes a rare crash that can happen when importing Instant JSON if an annotation has a non-default blend mode. (#39457)
• Fixed
  Fixes an issue when redacting images with a mask referencing a color. (#41558)
• Fixed
  Fixes an issue where 'borderColor' wasn't serialized for 'pspdfkit/text' annotations. (#40905)
• Fixed
  Fixes an issue where certain PDF documents couldn't be opened in Adobe Acrobat after flattening some form annotations. (J#CORE-79)
• Fixed
  Fixes an issue where exporting custom stamp annotations to XFDF and then importing them cause them to show blurry. (J#CORE-113)
• Fixed
  Fixes an issue where images could be inverted when redacting JBIG2 images. (#40341)
• Fixed
  Fixes an issue where processing would endless loop on malformed PDFs. (#40388)
• Fixed
  Fixes an issue where redaction annotations applied on pages with rotation may not appear correctly. (#25007)
• Fixed
  Fixes an issue where sometimes the wrong font is used when applying changes in the content editor. (#40663)
• Fixed
  Fixes an issue where the 'updatedAt' field in annotations wasn't preserved correctly when importing JSON. (#37490)
• Fixed
  Fixes an issue where the bold or italic attribute of a font got lost when saving changes from the content editor. (#40663)
• Fixed
  Fixes an issue where the cloudy border effect was set when importing InstantJSON annotations. (#40472)
• Fixed
  Fixes an issue where validating some digital signatures created by DocuSign may incorrectly report additional changes. (#39972)
• Fixed
  Fixes small signatures not being detected correctly on large signature form fields. (#40900)

Instant

• Added
  Adds API to export Instant JSON in V1 format. See DocumentJsonFormatter.exportDocumentJson(document, outputStream, InstantJsonVersion.V1). (#40611)
• Fixed
  Fixes an issue where the text highlight popup bar showed disabled buttons incorrectly in Instant. (#40058)

UI

• Fixed
  Fixes a bug where the back arrow during search is not pointing in the right direction when the layout is in RTL mode. (#40281)
• Fixed
  Fixes a bug which caused the back button in inspector detail views to be hidden. (#39953)
• Fixed
  Fixes strikeout and underline buttons missing from the text highlight popup toolbar on non-tablet devices and adds a Catalog example to show how to configure it, TextHighlightPopupCustomisationExample. (#40060)

Model

• Fixed
  Fixes a potential race condition when accessing font data in our core library. (#40587)
• Fixed
  Fixes an issue where text in multi line form field was cut off after two newlines. (#40504)
• Fixed
  Fixes library size increase due to shipping of unstripped OCR library. (#40614)
• Fixed
  Fixes the unstripped NDK library symbol files that are shipped in the SDK release zip. These can now be used to symbolicate stack traces for libpspdfkit.so crashes. (#40614)
• Fixed
  Fixes a crash that occurred when the thumbnail bar was set to PINNED mode. (#40411)

UI

• Added
  Adds support for the displayPageLabels configuration option to the modular search view and the bookmarks view. (#33658)
• Changed
  Improves calculation of the cursor position when editing a text-block in the Content Editor. (#40014)
• Changed
  Content editing inspector views can now be properly dismissed by touching outside of their view. (#40053)
• Fixed
  Fixes Settings dialog radio buttons misalignment when using a non-PSPDFKit theme. (#39970)
• Fixed
  Fixes a bug in the CustomFragmentExample where the current page was not updated in the bookmark view. (#39955)
• Fixed
  Fixes a bug with uri write permission on Android 11 devices. (#40236)
• Fixed
  Fixes the occasional wrong calculation of the vertical position of submenu toolbars. (#40277)

Model

• Added
  Adds line spacing for multiline form elements and free text annotations to match that of other platforms and external PDF viewer applications. (#39224)
• Changed
  Invalidate caches after the document is loaded in PdfFragment to avoid unsaved annotations from showing in the thumbnail bar. (#38764)
• Fixed
  Fixes a Content Editing crash in the Simple example app to do with a missing transitive dependency androidx.fragment:fragment-ktx. (#40168)
• Fixed
  Fixes a bug where the annotation toolbar did not have any menu items for large screens. (#40013)
• Fixed
  Fixes a crash when entering Content Editor in a document containing Type 3 fonts. (#3)
• Fixed
  Fixes an issue with Full-Text Search queries containing , characters. (#39309)

Instant

• Changed
  Retains the current text selection that is visible when an inspector window is displayed during content editing. (#39974)
• Fixed
  Fixes syncing annotations from the server failing after not handling a 502 error correctly. (#40288)

Model

• Fixed
  Fixes a build issue where the kotlinx-serialization-json dependency could not be downloaded. (#40029)

This release adds the Content Editor(opens in a new tab) component. You can learn more in the announcement post(opens in a new tab). If you’d like to add this component to your license, please contact our sales team(opens in a new tab) to receive a quote.

Migration guide(opens in a new tab).

UI

• Added
  Adds missing default annotation tools to the default Image Document configuration. (#39837)
• Removed
  Removes the popup toolbar which allows users to view Note Annotation comments. Clicking the Note Annotation now navigates straight to the annotation details if no annotation editing license is available. (#39577)
• Changed
  Updates the annotation creation toolbar to show measurements after drawing buttons as well as a more consistent grouping when operating in both landscape and portrait orientation. (#39661)
• Fixed
  Fixes a bug where form field rounding does not work when loading an XFDF file in onDocumentLoaded(). (#39738)

Model

• Fixed
  Fixes an issue where some annotations added to a document are not correctly exported to Instant Document JSON. (#39014)
• Fixed
  Fixes privacy concern with PSPDFKit storing system clipboard data whenever clipboard changes. Now we only copy the data when we are trying to paste an annotation. (#30691)

Instant

• Added
  Adds measurement tools to Instant for Android. (#39720)
• Changed
  Updates the Instant demo links to point to the correct Server example URL. (#39720)

Migration guide(opens in a new tab).

UI

• Fixed
  Fixes a bug where the height in dp set in a custom style for the ContextualToolbar was not converted to px. (#39526)

Model

• Added
  Adds support for a fontSize property for redaction annotations in Instant JSON, which sets the size of the redaction overlay text. (#39017)
• Added
  Adds PSPDFKit OCR library debug symbols in the release package for customers to use in the event of crashes. (#39331)
• Changed
  Improves the appearance of the overlay text in redacted documents, adjusting their font size much better to fill the available space. (#3017)
• Removed
  Removes deprecated parts of the SDK: (#38427)

  • Changed
    SignatureFormElement#getOverlappingInkSignature replaced by SignatureFormElement#getOverlappingSignature().
  • Changed
    Legacy PKCS7 constructor.
  • Changed
    Legacy PKCS7SignatureContents constructors.
  • Changed
    PdfThumbnailGrid#setOnDocumentSavedListener replaced by addOnDocumentSavedListener(OnDocumentSavedListener).
  • Changed
    PdfDrawable#getPDFToPageTransformation and PdfDrawable#updatePDFToViewTransformation replaced by getPdfToPageTransformation and updatePdfToViewTransformation.
• Changed
  Upgrades RxJava from 2 to 3. (#38838)

  • Changed
    You will need to add or upgrade the transitive dependencies for rxjava and rxandroid to: implementation 'io.reactivex.rxjava3:rxjava:3.1.6' implementation 'io.reactivex.rxjava3:rxandroid:3.0.2'
• Changed
  Upgrades the HarfBuzz library to version 7.0.1. (#36924)
• Changed
  Upgrades Android Gradle Plugin to 7.4.2, Kotlin to 1.8.10, and NDK to 25.2.9519653. (#39251)

  • Changed
    If you are manually integrating PSPDFKit, this change means you will need to change the transitive dependency for otlin-stdlib from org.jetbrains.kotlin:kotlin-stdlib to org.jetbrains.kotlin:kotlin-stdlib-jdk8.
  • Changed
    NDK upgrade means our debug symbols are back to providing full debug information after a regression in NDK v24.
• Fixed
  Fixes a crash when using a non-PSPDFKit theme and opening the SettingsDialog. (#39044)
• Fixed
  Fixes a potential crash in low memory situations. (#39373)
• Fixed
  Fixes an issue where a background image was accidentially reverted when redacting on certain PDF pages. (#39342)
• Fixed
  Fixes the LineIntent and PolylineIntent missing keys and subsequent error messages. (#39084)
• Fixed
  Fixes the maximum file name length when saving a document using the sharing UI. (#38794)

UI

• Added
  Adds an extra styling attribute, pspdf__loading_view_background_color, to customise the background colour of the LoadingView used in the PdfFragment. (#38043)
• Added
  Adds the ability to customise the height of the contextual toolbar using the attribute pspdf__contextualToolbarHeight. (#38418)
• Changed
  Improves the default User Interface design with better icons, colors, and uniformity across the toolbars. (#37954)
• Fixed
  Fixes a bug where the SDK did not pick the set colour for electronic signatures. (#35706)
• Fixed
  Fixes a bug where using cursor keys while editing text triggered a page navigation. (#38722)
• Fixed
  Fixes issue where the PdfOutlineView could not have a custom width. (#37794)
• Fixed
  Fixes the search highlight drawable's default behaviour of overlapping of extra characters by updating the default padding for search results to 0dp. This value can still be customized in SearchResultHighlighter and by using pspdf__searchResultPadding and pspdf__searchResultAnnotationPadding style items. (#32848)

Model

• Changed
  Improves UI performance of the Catalog home screen by reducing unnecessary recomposition of Composables. (#37992)
• Changed
  Improves onTrimMemory behaviour by running in coroutine scope. (#34467)
• Changed
  Improves text parsing and text selection. (#38089)
• Removed
  Removes un-maintained lint-checks module in favour of providing Catalog examples and website guides for SDK usage instructions. (#38391)
• Changed
  Updates Android Gradle plugin version to 7.4.0. (#38375)
• Changed
  Updates Harfbuzz to 6.0.0. (#38024)
• Changed
  Updates deprecated EditTextPreference with androidx.preference. (#38428)
• Fixed
  Fixes a crash caused by interacting with Note annotations when both Annotation Editing and Electronic Signature license features are missing. (#39095)
• Fixed
  Fixes a crash when opening the settings dialog in the Simple example app. (#38834)
• Fixed
  Fixes an issue where applying a redaction annotation may incorrectly invert the colors of certain documents. (#38722)
• Fixed
  Fixes an issue where memory usage was very high when searching large documents. (#37893)
• Fixed
  Fixes an issue where saving a PDF file with a indirect null object could cause a crash. (#39127)
• Fixed
  Fixes an issue where the file size increased too much after adding emojis. (#38393)
• Fixed
  Fixes an issue where the package versions in README.html were not updated correctly when creating the release package. (#38181)
• Fixed
  Fixes an issue where the redaction tool may incorrectly displace text in some situations. (#38642)
• Fixed
  Fixes an issue where the unicode checkmark character wasn't rendered correctly. (#36785)
• Fixed
  Fixes displaying the current page on rotation when configuration.page() and .restoreLastViewedPage(true) are used together. (#37699)
• Fixed
  Fixes janky .java file formatting throughout the codebase including public facing code and examples. (#29084)
• Fixed
  Fixes some issues where the redaction tool may incorrectly remove more vector graphics than strictly necessary. (#38295)
• Fixed
  Fixes the InlineMediaExample Catalog example YouTube links behaviour by starting the YouTube API service in the manifest. (#38953)
• Fixed
  Fixes the redaction button moving up the screen each time the user exits full screen mode. (#36079)

See the announcement post(opens in a new tab).

UI

• Added
  Adds two presets for the settings dialog which allow to quickly switch between two common vertical and horizontal view configurations. (#35295)
• Added
  Adds a popup toolbar which allows users to view Note Annotation comments if no annotation editing license is available. (#34780)
• Changed
  Improves small screen device experience by showing settings view as a fullscreen dialog. (#34055)
• Changed
  Improves the annotation toolbar appearance. (#35152)
• Changed
  Updates the appearance of the PdfThumbnailBar. (#34977)
• Fixed
  Fixes an initialization issue in the annotation inspector with the line-end property of the freetext callout annotation. (#36824)
• Fixed
  Fixes an issue where full-color items where not displayed correctly in contextual toolbars because tinting couldn't be disabled. (#19009)

  • Changed
    Improves CustomAnnotationCreationToolbarExample adding a full-color item and showcasing how to disable tinting.
• Fixed
  Fixes the release build variants for example apps Catalog and Simple. (#35923)

Model

• Added
  Adds Hebrew localization. (#36047)
• Added
  Adds a ImageDocumentView composable for loading image documents. (#36881)
• Added
  Adds support for converting multi-image TIFF files to multi page PDFs. (#36108)
• Added
  Adds support for serializing and deserializing annotations with measurement info to the XFDF format. (#36936)
• Added
  Adds support for the non-standard imagedata XFDF element in stamp annotations. (#36518)
• Changed
  Improves calculation of line height when a line is wrapped in a multi-line text form. (#36385)
• Changed
  Improves compatibility with other PDF software when rendering multi-line form field text. (#37072)
• Changed
  Improves error handling in the DocumentSharingController to catch a possible ActivityNotFoundException. (#37494)
• Changed
  Changes the "showAsAction" value for default menu items and adds interface OnPrepareDefaultMenuItemListener for customising these values. (#35283)
• Changed
  Exposes the instant record group of an annotation with Annotation#getInstantRecordGroup(). (#36993)
• Changed
  Implements two new methods FormProvider#removeFormElementFromPage(FormElement) and FormProvider#removeFormElementFromPageAsync(FormElement) for deleting form fields. (#34318)
• Added
  Adds and incorporates a new icon set. (#35290)
• Changed
  Updates libexpat to version 2.5.0. (#37257)
• Changed
  Updates Android Gradle plugin version to 7.3.1. (#36148)

  • Changed
    Updates compile SDK and target SDK to version 33, Compose extension to version 1.3.2, Compose to version 1.3.0, Kotlin version to 1.7.20 and Kotlin Coroutines to version 1.6.4.
• Changed
  Updates PDFium to version c3451daffa0e96af95b856406668e6188cb139d0. (#36256)
• Changed
  Updates SQLite to version 3.39.3. (#36337)
• Changed
  Updates the HarfBuzz library to 5.2.0. (#36547)
• Changed
  Updates the HarfBuzz library to version 5.1.0. (#35186)
• Changed
  Updates ktlint and spotless to the latest versions improving public Kotlin code formatting and best practices. (#37512)
• Fixed
  Fixes a crash while redacting documents containing the ' PDF operator. (#36778)
• Fixed
  Fixes an exception when importing annotations with measurement information from Instant JSON. (#36537)
• Fixed
  Fixes an issue generating PDFs from HTML when checkboxes are defined and customer stylesheets are referenced in the HTML head. (#34453)
• Fixed
  Fixes an issue when using undo/redo on shape annotations could throw an exception if Measurements are not licensed. (#37678)
• Fixed
  Fixes an issue where JPEG2000 images were rendered blurry. (#37829)
• Fixed
  Fixes an issue where form field flags weren't preserved correctly when repairing form fields. (#33878)
• Fixed
  Fixes an issue where passing a new license key does not reinitialise license features, and therefore may cause an exception from a license feature mismatch between Android and our Core C++ library. (#37822)
• Fixed
  Fixes an issue where paths in content may not be rendered. (#35988)
• Fixed
  Fixes an issue where redacting certain documents may render some document pages blank. (#35776)
• Fixed
  Fixes an issue where redaction draws invalid black boxes on the page. (#37863)
• Fixed
  Fixes an issue where sharing a PDF to Google Drive did not open up the Drive app dialog. (#36095)
• Fixed
  Fixes an issue where specific PDFs could cause a crash when you quickly switch between pages. (#37498)
• Fixed
  Fixes an issue where temporary files could have been written into /. (#36239)
• Fixed
  Fixes an issue where text selection wasn't working properly on PDFs with corrupted fonts. (#32468)
• Fixed
  Fixes an issue where the font information for annotations wasn't loaded correctly. (#36933)
• Fixed
  Fixes an issue with custom font paths where subfolders in assets are not picked up correctly. (#36366)
• Fixed
  Fixes an issue where the package versions in README.html were not updated correctly when creating the release package. (#38181)
• Fixed
  Fixes crashes related to font loading in specific documents. (#36284)

Instant

• Fixed
  Fixes an issue where syncing of a newly created annotation in a fresh document would sometimes not work. (#37552)
• Fixed
  Fixes the Annotation Eraser tool not appearing in the annotation toolbar when using PSPDFKit Instant for Android. (#37952)

UI

• Changed
  Improves the label for area measurements in the annotation inspector. (#35726)
• Changed
  Improves Dark Theme example in the Catalog app adding a new customized style for pspdf__popupToolbarStyle. (#36338)
• Changed
  Updates sample PDFs in Catalog app. (#32347)
• Fixed
  Fixes a potential crash during the SystemFontManager initialization. (#36444)
• Fixed
  Fixes an issue where the measurement text view could cause a ViewRootImpl$CalledFromWrongThreadException. (#36280)

Model

• Changed
  Avoids a crash if the NativeTextParser cannot be obtained. (#36445)
• Fixed
  Fixed a crash by avoiding to create zero-sized bitmaps. (#36429)
• Changed
  Updates libexpat to version 2.4.9. (#36612)
• Fixed
  Fixes a crash after a null clipboard data was received. (#36446)
• Fixed
  Fixes a license issue validating or adding annotations with measurement information via Instant JSON. (#36660)
• Fixed
  Fixes a rare crash when trying to refresh a FreeTextAnnotation with an invalid scaling value. (#36447)
• Fixed
  Fixes an issue where AP streams weren't reliably generated for form text fields. That resulted in other readers potentially not showing the text. (#36236)
• Fixed
  Fixes an issue where certain documents could cause a crash when opening them. (#36272)
• Fixed
  Fixes an issue where font styles weren't always discovered correctly. (#35955)

See the announcement post(opens in a new tab).

UI

• Added
  Adds a Catalog example showcasing the new PSPDFKit for Android Measurement Tools. Includes example measurements and logic for processing them and listening for newly created measurements. (#35452)
• Added
  Adds a measurement value display above the magnifier as a helpful way of observing the currently edited measurement value while drawing. This fixes the issue of the magnifier or finger obscuring the measurement value on the page. (#34650, #35200, #35349)
• Added
  Adds new style attribute to the PSPDFKit.MeasurementTools style to customize the background color of the pop up view. (#35821)
• Added
  Adds annotation inspector support for configuring page scale used for measurement annotation tools. (#33914)
• Added
  Adds annotation inspector support for floating point precision used in measurement tools. (#33579)
• Added
  Adds support for calibrating the length of a distance annotation in order to help set the page scale based on a known distance. (#34156, #34396)
• Added
  Adds support for the Android magnifier to appear when creating and editing measurements to help with making more precise measurements. (#34110)
• Added
  Adds the Measurement Tools feature including distance, perimeter, and area (elliptical, rectangular, polygonal) measurements. (#33967)
• Added
  Adds the distance measurement tool used to measure the distance of a line on the page. (#33579, #34204, #34316, #34627, #34933, #35150, #35064)
• Added
  Adds the perimeter measurement tool in the annotation toolbar used to measure cumulative line distances. (#34596, #35061, #35064)
• Added
  Adds the polygonal area measurement tool in the annotation toolbar used to measure the area of custom-drawn shapes. (#35024, #35064)
• Added
  Adds the rectangular and elliptical area measurement tools in the annotation toolbar. These can be used to help measure round or box shaped objects on the PDF. (#34991, #34962)
• Changed
  Improves the measurement magnifier behavior by increasing zoom amount and hiding the edit handle that is currently being touched so as to better see the measurement point. (#35533)
• Changed
  Implements displaying the measurement value in the Annotation Editing Inspector. (#35726)
• Changed
  Updates annotation inspector z-order picker icon tint to dark blue. (#35526)
• Changed
  Updates minimum supported API version for the native magnifier to API 29 from API 28 in order to support the measurement tools value text to be displayed above it. (#35246)
• Changed
  Updates the Catalog examples list with new sections "Industry Examples" and "Components", and updates some of the Catalog PDF assets. (#35618)
• Changed
  Updates the default annotation toolbar groups to make room for, and add, measurement annotation tools. (#33447)
• Changed
  Updates the support magnifier (used on APIs < 29) to match the rounded corners of the native magnifier. (#35624)
• Fixed
  Fixes an issue where lines with a length less than 1 are still counted as valid. (#35716)

Model

• Added
  Adds API to get measurement information on the base Annotation class: getMeasurementInfo. (#34538)
• Added
  Adds API to set scale and precision on a ShapeAnnotation programmatically, thus making them measurement annotations. (#35390)
• Added
  Adds new LineAnnotation, PolylineAnnotation, PolygonAnnotation, CircleAnnotation, and SquareAnnotation constructors for creating measurement annotations programmatically. (#35071)
• Added
  Adds new license feature flag, "Measurement Tools", checked when configuring the annotation toolbar, creating/editing measurements, and other measurement API calls. (#34495, #34531)
• Added
  Adds support for storing and retrieving measurement annotation data inside the document. (#34351)
• Changed
  Updates the minimum required Android SDK version for native magnifier support to API 29 from API 28. Users with pre API 29 devices will rely on the support magnifier. (#35246)
• Fixed
  Fixes an issue where measurement text was not getting rendered when drawing shapes very quickly. (#35419)

See the announcement post(opens in a new tab).

UI

• Added
  Adds PlaygroundExample to the Catalog app that shows how to customize the behavior of the PdfActivity. (#35206)
• Added
  Adds new construction example to the Catalog app that shows how to better configure PSPDFKit to display a building floor plan. (#33433)
• Added
  Adds new example ContainedPadesSignaturesExample to the Catalog app showcasing how to embed PKCS7 container as a PAdES Advanced Digital Signature. (#33251)
• Added
  Adds new menu item to the main toolbar that shows document info view. (#34480)
• Added
  Adds new circle, line, line arrow, polyline, square, and polygon icons to Annotation Creation and Annotation Editing Toolbars. (#35271)
• Fixed
  Fixes a crash when a full-page rendering was requested with a width or height of zero. (#32871)
• Fixed
  Fixes an issue affecting the scrubber bar where, on certain devices, the scrolling may lead to a crash. (#32551)
• Fixed
  Fixes an issue with Jetpack Compose where the annotation inspector appears only once. (#33556)
• Fixed
  Fixes an issue with the annotation overlay implementation where the page loading spinner was not hidden correctly after a page was rendered. (#35424)
• Fixed
  Fixes permission errors when saving external files on Android 12 and higher. (#34928)
• Fixed
  Fixes the External Document examples in the Catalog to properly open documents from Google Drive. (#35248)
• Changed
  Updates visual appearance for the document tab bar. (#34865)

Model

• Added
  Adds support for PAdES (ETSI.CAdES.detached) signing method. (#33251)

  • Changed
    Implements FilterSubtype to specify the format to use when creating the signasture.
  • Removed
    Deprecates PKCS7SignatureContents constructors in favor of new ones where the filter subtype can be explicitly set.
  • Removed
    Deprecates method PKCS7#create(byte[], KeyStore.PrivateKeyEntry, HashAlgorithm) in favor of a new one where the filter subtype can be explicitly set.
• Changed
  Improves XFDF serialization of ink annotations by including their variant. (#34354)
• Changed
  Improves error reporting when an invalid license key is entered. (#33758)
• Changed
  Changes the default color for annotation note to yellow, to match PSPDFKit for Web and iOS. (#34145)
• Changed
  Changes the stamp annotation creation so that if only one StampItem is available, the stamp picker dialog is skipped and the annotation is created with the only item available. (#34282)
• Fixed
  Fix insufficient Android 12 uri permission handling in ContentResolverDataProvider. (#35578)
• Fixed
  Fix package name for SignatureBitmapStorage class that was erroneously set to a wrong one. (#35273)
• Changed
  Overloads the method AbstractPdfSearchView#performSearch(String, EnumSet<CompareOptions>) adding a new parameter to customize the compare options when performing a search action. (#35217)
• Removed
  Removes the RECORD_AUDIO permission from the Android manifest file that was erroneously added in a previous release. To delve more into the topic refer to the Audio Recording Permission(opens in a new tab) section of our guides. (#34424)
• Changed
  Updates boost to 1.79.0. (#34723)
• Fixed
  Fixes a crash on Android 12 and higher when trying to persist Uri permissions for internal files. (#35535)
• Fixed
  Fixes the error "The timestamp token couldn't be parsed" that may appear with some digital signature timestamps. (#35394)
• Fixed
  Fixes an issue in the Catalog app where Kotlin examples were launched instead of Java examples. (#35103)
• Fixed
  Fixes an issue when importing a InstantDocument JSON where both a form field and a form annotation were modified at the same time. (#35454)
• Fixed
  Fixes an issue where dates weren't parsed correctly due to the parser being too strict. (#34079)
• Fixed
  Fixes an issue where form fields were showing NaN (not a number) if the form value could not be formatted correctly. This returns an empty string now and shows an error message in the console. (#34017)
• Fixed
  Fixes an issue where having huge amounts of data on the clipboard can cause a DeadSystemException. (#34487)
• Fixed
  Fixes an issue where the PdfSearchViewModular visibility state is not initialized correctly, thus breaking the isShown() method. (#34391)
• Fixed
  Fixes an issue where the dialog for adding notes was transparent and causing glitches if the property COLOR was disabled. (#34055)
• Fixed
  Fixes an issue where the file size of the PDF grew a lot when entering Arabic text into form fields. (#35381)
• Fixed
  Fixes an issue where the swipe gesture wasn't applied correctly for the horizontal paginated layout on several PDF documents. (#31886)
• Fixed
  Fixes an issue where the wrong text was highlighted when searching. (#33867)
• Fixed
  Fixes corruption of CMYK colorspace images in PDFs after redaction. (#34453)
• Fixed
  Fixes the query of potential document sharing targets for devices running Android 11 and higher. (#34542)
• Fixed
  Fixes an issue affecting Android API 29 and upwards where saving a document reusing the same filename may lead to a document saved with the wrong extension. (#35728)

Model

• Fixed
  Fixes a crash when trying to setup a database which violated a unique constraint. (#34027)
• Fixed
  Fixes an issue when accessing a SQLite database concurrently. (#34027)
• Changed
  Improves cache handling of forms in case of exceptions by logging the message instead of crashing the process. (#34027)
• Changed
  Updates the Zlib library to version 1.2.12. (#34305)
• Changed
  Updates the Freetype library to version 2.12.1. (#34326)
• Fixed
  Fixes an issue where retrieving annotations from the AnnotationProvider using object numbers was returning an empty list although matching annotations were available. (#34270)

See the announcement post(opens in a new tab).

UI

• Added
  Adds a "Remove Signature" button to the SignatureInfoDialog. (#33113)
• Added
  Adds a cloudy annotation item to the default annotation creation toolbar. (#32909)
• Changed
  Defaults border style to BorderStyle.SOLID for Polygon annotation. (#31998)
• Removed
  Removes initial permission check from External Document example and shows request permission dialog with extensive info. (#16772)
• Fixed
  Fixes a problem where some form fields with JavaScript formatting scripts may be incorrectly formatted with thousands separators. (#32596)
• Fixed
  Fixes a problem where the Sign overlay of unsigned signatures may incorrectly appear in some situations. (#32310)
• Fixed
  Fixes a problem where the outline elements of some documents did not point to the correct page. (#32970)
• Fixed
  Fixes a problem with the SaveAs file picker not allowing to specify a new filename. (#33023)
• Fixed
  Fixes font size calculations for freetext annotation font scaling. (#33229)

Model

• Added
  Adds getSelectedPages() method to PdfThumbnailGrid. (#33032)
• Added
  Adds more detailed logging for signature verification errors during development of custom signing implementations. (Z#28856)
• Added
  Adds new methods removeAllDocuments and removeAllDocumentsExceptVisible to the DocumentCoordinator class. (#19494)
• Added
  Adds support for validating RSA-PSS digital signatures. (#33006)
• Changed
  Improves PdfDocument#getPageBox method where returned values are now normalized. Widths and heights, may no longer be less than 0. (#32764)
• Changed
  Avoids a NoSuchElementException if DocumentView is destroyed before it had finished layout. (#33841)
• Changed
  Ensures invalidateCacheForPage does not need to be called to refresh the page render after removing a signature with removeSignature. (#33095)
• Changed
  Includes in the downloadable binary release the unstripped NDK symbols into the unstrippedNativeLibs folder. (#32864)
• Changed
  Includes support for new page boundaries bleed box and trim box exposing two new types PdfBox.BLEED_BOX and PdfBox.TRIM_BOX. (#33749)
• Changed
  Updates Duktape to version 2.7.0. (#33161)
• Changed
  Updates Kotlin Standard library to version 1.6.10. (#34031)
• Changed
  Updates Android Gradle plugin to version 7.1.2. (#34031)
• Changed
  Updates Compose to version 1.1.1. (#34031)
• Changed
  Updates Kotlin Coroutines to version 1.6.1. (#34031)
• Changed
  Updates ReLinker to version 1.4.4. (#34031)
• Changed
  Updates Android Material library to version 1.5.0. (#34031)
• Changed
  Updates Activity Compose to version 1.4.0. (#34031)
• Changed
  Updates Lifecycle Kotlin runtime to version 2.4.1. (#34031)
• Changed
  Updates SQLite3 to version 3.38.0. (#33239)
• Changed
  Updates XMP toolkit to version 2022.02. (#32824)
• Changed
  Updates libtiff to version 4.3.0. (#33050)
• Changed
  Updates the Harfbuzz library to version 4.2.0. (#33765)
• Changed
  Updates the license contained in the binary release, switching in favor of a markup file that contains a link to a PDF document in PSPDFKit website. (#33673)
• Changed
  Upgraded the androidx.appcompat dependency to the latest stable version 1.4.1. (#32967)
• Fixed
  Fixes a crash on getShadowBitmap() where the RenderScript object might not yet be initialized. (#33668)
• Fixed
  Fixes a crash when deserialising image annotations from JSON that references an incompatible existing annotation from the PDF. (Z#28946, #32861)
• Fixed
  Fixes a crash when flattening note annotations in compound documents. (#33041)
• Fixed
  Fixes a crash when rendering a specific type of documents on multiple threads at the same time. (#33110)
• Fixed
  Fixes an issue running OCR on a page that contains an image with no text. (#31709)
• Fixed
  Fixes an issue when trying to run OCR on a blank page. (#33771)
• Fixed
  Fixes an issue where PdfFragment#handleDocumentLoadingError(Throwable, boolean) may have a null throwable leading to a crash. (#33903)
• Fixed
  Fixes an issue where onPageChanged is called twice when changing page for the first time. (#19365)
• Fixed
  Fixes an issue where adding a digital signature may invalidate previous ones because of some spurious rounding-related changes to the page boxes. (#32952)
• Fixed
  Fixes an issue where an old trailer was loaded in PDFs with hybrid cross-reference tables causing old information to be shown. (#32243)
• Fixed
  Fixes an issue where calling SignatureFormField#removeSignature() may not clear the signed signature appearance. (#32965)
• Fixed
  Fixes an issue where certain form fields weren't repaired correctly. (#33878)
• Fixed
  Fixes an issue where font lookup might cause a crash because fonts weren't correctly initialized yet. (#33593)
• Fixed
  Fixes an issue where form buttons weren't able to import images with buttonImportIcon if they were located on pages other than the first. (#33364)
• Fixed
  Fixes an issue where imported stamp annotations wouldn't be modified. (#33030)
• Fixed
  Fixes an issue where read-only signature fields may incorrectly show a "Sign" overlay. (#32310)
• Fixed
  Fixes file permission handling in the document editor which caused the popup of a dialog with wrong information about the permission status. (#32755)
• Fixed
  Fixes issues surrounding rendering Devanagari script. (#33753)
• Fixed
  Fixes libtiff CVEs CVE-2022-0561 and CVE-2022-0562. (#33480)
• Fixed
  Fixes manual initialization so we do not automatically default to trial mode if the user fails to initialize manually. (#33577)
• Fixed
  Fixes parsing of page labels with indirect objects in the number tree. (#33657)

Model

• Changed
  Updates libexpat to 2.4.6. (#33300)
• Fixed
  Fixes a rare crash that happened when loading fonts. (#33110)
• Fixed
  Fixes an occasional crash in the DocumentView when trying to clean up toolbars with an uninitialized toolbar coordinator. (#33304)

UI

• Changed
  Improves Catalog performance by minimising Jetpack Compose recomposition. (#32817)
• Fixed
  Fixes the certificate identifier name getting truncated in the SignaturePickerFragment. (#32717)

Model

• Added
  Adds a more descriptive error when trying to sign documents with keys stored in the Android KeyStore. (#32913)
• Added
  Adds support for additional manifest parameters to allow for disabling automatic initialization and proper custom font initialization. (#32330, #30651)
• Changed
  Updates Expat library to 2.4.4. (#32841, #32790)
• Changed
  Updates STB library to 2.27. (#32326)
• Changed
  Updates the Android Gradle Plugin used by all example apps to version 7.1.0. (#32839)
• Fixed
  Fixes an issue where the user is incorrectly prompted if the changes should be discarded when exiting the DocumentEditor with unsaved changes. (#5905, #32557)
• Fixed
  Fixes a NullPointerException when calling DocumentView#removeListeners() before the documentPopupToolbarCoordinator initialization. (#31762)
• Fixed
  Fixes a glyph rendering issue when new lines are used in form fields. (#31733)
• Fixed
  Fixes an issue where objects were rendered with the wrong color due to non-compliant color values. (#30102)
• Fixed
  Fixes an issue where the redaction tool may leave some old PDF object references if the page contents are an array of content streams. (#32926)
• Fixed
  Fixes null pointer access violation if clipboard data cannot be accessed on Android 12. (#32661)
• Changed
  Upgrades the androidx.appcompat dependency to the latest stable version 1.4.1. (#32967)

UI

• Fixed
  Fixes StampAnnotation flags not being properly applied to layout parameters. (#27426, #31848)
• Fixed
  Fixes a crash when putting data on the clipboard without the necessary permission. (#31692, #29215)
• Fixed
  Fixes ink signature annotations getting alpha blended into form field backgrounds when they are excluded from the annotation overlay view. (#31474)

Model

• Added
  Adds support for searching form field contents when the option to search annotation contents is enabled. (#26502)
• Removed
  Deprecated setOnDocumentSavedListener and introduced addOnDocumentSavedListener/removeOnDocumentSavedListener, because overwriting the default implementation with setOnDocumentSavedListener broke the document editor. (#31550)
• Changed
  Updates the HarfBuzz library to 3.1.0. (#31771)
• Changed
  Upgrades UID generation for the MemoryDataProvider from SHA1 to SHA256. (#28673)
• Fixed
  Fixes PdfThumbnailGrid.setDocumentEditorSaveAsEnabled and setDocumentEditorExportEnabled being ignored if set before the thumbnail grid was shown. (#31678, #31789)
• Fixed
  Fixes a bitmap retention issue that could lead to out-of-memory situations in documents with many shape annotations. (#31154)
• Fixed
  Fixes a crash in PDFActivity when creating an options menu with incomplete PDF-parameters. (#32271, #28906)
• Fixed
  Fixes a crash when trying to calculate tab ordering for documents. (#24082)
• Fixed
  Fixes a crash when trying to dismiss a SignatureFragment while a fragment transaction is already in progress. (#32301, #28906)
• Fixed
  Fixes a crash when trying to open an invalid URI in an external activity. (#32270, #28906)
• Fixed
  Fixes a crash when trying to render an empty bitmap. (#32359, #28906)
• Fixed
  Fixes a stability issue accessing the file system that can happen in rare situations. (#32467)
• Fixed
  Fixes an issue where persisting dates or times in forms may be off by one hour in some situations. (#32201)
• Fixed
  Fixes an issue with file access when loading custom fonts when instantiating AnnotationCreationSpecialModeHandler. (#27712)
• Fixed
  Fixes importing of Instant Document JSON containing image annotations onto a rotated page. (#32021)
• Fixed
  Fixes importing of Instant Document JSON containing multiple radio buttons of the same label. (#31855)
• Fixed
  Fixes importing of Instant Document JSON where image annotations have been moved. (#31945)
• Fixed
  Fixes memory leak when closing documents with form fields. (#31557)
• Fixed
  Fixes rendering black when a screen annotation with image is tapped. (#31584)
• Fixed
  Fixes the annotation image picker not working on Android API 30+. (#31915)

UI

• Fixed
  Fixes the current page of the DocumentState not being kept in sync with the open document. (#31689)
• Fixed
  Fixes an issue where manual document alignment for the document comparison feature would produce incorrect results for rotated pages. (#31681)

Model

• Changed
  Exposes the getExportValue method for the CheckBoxFormElement type. (#25122)
• Changed
  Handles exception when dispatching tap onto form element before a page is ready. (#30274)
• Fixed
  Fixes a Magnifier issue where onDetachedFromWindow calls would crash the application under certain conditions. (#31700)
• Fixed
  Fixes an issue where annotations weren't always rendered in the correct z-order. (#31671)
• Fixed
  Fixes an issue where the appearance stream of unsigned signature fields wasn't rendered. (#31015)

Instant

• Changed
  Improves the behavior of reauthentication before accessing the document of an InstantDocumentDescriptor. (Z#27871)
• Changed
  Improves the level of detail in log messages when failing to access the record store to help diagnosing obscure I/O errors. (#31815)

Model

• Fixed
  Fixes a crash when restoring the ElectronicSignatures dialog from parcel data on low memory devices. (#31602)
• Fixed
  Fixes a memory leak when validating digital signatures. (#31520)
• Fixed
  Fixes an issue where setting event.value inside a validation script may not work as expected. (#31286)

See the announcement post(opens in a new tab).

This release adds the Electronic Signatures(opens in a new tab) and built-in support for Jetpack Compose(opens in a new tab) via the DocumentView composable function(opens in a new tab). If you'd like to add Electronic Signatures to your license, please contact our sales team(opens in a new tab) to receive a quote. To learn more about the breaking changes introduced with the new APIs, check out our migration guide(opens in a new tab) for this release.

UI

• Added
  Adds built-in support for Jetpack Compose via the DocumentView composable function. (#30779)
• Added
  Adds support for Electronic Signatures.

  • Added
    Adds a new signing UI with the ElectronicSignatureFragment, along with associated APIs, as part of the Electronic Signatures component. (#29282)
  • Added
    Adds new public ID R.id.pspdf__menu_option_signature for a signature creation button in the main toolbar. (#28065)
  • Added
    Adds new styleable attributes pspdf__signatureIcon and pspdf__signatureIconActivated for the signature creation button in the main toolbar.
  • Added
    Adds new configuration option PdfActivityConfiguration#isSignatureButtonPositionForcedInMainToolbar(boolean) to set the signature creation button position in the main toolbar.
• Added
  Adds automatic free text annotation font resizing when scaling the annotation using the bottom right corner scale handle. (#29382)
• Added
  Adds document alignment feature to improve the existing document comparison functionality. (#30461)

  • Added
    Adds DocumentComparisonDialog class that can be used to align two versions of a document and generate a comparison between them.
  • Changed
    Updates the existing DocumentComparisonExample to showcase the new document comparison and alignment features.
• Changed
  Improves precision of scrolling and zooming operations within PdfFragment as well as precision of calculations performed by ViewProjection. (#31214)
• Removed
  Removes PdfActivityToolbarApi class which was not used by PSPDFKit for Android. (#30836)
• Fixed
  Fixes PdfActivity immersive mode inset handling on API 29+ devices. (#30190)
• Fixed
  Fixes a crash that could happen when navigating to a page containing a newly created LinkAnnotation. (#30232)
• Fixed
  Fixes ink signature annotations getting alpha blended into form field backgrounds when they are excluded from the annotation overlay view. (#31474)
• Fixed
  Fixes the isCopyPasteEnabled configuration option not being respected. (#30654)

Model

• Changed
  Improves rendering non-latin text (like Arabic) when selecting specific fonts. (#30517)
• Changed
  Reduces memory consumption when encoding JPEG images. (#31205)
• Changed
  Reduces memory consumption when PDF objects need compressing. (#31317)
• Changed
  Renames methods on PdfDrawable to follow the SDK-wide camel casing convention. (#31186)

  • Removed
    Deprecates updatePDFToViewTransformation() and getPDFToPageTransformation().
  • Added
    Adds updatePdfToViewTransformation() and getPdfToPageTransformation().
• Changed
  Updated FreeType to version 2.11.0. (#30900)
• Changed
  Updated libjpeg-turbo to 2.2.1. (#30900)
• Changed
  Updates HarfBuzz to 3.0.0. (#31113)
• Changed
  Updates our compile SDK version to Android API level 30. (#30316)
• Fixed
  Fixes a potential race condition when validating a digital signature and adding a trusted certificate happens at the same time. (#31305)
• Fixed
  Fixes an assertion if the rotation property was removed from an annotation. (#31173)
• Fixed
  Fixes a potential crash on certain devices when rotating the device. (#30871)
• Fixed
  Fixes a problem where a PDF table of contents (outline) may link to the wrong page. (#30070)
• Fixed
  Fixes a rare crash that may happen when rendering a PDF. (#29843)
• Fixed
  Fixes a very occasional crash when parsing stamp annotations that contained images references to invalid indirect objects. (#31093)
• Fixed
  Fixes an issue where XFDF annotations like lines without an explicit width attribute were not rendered. In these cases, we now mimic Acrobats behavior and imply a line width of 1 pt. (#30291, Z#25968)
• Fixed
  Fixes an issue where a digital signature may incorrectly report a certificate validation error. (#30521)
• Fixed
  Fixes an issue where fonts were not correctly included in the PDF resulting in wrongly rendered free text annotations. (#30115)
• Fixed
  Fixes an issue where highlight annotations used the wrong blend mode after importing with Instant JSON. (#30537)
• Fixed
  Fixes possible undefined behavior validating digital signature data. (#31179)
• Fixed
  Fixes signature form fields not being included when using a license purchased after April 2021. (#30950)

Instant

• Added
  Adds support for Instant Document Permissions. (#29789)

Examples

• Added
  Adds Catalog examples for Electronic Signatures and splits out the Digital Signature and Electronic Signature examples. (#30878)
• Changed
  Updates the custom signing UI examples to use the new Electronic Signatures UI. (#30561)

See the announcement post(opens in a new tab).

Migration guide(opens in a new tab).

UI

• Added
  Adds configurable minimum annotation size through PdfConfiguration.Builder#setMinimumAnnotationSize(). (#20200)
• Changed
  Improves API documentation for custom annotation selection background. (#27677)
• Changed
  Improves the Annotation Selection Layout example where the custom configuration for the annotation selection layout was lost after a page rotation. (#27678)
• Changed
  Updates the main toolbar icons for creating note annotations, showing outline section, printing, showing the reader view, opening settings, and creating a new signature. (#28669)
• Fixed
  Fixes PdfActivity immersive mode inset handling on API 29+ devices. (#30190)
• Fixed
  Fixes an issue where calling AnnotationProvider#hasUnsavedChanges() on the UI thread leads to ANR. (#28656)
• Fixed
  Fixes an issue where callout annotation text was rendered incorrectly. (#27600)
• Fixed
  Fixes an issue where ink annotation bounding boxes were incorrectly rotated. (#27148)
• Fixed
  Fixes an issue where read-only ink annotations that were created while the eraser tool was active could be erased. (#27944)
• Fixed
  Fixes an issue where switching tabs while having annotation selected could result in duplicated annotations. (#29875)
• Fixed
  Fixes an issue where tapping outside page bounds while an annotation tool was selected would end the annotation editing mode. (#28633)
• Fixed
  Fixes an issue where the app would crash when requesting camera access from the system. (#27609)
• Fixed
  Fixes an issue where the selection UI could display the wrong bounding box for programmatically created annotations on rotated pages. (#28242)
• Fixed
  Fixes an issue where the WebView wouldn't be properly finished after dismissing a LinkAnnotation. (#28965)
• Fixed
  Fixes a crash that could happen when navigating to a page containing a newly created LinkAnnotation. (#30232)

Model

• Added
  Adds a new method to set custom fonts for typed signatures Signature#setAvailableFonts(LinkedHashSet<Font>) (#28416)

  • Added
    Adds a new method to retrieve the available fonts to pick from when typing a signature. By default a set of four fonts is provided: Caveat, Pacifico, Marck Script, Meddon.
• Added
  Adds support for blend mode in all annotations when using Instant JSON. If blendMode is not specified, it defaults to normal. (#29582)
• Added
  Adds the ability to open TIFF images as Image Documents. (#28776)
• Changed
  Changes minSdkVersion from API 19 (KitKat) to API 21 (Lollipop). (#24917)
• Changed
  Updates FreeType to 2.10.4.179. (#28676)
• Changed
  Updates HarfBuzz to 2.8.0. (#28598)
• Changed
  Updates libjpeg-turbo to 2.0.90. (#27771)
• Changed
  Updates the Botan library to 2.18.0. (#29123)
• Fixed
  Fixes an issue where calling PdfDocument#saveIfModified() would not save the document back to the original file if the document was previously saved to an external file using PdfDocument#saveIfModified(outputPath). (#29776)
• Fixed
  Fixes a problem where a document signed with a timestamp would not validate correctly. (#29380)
• Fixed
  Fixes a problem where an ECDSA signature in IEEE 1363 format would not validate correctly. (#29380)
• Fixed
  Fixes a rendering issue for specific documents that have font resources with /Widths that are to small to render. (#28103)
• Fixed
  Fixes an issue when setting form field datetimes that have JavaScript formatting. (#27939)
• Fixed
  Fixes an issue where JavaScript code was not executed correctly. (#29283)
• Fixed
  Fixes an issue where OCR would fail if no text is on the page. Now the call returns successfully. (#29527)
• Fixed
  Fixes an issue where an invalid digital signature would return the same error code more than once. (#27512)
• Fixed
  Fixes an issue where certain timestamps would not be preserved because of an incorrect sanitization step. (#27720)
• Fixed
  Fixes an issue where deleting a note annotation could incorrectly print an error message to the log. (#28240)
• Fixed
  Fixes an issue where form fields were not interactive after a document with JavaScript was merged with another document. (#28052)
• Fixed
  Fixes an issue where importing a 'goToRemote' without a page index would fail. (#29616)
• Fixed
  Fixes an issue where importing unknown actions using Instant JSON failed. (#29814)
• Fixed
  Fixes an issue where loading from a checkpoint for a document failed in certain instances. (#27576)
• Fixed
  Fixes an issue where negative values didn't include thousand separators when being formatted by AFNumber_Format in JavaScript. (#28188)
• Fixed
  Fixes an issue where not all data was shown on a small amount of documents containing hybrid cross-reference streams. (#28713, #24258)
• Fixed
  Fixes an issue where paths could accidentally be filled in, even though only the border should have been painted. (#28699)
• Fixed
  Fixes an issue where redactions of paths could fail with Coordinate outside allowed range if the path coordinates were very large. (#29791)
• Fixed
  Fixes an issue where some digital signatures with indefinite length structures were not validated correctly. (#26983)
• Fixed
  Fixes an issue where some saved documents contained a xref table with more than one subsection. This may have caused problems if the document was signed multiple times, for example. (#28755)
• Fixed
  Fixes an issue where some signatures with timestamps couldn't be parsed correctly and returned an error. (#28642)
• Fixed
  Fixes an issue where text extracted from an image using OCR was not selectable on the macOS Preview.app. (#28329)
• Fixed
  Fixes an issue where the bounding box of automatically generated link annotations wasn't large enough. (#27608)
• Fixed
  Fixes an issue where the framework would write unnecessary entries to the PDF trailer dictionary. (#28755)
• Fixed
  Fixes an issue where the signature description was cut off in narrow signature fields. (#27540)
• Fixed
  Fixes an issue with OCR where no text was found if the text on the page was relatively large. (#29512)
• Fixed
  Fixes an issue where the Instant JSON would contain redundant data after removing a form field. (#29671)
• Fixed
  Fixes a crash that could happen when opening documents and image documents at the same time in different threads. (#29468)

Instant

• Added
  Adds support for the Instant Comments component. (#28345)
• Added
  Adds support for specifying blend mode for shape annotations in Instant JSON. (#29081)
• Added
  Adds support for the (optional) creator_name claim in JWTs: All annotations and comments created in the InstantPdfFragment displaying the InstantPdfDocument for a JWT containing this claim will reflect its value as their creator. (#29507)
• Fixed
  Fixes a lock inversion that could lead to a deadlock. (#29743)
• Fixed
  Fixes an issue where flattened Instant Comments on rotated pages didn't correctly display text. (#28272)

UI

• Fixed
  Fixes an issue affecting freetext annotations where text justification was not set correctly for Arabic languages. (#29327)

Model

• Changed
  Changes PSPDFKit.initialize method to allow passing a null value as licenseKey to allow trialing the SDK. (#27297)

Model

• Changed
  Updates Expat to 2.2.10. (#27472)
• Changed
  Updates OpenJPEG to version 2.4.0. (#27917)
• Fixed
  Fixes an issue in the text parser where space characters were being omitted from the returned text. (#28886)
• Fixed
  Fixes an issue where selectedResultIndex from saved state exceeds the search results' upper bounds causing an IllegalArgumentException. (#27665)
• Fixed
  Fixes a problem where the 'name' property of the PDF JS 'field' object may not return a correct value when the field is part of a hierarchy. (#27770)
• Fixed
  Fixes an issue where a cache miss in the annotation cache could lead to a crash when using compound documents. (#25594)
• Fixed
  Fixes an issue where calculating the tab order failed with database is locked or similar SQLite errors. (#24082)
• Fixed
  Fixes an issue where list boxes would not render text when a item is selected if there was no DA field present. (#28536)

UI

• Fixed
  Fixes an additional issue where the signature description was cut off in narrow, short signature fields. (#27540)
• Fixed
  Fixes an issue where custom scale handle drawables would be shown in the wrong corner on rotated pages. (#27679)
• Fixed
  Fixes an issue where pages sizes were calculated incorrectly after resizing the PdfFragment causing overlay view sizes to be wrong. (#27864)
• Fixed
  Fixes a NullPointerException that could be thrown due to a race condition after calling PdfFragment#notifyLayoutChanged(). (#22744)

See the announcement post(opens in a new tab).

Migration guide(opens in a new tab).

UI

• Added
  Adds support for setting bold and italic fonts via FreeTextAnnotation#setFontName(). (#25843)
• Changed
  Improves annotation selection UI customization by introducing AnnotationSelectionViewThemeConfiguration. (#26212)

  • Added
    Adds AnnotationSelectionController#getAnnotationSelectionViewThemeConfiguration() to get the theme configuration used to customize the annotation selection view.
  • Added
    Adds AnnotationSelectionController#setAnnotationSelectionViewThemeConfiguration(AnnotationSelectionViewThemeConfiguration) to set a theme configuration to customize the annotation selection view.
  • Added
    Adds new Java example AnnotationSelectionViewStylingActivity that shows how to customize the annotation selection layout.
• Fixed
  Fixes an issue affecting some foreign languages where the inline search layout had the wrong spacing when no results were found. (#24577)
• Fixed
  Fixes an issue where internal usage of specific resource identifiers on com.pspdfkit.R would lead to crashes when using PSPDFKit inside a dynamic feature module. (#26984)
• Changed
  Improves documentation for custom annotation selection background as this feature is not supported by callout annotations. (#27677)
• Fixed
  Fixes an issue where callout annotation text was rendered incorrectly. (#27600)
• Fixed
  Fixes an issue where ink annotations' bounding boxes were incorrectly rotated. (#27148)
• Fixed
  Fixes an issue where the app would crash when requesting camera access from the system. (#27609)

Model

• Added
  Adds a new document signature integrity status for when the digital signature type that is being validated is not supported. (#25030)
• Added
  Adds constant field WidgetAnnotation.FONT_SIZE_AUTO which can be used with setFontSize() to enable automated font sizing for form fields. (#25595)
• Added
  Adds diagnostic information to SigningFailedException. (Z#22316)
• Added
  Adds method WidgetAnnotation#setFontSize() to set the font size for text form fields. (#23522)

  • Changed
    Renames WidgetAnnotation#getTextSize() to getFontSize(). The old method is now deprecated and will be removed with PSPDFKit 7 for Android.
• Added
  Adds new version of sqlite3 used in full text search. Upgrading from version 3.27.0 to 3.34.0. (#27459)
• Added
  Adds support for finding the correct form field type in non-conforming PDF files. (#26459)
• Added
  Adds support for parsing multiple certificates inside a single .pem file. (#26396)
• Added
  Adds support for validating PAdES B digital signatures. (#25153)
• Added
  Adds the option to change the vertical text alignment for FreeTextAnnotations and WidgetAnnotations: (#23523)

  • Added
    Adds FreeTextAnnotation#set/getVerticalTextAlignment() to set and get the vertical text alignment.
  • Added
    Adds WidgetAnnotation#set/getVerticalTextAlignment() to set and get the vertical text alignment.
• Changed
  Improves font selection process for bold and italic fonts. (#26719)
• Changed
  Improves how certificate expiration in digital signatures is handled. (#27047)
• Changed
  Improves performance loading some documents with broken internal links (named destinations). (#24398, #26099)
• Changed
  Improves performance with path drawing by removing unnecessary path operations. (#25922)
• Changed
  Improves rendering performance of documents with lots of image patterns. (#26186)
• Changed
  Improves simplified and traditional Chinese font selection. (#26674)
• Changed
  Digital signatures don't show framework version numbers when inspected using third party software. (#26183)
• Changed
  Reduces the memory required to load PDF documents by 15% to 35%, depending on the document. (#27182)
• Removed
  Removes DeviceYearClass(opens in a new tab) dependency that has been now deprecated, and adds an in-house implementation that does not require a third-party library to optimize the default configuration. (#24036)
• Changed
  Updates Botan to 2.17.1. (#26794)
• Changed
  Updates Duktape to 2.6.0. (#26435)
• Changed
  Updates Kotlin to 1.4.21. (#26805)
• Changed
  Updates the Android Gradle Plugin used by all example apps to version 4.1.1. (#26806)
• Fixed
  Fixes a problem where signing a document again after filling a form field may invalidate existing digital signatures. (#25637)
• Fixed
  Fixes a problem where some DER-encoded signatures may not be validated correctly. (#25757)
• Fixed
  Fixes a problem where the signature reason, name or location may not appear correctly if they contain non-ASCII characters. (#26671)
• Fixed
  Fixes an assert that was triggered by malformed documents that contained fonts that were not indirect objects. (#26450)
• Fixed
  Fixes an issue in the Document Editor when adding an item to a imported page. (#25837)
• Fixed
  Fixes an issue where OCR could not be performed on a certain image due to an incorrect render scale. (#26118)
• Fixed
  Fixes an issue where an app would crash on trying to load an embedded file in a PDF document created using multiple data providers. (#26023)
• Fixed
  Fixes an issue where appearance streams weren't re-generated when using the processor even though 'NeedAppearances' was set in the PDF. (#26123)
• Fixed
  Fixes an issue where documents with high object numbers were identified as corrupt. (#26062)
• Fixed
  Fixes an issue where form calculation was triggered when setting an empty string on a form field that didn't have a value. (#26345)
• Fixed
  Fixes an issue where importing annotation appearance streams from XFDF would not work. (#25100)
• Fixed
  Fixes an issue where partially redacted curved path objects may be misdrawn. (#26698)
• Fixed
  Fixes an issue where paths overdraws resulting in incorrect shapes. (#27330)
• Fixed
  Fixes duplication of newly created pages in the Document Editor. (#26074)
• Fixed
  Fixes rendering a wrong color if the color was using a ICC color profile and the color was out of bounds. (#26535)
• Fixed
  Fixes text clipping for form fields exceeding their maxLen due to programmatic changes. (#26340)
• Fixed
  Fixes the PDF JavaScript function getNthFieldName to return the FQN of the form field. (#26144)
• Fixed
  Fixes an issue where loading from a checkpoint for a document failed in certain instances. (#27576)
• Fixed
  Fixes an issue where the signature description was cut off in narrow signature fields. (#27540)

PSPDFKit 6.5.3 is a security patch release fixing a single CVE in one of our dependencies.

• Fixed
  Fixes CVE-2020-15999 in upstream dependency Freetype. (#26610)

UI

• Added
  Adds new style attributes to the PSPDFKit.AnnotationSelection style to customize annotation selection UI: (#25552)

  • Added
    Adds style attributes to change the drawable for each of the eight annotation scale handles: pspdf__topLeftScaleHandleDrawable, pspdf__topCenterScaleHandleDrawable, pspdf__topRightScaleHandleDrawable, pspdf__centerLeftScaleHandleDrawable, pspdf__centerRightScaleHandleDrawable, pspdf__bottomLeftScaleHandleDrawable, pspdf__bottomCenterScaleHandleDrawable, pspdf__bottomRightScaleHandleDrawable.
  • Added
    Adds pspdf__rotationHandleDrawable style attribute to change the drawable of the rotation handle.
  • Added
    Adds pspdf__backgroundDrawable to change the background drawable of the annotation selection layout.
• Changed
  Improves performance of Reader View feature by only starting the reflow process when the view is shown and cancelling it when the view is hidden. (#24400)
• Fixed
  Fixes an issue related to tabbed documents where under certain conditions switching document may lead to an ANR. (#24693)
• Fixed
  Fixes an issue where PdfFragment could become unresponsive when opening PDF documents with many pages and forms. (#25911)
• Fixed
  Fixes an issue where the blending between the selected text element background color and the document background was not calculated correctly for colors with transparency. (#24156)
• Fixed
  Fixes an issue where the input EditText inside the custom stamps dialog would use the wrong input type and accept multi-line text. (#25871)
• Fixed
  Fixes an issue where the keyboard was not correctly hidden when a free text annotation was selected but not in writing mode. (#25886)
• Fixed
  Fixes an issue where the zoom level of protected documents was not calculated correctly. (#24934)

Model

• Added
  Adds support for PEM format PKCS#1 private keys for use with digital signatures. (#24919)
• Changed
  Improves Processor behavior when license doesn't include the forms component. (#24604)
• Changed
  Improves font rendering in forms with Chinese, Japanese, Korean and Thai characters. (#24337)
• Changed
  Improves log reducing noise in the OCR Library by removing unnecessary log messages in release mode. (#25532)
• Changed
  Enhances the flattening of note annotations by rendering the root comment rather than the note icon. (#22673)
• Changed
  OCR now uses NEON and AVX intrinsics for better performance. (#24870)
• Changed
  Updates HarfBuzz to version 2.7.2. (#25717)
• Fixed
  Fixes FTS queries with three or more words when searching for an exact match when using the unicode tokenizer. (#25068)
• Fixed
  Fixes a crash that could happen as a result of a race condition when form fields were repaired and the page was rendered at the same time. (#24885)
• Fixed
  Fixes a crash that could happen when creating form fields. (#25806)
• Fixed
  Fixes a problem where some certificates with CRL distribution point extensions may not be validated correctly. (#24660)
• Fixed
  Fixes an issue where appearance streams of form field widgets weren't preserved correctly. (#25550)
• Fixed
  Fixes an issue where Bézier paths were drawn incorrectly when a miter limit was set. (#25758)
• Fixed
  Fixes an issue where form elements were included in the page rendering which shouldn't have been. (#25799)
• Fixed
  Fixes an issue where form fields may not be editable in some cases. (#23123)
• Fixed
  Fixes an issue where image annotations could not be imported from XFDF files. (#25100)
• Fixed
  Fixes an issue where text form fields weren't displayed correctly after flattening due to their appearance stream being wrong in the original document. (#24918)
• Fixed
  Fixes an issue where the digital signature advanced properties contained the signature creator twice. (#25611)
• Fixed
  Fixes an issue where warning messages were displayed in other readers when flattening a signature form field. (#25923)
• Fixed
  Fixes duplicate string occurrences when copy and pasting from documents with duplicate content. (#25108)
• Fixed
  Fixes form field JavaScript actions in the generated documents when merging two or more documents together. (#25603)
• Fixed
  Fixes the placement of the popup annotation linked to a note annotation. When a note annotation is moved, the popup annotation will now follow the location and is always placed within the bounds of the page. (#24468)
• Fixed
  Fixes the saving of small shapes with large line widths. Shapes with these characteristics in documents saved by PSPDFKit will now be visible on any reader. (#25531)

Examples

• Added
  Adds new AnnotationSelectionViewStylingExample that shows how to customize the annotation selection layout. (#25552)
• Added
  Adds new PdfFromImageExample which shows how to convert image files to PDF files using the PdfProcessor. (#24996)

UI

• Changed
  Improves scrolling to page in continuous mode so that the scrolling goes to the beginning of the page, not the middle. (#24364)
• Fixed
  Fixes an issue where document scrollbars were not visible when using PdfFragment inside a custom activity. (#24174)
• Fixed
  Fixes an issue where paste option is available on document long-press even if disabled by PdfConfiguration. (#24685)
• Fixed
  Fixes an issue where selecting a form field from a different page programmatically, would not switch page or would not show keyboard if the page was switched manually. (#24364)

Model

• Changed
  Improved handling of native references which could previously lead to performance issues in documents with with large numbers of annotations. (#23587)
• Fixed
  Fixes a problem where signing a document with existing digital signatures may invalidate them. (#24780)
• Fixed
  Fixes an issue last viewed PdfFragment page restoration would crash if DocumentDataStore would not be properly initialized. The exception is now logged since it's not critical for the work of the PdfFragment. (#22428)
• Fixed
  Fixes an issue where objects rendered with the Overlay blend mode didn't always render correctly. (#24298)
• Fixed
  Fixes an issue where our text parser returned descending characters from the line above the intended search area. (#24709)
• Fixed
  Fixes an issue where text with word or character spacing is shifted after redaction has been applied. (#24476)

See the announcement post(opens in a new tab).

UI

• Added
  Adds values-v21/dark_theme.xml which holds API 21+ theme overrides for PSPDFKit.Theme.Dark. (#24511)

  • Changed
    Sets android:navigationBarColor to @color/pspdf__dark_status_bar on API 21+, to darken the navigation bar when using the dark theme without immersive mode.

Model

• Added
  Adds support for OCR (optical character recognition) processing. (#24247)

  • Added
    Adds a new Maven artifact com.pspdfkit:pspdfkit-ocr that can be added as dependency to an app for integrating OCR capabilities.
  • Added
    Adds multiple Maven artifacts com.pspdfkit:pspdfkit-ocr-[language] which can be added as dependencies to an app to enable OCR for a particular language. Currently supported languages are croatian, czech, danish, dutch, english, finnish, french, german, indonesian, italian, malay, norwegian, polish, portuguese, serbian, slovak, slovenian, spanish, swedish, turkish, and welsh.
  • Added
    Adds enum class com.pspdfkit.document.processor.ocr.OcrLanguage which lists all languages that are currently supported for performing OCR on.
  • Added
    Adds method performOcrOnPages(Set<Integer>, OcrLanguage) to PdfProcessorTask.
  • Added
    Adds OcrExample to Catalog app.
• Changed
  Updates GSL to version 3.1.0. (#24480)
• Changed
  Updates HarfBuzz to version 2.6.7. (#24477)
• Fixed
  Fixes an issue where resolving broken named references inside PDF dictionaries could lead to crashes. (#24599)
• Fixed
  Fixes a very rare crash on certain documents when multiple pages were rendered at the same time. (#24598, #24626)
• Fixed
  Fixes an endless loop while trying to repair form field. (#23901, #24597)
• Fixed
  Fixes an issue where umlauts were displayed wrong in certain documents because the wrong encoding was used when shaping the text. (#24465)

See the announcement post(opens in a new tab).

Migration guide(opens in a new tab).

UI

• Added
  Adds new Reader View component for displaying reflowed PDF content. (#23959)

  • Added
    Adds com.pspdfkit.ui.PdfReaderView that can be added to any view hierarchy for displaying reflowed document content.
  • Added
    Adds an instance of PdfReaderView to PdfActivity which is accessible via a new primary toolbar action with the ID R.id.pspdf__menu_option_reader_view. The reader view toolbar action is disabled by default, and can be enabled using PdfActivityConfiguration.Builder#enableReaderView(boolean).
  • Added
    Adds a ReaderViewExample to the Catalog which demonstrates how to configure and use PdfReaderView inside a PdfActivity instance.
• Added
  Adds a warning toast message when saving a digitally signed document fails using the default DocumentSigningListener. (#24166)
• Fixed
  Fixes an issue where calling PdfFragment#zoomTo(Rect, int, long) wouldn't precisely zoom to the given rect on the page in continuous scroll mode. (#23566)
• Fixed
  Fixes an issue where color selection buttons in the signature picker dialog were not displayed. (#24121)
• Fixed
  Fixes an issue where high-res page rendering is not working properly on Android devices running API < 24. (#24069)
• Fixed
  Fixes an issue where shape annotations could be drawn outside of the page. (#23873)

Model

• Added
  Adds the OfficeToPdfConverter which allows you to perform conversion from office documents to PDF documents using a remote PSPDFKit Server instance. (#24201)
• Added
  Adds support for file:///android_asset/ URIs when using SignatureGraphic.fromBitmap(android.net.Uri). (#24081)
• Changed
  Improves quality of fallback font rendering. (#24136)
• Changed
  Improve style sheet parsing to recognize font names better. (#23968)
• Removed
  Removes framework internal PageLayout class from public API. (#24318)
• Changed
  Updates PdfProcessorTask#mergePage() to auto-rotate the page to match the rotation of the destination page. (#23858)
• Fixed
  Fixes a dangling pointer upon destruction of PSPDFKit. (#24387)
• Fixed
  Fixes a possible UntaggedSocketViolation strict mode violation that could be emitted by the internal framework code. (#23688)
• Fixed
  Fixes a problem where the asset name of a screen annotation would not be decoded correctly in some cases. (#24269)
• Fixed
  Fixes a problem where the font name of a free text annotation would not be decoded correctly in some cases. (#24269)
• Fixed
  Fixes an issue where flattening of form fields on pages with an offset artbox would cause a visual shift of form elements. (#23385)
• Fixed
  Fixes an issue where combo boxes with attached JavaScript actions would fail to execute the attached actions when changing their value. (#23120)
• Fixed
  Fixes an issue where non-latin text wouldn't render correctly. (#23287)
• Fixed
  Fixes an issue where properties of Annotation instances which were created using the XfdfFormatter.parseXfdf() method would be reset upon adding the annotations to a PdfDocument using AnnotationProvider#addAnnotationToPage(). (#24030)
• Fixed
  Fixes an issue where text was rendered incorrectly when the 'comb' option was used. (#24395)
• Fixed
  Fixes an issue where wrong characters were displayed in multi-line form fields. (#23317)
• Fixed
  Fixes edits to the page binding not being saved in certain documents. (#24115)
• Fixed
  Fixes warnings that were logged due to unused FlatBuffers properties. (#24412)

Instant

• Added
  Adds a new error code to InstantErrorCode for the case where syncing fails due to the size of the sync payload exceeding the server limit: PAYLOAD_SIZE_LIMIT_EXCEEDED. (#23293)
• Fixed
  Fixes an issue where receiving and decoding yet unsupported annotation types could lead to a crash. (#23752)

Examples

• Added
  Adds HideRevealAnnotationsCreationExample that shows how to add two special annotations that can be used to obscure the document. (#23544)
• Added
  Adds TeacherStudentExample that shows how to swap between documents and sync view state, annotations, and bookmarks. (#23546)
• Added
  Adds BookmarkHighlightingExample showing how to render a bookmark indicator on the thumbnail bar and thumbnail grid. This uses the PDF drawable API to render the indicator. (#23796)
• Added
  Adds PersistentAnnotationSidebarExample showing how to put a list of all annotations in a persistent sidebar next to a PdfUiFragment. (#24401)
• Changed
  Updates the Android Gradle Plugin used by all example apps to version 3.6.3. (#23995)

See the announcement post(opens in a new tab).

UI

• Added
  Adds support for changing the background color and hiding the sign here overlay that is shown in signature form fields. (#14685)

  • Added
    Adds Pdf[Activity]Configuration#showSignHereOverlay() to enable and disable the sign here overlay arrow being shown.
  • Added
    Adds PdfActivityConfiguration#enableMagnifier() to enable and disable the magnifier being shown.
  • Added
    Adds new style attribute pspdf__signHereOverlayBackgroundColor to control the background color of the sign here arrow. This should be added to pspdf__FormSelection style.
• Added
  Adds support for keeping multiple PdfFragments in the same view hierarchy. (#23619)
• Added
  Adds PdfUiFragmentBuilder#pdfFragmentTag() to configure a custom tag to be used for the internally hosted PdfFragment.
• Added
  Adds activityClass() to PdfActivityIntentBuilder and InstantPdfActivityIntentBuilder that accept Kotlin's KClass type as activity class. (#23681)
• Changed
  Improves multimedia UI by adding the black background to the videos and by not allowing overlapping control bars. (#19279)
• Changed
  Improves search performance by filling the page cache with already parsed pages. (#15947)
• Fixed
  Fixes an issue where undo/redo did not revert/reapply the last action after importing a document in Document Editor. (#23361)

  • Added
    Adds method PdfDocumentEditor#addPages(int, List<NewPage>) to allow Document Editor to import multiple pages to a destination index.
• Fixed
  Fixes a possible NullPointerException that could be emitted while quickly switching between opened tabs. (#23440)
• Fixed
  Fixes a potential IllegalStateException that could have been thrown when trying to render the image of a recycled page view. (#23591)
• Fixed
  Fixes an issue where "Accepted" and "Rejected" stamps border size changed slightly when rotated. (#19404)
• Fixed
  Fixes an issue where Redo command might have failed after importing a document in Document Editor. (#23362)
• Fixed
  Fixes an issue where PdfFragment could get stuck while loading password protected document. (#23521)
• Fixed
  Fixes an issue where annotation inspector did not save properties of edited callout annotations to annotation preferences. (#23441)
• Fixed
  Fixes an issue where document outline and document info views were not updated after switching documents. (#23427)
• Fixed
  Fixes an issue where items in the annotation list were displayed in the wrong order. (#23469)
• Fixed
  Fixes an issue where the soft keyboard did not hide after dismissing the note editor by tapping outside of its dialog window. (#23650)
• Fixed
  Fixes an issue where under certain conditions a crash could occur when the password view was displayed in a Xamarin Forms application. (#23300)
• Fixed
  Fixes an issue where it was possible to create invisible redaction annotations. (#19716)

Model

• Added
  Adds KDoc support(opens in a new tab) available offline in the binary release. (#16045)
• Added
  Adds new getTargetFormFieldsAsync() method to AbstractFormAction. (#16968)
• API
  The id passed in for MenuItem that contains submenuIds now always contains group to differentiate it from simple items. (#23262)

  • Changed
    Existing ids (pspdf__annotation_creation_toolbar_item_markup, pspdf__annotation_creation_toolbar_item_drawing, etc.) were kept and a warning is emitted if they are used. This warning will be replaced by an exception in the next major release PSPDFKit for Android 7.0.
  • Changed
    For your own menu item groupings make sure to pass in the newly added ids when creating items with sub item.
  • Added
    Added ids pspdf__annotation_creation_toolbar_group_markup, pspdf__annotation_creation_toolbar_group_drawing, pspdf__annotation_creation_toolbar_group_writing, pspdf__annotation_creation_toolbar_group_multimedia, pspdf__annotation_creation_toolbar_group_undo_redo. pspdf__annotation_editing_toolbar_group_undo_redo, pspdf__annotation_editing_toolbar_group_copy_cut, pspdf__annotation_editing_toolbar_group_inspector, pspdf__annotation_editing_toolbar_group_edit_share, and pspdf__document_editing_toolbar_group_more.
• API
  Deprecates OnTextSelectionPopupToolbarShowListener. This class will be removed with PSPDFKit 7 for Android. (#23487)
• Changed
  Updates Kotlin to 1.3.71. (#23832)
• Changed
  Updates NDK to version 21.0.6113669. (#23426)
• Changed
  Updates ReLinker to 1.4.1. (#23633)
• Changed
  Updates RxJava to 2.2.7 and RxAndroid to 2.1.1. (#23518)
• Changed
  Updates PdfUiFragment to internally use the child fragment manager, this fixes a crash that could happen in our react-native wrapper. (#23673)
• Changed
  Updates the Android Gradle Plugin to 3.6.2. (#23449)
• Changed
  Improves consumer proguard rules. (#23658)

  • Removed
    Removes -renamesourcefileattribute SourceFile rule since it caused issues with some bug reporting solutions.
  • Changed
    Ignores Proguard warnings for com.pspdfkit.internal.
• Fixed
  Fixes a potential issue resulting in data loss after saving. (#23474, #23485)
• Fixed
  Fixes an issue flattening form fields correctly when the ArtBox of the page contains an offset. (#23385)
• Fixed
  Fixes an issue that caused a crash when rendering certain pages from multiple threads. (#23209, #23339)
• Fixed
  Fixes an issue where document save listener was not notified when saving image documents. (#23472)
• Fixed
  Fixes an issue where loading multiple unavailable documents into the DocumentCoordinator could lead to crash. (#23705)
• Fixed
  Fixes an issue where multiple form elements that are related to the same form field could not be targeted as a group in JavaScript actions, as described by the PDF Reference. (#22755)
• Fixed
  Fixes an issue where shared image documents were empty. (#23416)

  • Changed
    Document save methods of the image document's PdfDocument now throw UnsupportedOperationException. Use saveIfModified() on the ImageDocument instance instead.
• Fixed
  Fixes an issue where spacing between words was far too large. (#23439)
• Fixed
  Fixes an issue where the HTML-to-PDF converter could not be initialized on devices using the AOSP WebView instead of Chromium. (#23776)
• Fixed
  Fixes an issue where the JNI's limit of a maximum number of 65k global references could lead to a crash due to not releasing annotation objects requested through user interaction or through API calls. (#23587)
• Fixed
  Fixes an issue where values of text form fields were only visible after being selected. (#23652)
• Fixed
  Fixes internal form initialization and caching logic that could lead to a deadlock when changing form values while the forms were initializing. This could happen in multiple scenarios, for example when importing Document JSON or changing form values via JavaScript. (#23617)
• Fixed
  Fixes potential document corruption when incremental saving encrypted documents. (#23689)
• Fixed
  Fixes some rare stability issues when filling a form document with JavaScript scripts. (#23443)

Instant

• Added
  Adds support for stamp annotations in Instant. (#19737)
• Added
  Adds detailed error message when Instant connection fails. (#23574)
• Fixed
  Fixes an issue where documents shared from Instant did not contain annotations. (#23377)

Examples

• Changed
  Improves Kotlin examples coverage in Catalog. (#11429)

  • Changed
    Shows language badges (Kotlin or Java) next to each example in the examples list.
  • Added
    Adds a configuration option to the Catalog preferences for choosing the preferred programming language. Kotlin is now the default preferred language.
  • Added
    Adds Kotlin version for most existing examples.
• Changed
  Improves the structure of Catalog and Instant examples. (#23534)

  • Changed
    Renames the Instant example package to com.pspdfkit.instant.example. Renames the Catalog package to com.pspdfkit.catalog.
  • Changed
    Extracts shared example code into a module named shared which is now used by both of these examples.

See the announcement post(opens in a new tab).

Migration guide(opens in a new tab).

• Changed
  Updates the Android Gradle Plugin to 3.5.3. (#23079)

UI

• Removed
  Deprecates setPdfView(), performApplyConfiguration(), getPdfParameters() and getHostingActivity() in PdfActivity and PdfUiFragment. These symbols were never meant for public usage and will be removed with the next major version. (#22933)
• Changed
  Moves internal PdfUiImpl from public package com.pspdfkit.ui to obfuscated internal package as it was never meant for public usage. If you were using it, please contact our support with your specific use case. (#22999)

  • Removed
    Deprecates PSPDFKitViews#getFragment(), use getPdfFragment() defined on either PdfActivity or PdfUiFragment.
• Added
  Adds UI indication if the current font of a freetext annotation is not supported on the current device. (#22155)

  • Changed
    Font#getDefaultTypeface() is now nullable. A null value indicates that this font isn't supported on the current device.
• Added
  Adds localized strings for British English (en-rGB locale). (#23092)
• Added
  Adds support for undoing the removal of annotations after using the "Clear All" button inside the annotation list. (#20310)

  • Added
    Adds PdfOutlineView#setUndoManager() to configure the undo manager that is used for tracking annotation removals.
• Changed
  Improves animations when scrolling to search results in inline search. (#22921)
• Changed
  Improves document loading and UI performance. (#23166)

  • Changed
    Improves performance when zooming pages with multiple ink or stamp annotations.
  • Changed
    Improves document loading times for larger documents when the license supports digital signatures.
  • Added
    Adds PdfDocument#getDocumentSignatureInfoAsync() to retrieve the signature info in a non-blocking manner. PdfDocument#getDocumentSignatureInfo() should no longer be called on the main thread.
• Changed
  Improves document loading performance when having the redaction UI disabled using the PdfActivityConfiguration.Builder#setRedactionUiEnabled(). (#22927)
• Changed
  Improves page rendering performance. (#22298)

  • Changed
    Increases priority for rendering visible pages.
  • Changed
    Optimizes time to prepare annotation overlay.
  • Changed
    Delays display of page loading view. This improves feeling when switching to pages that are rendered fast or have cached rendering.
• Changed
  Improves property inspector behavior. (#22072)

  • Changed
    PropertyInspectorCoordinatorLayout now internally uses bottom sheet implementation from the material components library.
  • Fixed
    Fixes property inspector in immersive mode.
  • Removed
    Deprecates setResizable() and isResizable() in PropertyInspector. Property inspector does not support resizing anymore.
• Changed
  Improves share dialog by automatically sanitizing the initial document name. (#23240)
• Changed
  Changes the type of dates shown inside the annotation list from annotation creation dates to annotation last modified dates. This change is done to align behavior with PSPDFKit for iOS and PSPDFKit for Web. (#22373)
• Changed
  Multiple annotation defaults were changed to be consistent with PSPDFKit for other platforms (Web and iOS). This includes default line thickness, text size, cloudy border intensity and eraser thickness defaults. (#22611)
• Changed
  Sound annotations recording is now disabled when microphone is not available on the device. (#23215)
• Changed
  Updates the icon for creating note annotations. (#23052)
• Changed
  Updates tooltips and accessibility labels in the annotation creation toolbar. (#22839)

  • Changed
    "Highlight" is now called "Text Highlight"
  • Changed
    "Strike Out" is now called "Strikethrough"
  • Changed
    "Text: Callout" is now called "Callout"
  • Changed
    "Ink: Pen" is now called "Drawing"
  • Changed
    "Ink: Highlighter" is now called "Freeform Highlight"
  • Changed
    "Ink: Magic" is now called "Magic Ink"
  • Changed
    "Line: Arrow" is now called "Arrow"
• Fixed
  Fixes a crash that could occur when using the navigation buttons after removing pages from a document using the document editor and saving it in place. (#22969)
• Fixed
  Fixes a possible IllegalArgumentException that could have been thrown when saving document info when page binding was unknown. (#23273)
• Fixed
  Fixes an issue where JavaScript function buttonImportIcon did not scale imported images correctly. (#22967)
• Fixed
  Fixes an issue where annotations that were being created were rendered behind already added annotations instead of on top of them. (#22619)
• Fixed
  Fixes an issue where callout annotations would be rendered incorrectly after rotating the page using the document editor. (#22911)

  • Fixed
    Fixes an issue where editing rotated callout annotations would break their layout.
• Fixed
  Fixes an issue where long-pressing a page which was not readily loaded would sometimes cause a crash. (#22973)
• Fixed
  Fixes an issue where making changes in the document info view and saving them in a document provided by a non writable data provider would lead to a crash. (#23205)

  • Changed
    The editing button is now hidden in the document info view when we detect that the current document is not writable.
• Fixed
  Fixes an issue where opening a tab that has the inline search view open would also open the keyboard again. (#23088)
• Fixed
  Fixes an issue where some strings were not translated correctly if the locale was not supported on the device. (#23271)
• Fixed
  Fixes an issue where text in multiline free-text annotations could be cut-off until selected. (#22982)
• Fixed
  Fixes an issue where the thumbnail grid performance would degrade when it was loaded alongside other views. (#23098)
• Fixed
  Fixes an issue where touching the screen with a second finger while annotating would remove the current drawing. (#23283)
• Fixed
  Fixes a possible IllegalStateException that could be thrown in PdfThumbnailGrid after enabling user interface. (#23373)

Model

• API
  Moves private PSPDFKit API's from package com.pspdfkit.framework to package com.pspdfkit.internal, as well as from com.pspdfkit.instant.framework to com.pspdfkit.instant.internal respectively. (#22985)
• Added
  Adds custom lint check to ensure that android:configChanges is not configured for PdfActivity classes. (#22543)
• Added
  Adds support for HTML-to-PDF conversion. (#22660)

  • Added
    Adds HtmlToPdfConverter as an entry point for this API.
  • Changed
    This feature requires HTML to PDF Conversion enabled in your license.
• Added
  Adds stricter validation to digital signature containers created externally. (#23011)
• Added
  Adds support for incrementally saving encrypted documents. (#22722)
• Added
  Adds support for the JavaScript function 'doc.gotoNamedDest'. (#18957)
• Added
  Adds support for validating digital signatures created by DocuSign. (#22191)
• Changed
  Improves license check error messages to be more user friendly. (#12904)
• Changed
  Improves performance of JPEG decoding by enabling SIMD instructions. (#22797)
• Changed
  Improve compatibility with macOS 10.15 Preview for annotation notes in the sidebar. (#22791)
• Fixed
  Fixes PDF Javascript when scripts are encoded in UTF-16. (#23044)
• Fixed
  Fixes a problem where encrypted documents could not be digitally signed correctly. (#22722)
• Fixed
  Fixes a problem where some PDF pages may not be rendered correctly. (#22767)
• Fixed
  Fixes a rare problem where the application may terminate unexpectedly after loading a document or setting a form field value. (#22924)
• Fixed
  Fixes an issue that caused a blank page after flattening annotations on a certain document. (#22279)
• Fixed
  Fixes an issue where PdfDocument#wasModified() incorrectly returned false after Document JSON import. (#19378)
• Fixed
  Fixes an issue where characters weren't escaped correctly when exporting XFDF. (#22844)
• Fixed
  Fixes an issue where low-res rendering got triggered after the page has been recycled, leading to the crash. (#22972)
• Fixed
  Fixes an issue where opening a certain document with form fields caused a crash. (#23001)
• Fixed
  Fixes an issue where popup annotations were positioned incorrectly. (#22730)
• Fixed
  Fixes an issue where some PDF JavaScript calculations did not work correctly. (#23043)
• Fixed
  Fixes an issue where text on form fields was occasionally rendered with incorrect rotation on rotated pages. (#22854)
• Fixed
  Fixes an issue where the file size optimization algorithm didn't run. (#22809)
• Fixed
  Fixes an issue where multiple JavaScript functions (for example mailDoc) did not parse their arguments correctly. (#23257)
• Fixed
  Fixes an issue with creating a Submit Form action from JSON without action flags. (#22784)
• Fixed
  Fixes empty text form fields not rendering their background color. (#23263)
• Fixed
  Fixes an issue where document checkpointing would not work when the UID of the document contained symbols that are not allowed in paths. (#12893)

Examples

• Added
  Adds catalog example that shows how to create a filterable thumbnail grid by combining the custom view logic with PDF processor. (#23192)
• Fixed
  Fixes an issue with the AesDataProvider when reopening a document right after saving it. (#23190)
• Fixed
  Fixes the VerticalScrollbarExample not working correctly with larger documents. (#22952)
• Fixed
  Fixes the Instant example not working on API 28 and up because android:usesCleartextTraffic was set to false. (#22908)