PdfFragment

Default zoom scale.

Key for storing the last viewed page index inside the DocumentDataStore of the loaded document. The last viewed page index is only read or written if isLastViewedPageRestorationEnabled() is set to true. If page restoration is disabled, the fragment won't access or modify the document store and any previously written value. The value is saved to the store inside onStop().

Maximum zoom scale.

Min allowed zoom (before snapping back).

Adds annotation to page asynchronously, refreshing rendering in all UI components.

Adds annotation to page asynchronously, refreshing rendering in all UI components.

Adds a DocumentActionListener that can handle actions bound to PDF objects. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Adds a DocumentListener for listening to document events. If the listener has already been added previously, this method will be a no-op. Listeners registered with this method will be unregistered automatically in onDetach(). Passing null is not allowed, and will result in an exception.

Adds a DocumentScrollListener for listening to scrolling events on the document. If the listener has already been added previously, this method will be a no-op. Listeners registered with this method will be unregistered automatically in onDetach(). Passing null is not allowed, and will result in an exception.

Adds a PdfDrawableProvider to be managed by this object. If the provider has been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Offset PdfFragment insets by specified amount.

Register a AnnotationManager.OnAnnotationCreationModeChangeListener to get notified when annotation creation mode gets updated. If the provider has been registered previously, this method will be a no-op.

Register a AnnotationManager.OnAnnotationCreationModeSettingsChangeListener to get notified when annotation creation settings get updated. If the provider has been registered previously, this method will be a no-op.

Register a AnnotationManager.OnAnnotationDeselectedListener to get notified when annotation gets deselected. If the provider has been registered previously, this method will be a no-op.

Register a AnnotationManager.OnAnnotationEditingModeChangeListener to get notified when annotation editing mode gets updated. If the provider has been registered previously, this method will be a no-op.

Register a AnnotationManager.OnAnnotationSelectedListener to get notified when annotation gets selected. If the provider has been registered previously, this method will be a no-op.

Register a AnnotationProvider.OnAnnotationUpdatedListener to get notified when annotation gets updated. If the listener has been registered previously, this method will be a no-op.

Note: Listeners methods are dispatched on the main UI thread.

Adds a FormManager.OnFormElementClickedListener to get notified when form element has been clicked. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Adds a FormManager.OnFormElementDeselectedListener to get notified when form element gets deselected. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Adds a FormManager.OnFormElementEditingModeChangeListener to get notified when form element editing mode gets updated. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Adds a FormManager.OnFormElementSelectedListener to get notified when form element gets selected. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Adds a FormManager.OnFormElementUpdatedListener to get notified when form element gets updated. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Adds a FormManager.OnFormElementViewUpdatedListener to get notified about form element view update events. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Adds a TextSelectionManager.OnTextSelectionChangeListener, which gets notified when text selection changes in the document, such as different text is selected. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Adds a TextSelectionManager.OnTextSelectionModeChangeListener, which gets notified when entering and exiting a text selection in the document. If the listener has already been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Adds an OverlayViewProvider for adding overlay views to this fragment. If the provider has been added previously, this method will be a no-op. Adding null is not allowed, and will result in an exception.

The OverlayViewProvider is linked with the lifecycle of the PdfFragment it is attached to, meaning that when used inside a PdfActivity you need to make sure to reattach it when the fragment changes, for example when the document changes.

Using this API requires the current license to contain the annotations component.

This API is still experimental. While it is tested, and doesn't contain any known bugs, it might be changed or removed with any minor release.

Notifies the navigation manager that calls to setPageIndex(int, boolean) should be added to the navigation history until endNavigation() is called.

Clears all currently selected Annotations. This method may only be called on the main thread (UI thread).

Commits the page changes to the navigation history dropping everything but the very last one.

Starts the annotation creation mode with the last used annotation tool as the selected one.

Additionally, annotation creator dialog will show up if the default annotation creator has not been set.

Enter annotation creation mode on the document. Once you invoke this method, you'll get AnnotationCreationController (through registered OnAnnotationCreationModeChangeListener) which provides methods for annotation creation with a specified type.

Additionally, annotation creator dialog will show up if the default annotation creator has not been set.

Enter annotation creation mode on the document. Once you invoke this method, you'll get AnnotationCreationController (through registered OnAnnotationCreationModeChangeListener) which provides methods for annotation creation with a specified type. Uses default AnnotationToolVariant.

Additionally, annotation creator dialog will show up if the default annotation creator has not been set.

Enter annotation editing mode on the document. Once you invoke this method, you'll get AnnotationEditingController (through registered OnAnnotationEditingModeChangeListener) which provides methods for editing a selected annotation. Notice: this method will not select annotation on the screen, for that use setSelectedAnnotation(Annotation).

Starts the content editing mode which allows for modifying PDF content text

Sets the current text selection. Once you invoke this method, you'll get TextSelectionController (through registered OnTextSelectionModeChangeListener) which provides methods for managing text selection actions.

Sets the current text selection. Once you invoke this method, you'll get TextSelectionController (through registered OnTextSelectionModeChangeListener) which provides methods for managing text selection actions.

Executes the given PDF action on the currently loaded document.

Executes the given PDF action on the currently loaded document.

Exit any currently active mode on the document (annotation creation, annotation editing, text selection).

Returns the active annotation tool.

Returns the variant of the active annotation tool variant (if any).

Returns annotation configuration registry with annotation configuration for supported annotation types and/or tools.

Note: This method must be called after views are created (after onCreateView(LayoutInflater, ViewGroup, Bundle)).

Returns manager for annotation preferences.

Note: This method must be called after views are created (after onCreateView(LayoutInflater, ViewGroup, Bundle)).

Returns this fragment's audio mode manager instance for entering/leaving audio playback or recording modes.

Gets the background color of the fragment. It's the background of the area behind the pages.

Returns configuration for this PdfFragment.

Returns content editing fill color configuration

Note: This method must be called after views are created (after onCreateView(LayoutInflater, ViewGroup, Bundle)).

Returns manager for content editing preferences.

Note: This method must be called after views are created (after onCreateView(LayoutInflater, ViewGroup, Bundle)).

Returns the current content editing state.

Returns this fragment's undo manager instance for performing undo/redo operations of content edits.

Gets the loaded document.

Returns the loaded image document, or null if this fragment does not hold an image document.

Returns the navigation history owned by this manager.

Gets annotation types that should be rendered as overlays.

Gets annotations that should be rendered as overlays.

Gets number of pages in the document.

Gets currently displayed document page.

Returns currently set password view for the fragment.

Returns a list of currently selected annotations, or an empty list if no annotations were selected.

Returns currently selected form element.

Gets page sibling index (usable in double page mode).

Gets the currently set signature metadata.

Gets the currently used signature storage that will be used to store signatures when they're added to the document.

If Electronic Signatures are enabled in your license, this property defaults to null, which means signatures can't be saved. To enable simple on-device signature storage, set this to an instance of SignatureStorage.

If Annotations were enabled in your license before the introduction of the Electronic Signatures component, this defaults to our DatabaseSignatureStorage implementation.

To remove the UI option to choose whether or not to save signatures and force them to be saved, change the `signatureSavingStrategy` in your PdfConfiguration or the used SignatureOptions.

Gets current state of the fragment.

Returns the current text selection.

Returns this fragment's undo manager instance for performing undo/redo operations of annotation edits.

Returns the ViewProjection for transforming between the view coordinates and PDF coordinates.

Fetch the list of pages currently visible on the screen.

Sets targetRect to contain the visible PDF rect of the given pageIndex. If the pageIndex is not visible on the screen, targetRect won't be modified and the method will return false.

Gets zoom scale at the specified page.

Indicates whether interaction with the document is enabled right now.

Indicates whether the displayed document is an image or not.

Returns true if any of the special modes is active.

Returns redaction annotation preview mode, false by default.

Indicates whether the scrolling is enabled, or not.

Indicates whether UI is enabled right now. UI is disabled when document is being saved/loaded, or when manually disabled.

Indicates whether the zooming is enabled, or not.

Creates and returns a new Fragment to display a converted PDF document from a supported image format.

Creates and returns a new Fragment to display a converted PDF document from a supported image format.

Creates and returns a new Fragment to display a converted PDF document from a supported image format.

Creates and returns a new Fragment to display a PDF document from an PdfFragment. This will copy the state of the given Fragment while applying the new configuration.

Creates and returns a new Fragment to display passed list of PDF documents as a single compound document.

Creates and returns a new Fragment to display passed list of PDF documents as a single compound document.

Creates and returns a new Fragment to display a PDF document from a custom data source

Creates and returns a new Fragment to display passed list of PDF documents as a single compound document.

Creates and returns a new Fragment to display a PDF document from a custom data source.

Creates and returns a new Fragment to display a PDF document from an already opened PdfDocument instance. This will not reload the document.

Creates and returns a new Fragment to display a PDF document.

Creates and returns a new Fragment to display a PDF document.

Creates and returns a new Fragment to display a PDF document.

Creates and returns a new Fragment to display a PDF document from the given DocumentSources.

Creates and returns a new Fragment to display a PDF document from a custom data source as a compound document.

Creates and returns a new Fragment to display a PDF document from a custom data source as a compound document.

Creates and returns a new Fragment to display a PDF document from a custom data source as a compound document.

Notifies this fragment that the passed annotation has changed and that all the views displaying it should be updated. Calling this method before document is loaded will have no effect.

Notifies layout has changed and properly updates its internal state and views. Call this when PdfFragment is embedded in a ViewGroup that has changed its size, this will schedule a layout pass of the view tree, after views have been laid out.

Called when annotation gets deselected.

Called when annotation gets selected.

Called when the user taps / clicks on the document, not the page itself but on the side (if visible).

Called if document loading has failed.

Called when document is successfully loaded and the document view has been laid out. This has to be called on the main thread.

Called before document will be saved. This callback allows cancellation of the save process.

Called if document saving has been cancelled.

Called if document saving has failed.

Called after the document has been saved.

Called whenever the document in the fragment scrolled. Values are expressed in an arbitrary unit and may change with every call. Also maxX and maxY are not guaranteed to remain the same between two calls.

Called when a user zooms a document.

Called when form element gets deselected.

Called when form element gets selected.

Called when user scrolled to a new page.

Called when user taps / clicks on the page.

Called when content of page with pageIndex has changed (for example due to annotation or form field being updated). All views displaying this page need to refresh.

Called immediately before annotation is going to be selected.

Called by the activity if it requires the fragment to save its state. Since this method can also be called when the fragment is on the backstack and has no view, this method may not rely on any views being present at the time of calling.

Called whenever the current scroll state of the PdfFragment changed.

Removes a previously added DocumentActionListener that can handle actions bound to PDF objects. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Removes a previously registered DocumentListener. After calling this method the documentListener will stop receiving document events. If the listener has not been added previously, this method will be a no-op. Passingnull is not allowed, and will result in an exception.

Removes a previously registered DocumentScrollListener. After calling this method the documentScrollListener will stop receiving scrolling events. If the listener has not been added previously, this method will be a no-op. Passingnull is not allowed, and will result in an exception.

Removes a previously added PdfDrawableProvider. If the provider hasn't been added previously, this method will be a no-op.

Remove a previously registered AnnotationManager.OnAnnotationCreationModeChangeListener. If the provider hasn't been registered previously, this method will be a no-op.

Remove a previously registered AnnotationManager.OnAnnotationCreationModeSettingsChangeListener. If the provider hasn't been registered previously, this method will be a no-op.

Remove a previously registered AnnotationManager.OnAnnotationDeselectedListener. If the provider hasn't been registered previously, this method will be a no-op.

Remove a previously registered AnnotationManager.OnAnnotationEditingModeChangeListener. If the provider hasn't been registered previously, this method will be a no-op.

Remove a previously registered AnnotationManager.OnAnnotationSelectedListener. If the provider hasn't been registered previously, this method will be a no-op.

Remove a previously registered AnnotationProvider.OnAnnotationUpdatedListener. If the listener hasn't been registered previously, this method will be a no-op.

Removes a previously registered FormManager.OnFormElementClickedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Adding null is not allowed,and will result in an exception.

Removes a previously registered FormManager.OnFormElementDeselectedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Adding null is not allowed,and will result in an exception.

Removes a previously registered FormManager.OnFormElementEditingModeChangeListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Adding null is not allowed,and will result in an exception.

Removes a previously registered FormManager.OnFormElementSelectedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Adding null is not allowed,and will result in an exception.

Removes a previously registered FormManager.OnFormElementUpdatedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Adding null is not allowed,and will result in an exception.

Removes a previously registered FormManager.OnFormElementViewUpdatedListener. Upon calling this method the listener will no longer be notified of any changes. If the listener has not been added, this method will be a no-op. Adding null is not allowed, and will result in an exception.

Removes a TextSelectionManager.OnTextSelectionChangeListener, which gets notified when text selection changes in the document, such as different text is selected. Upon calling this method the listener will no longer be notified. If the listener has not been added, this method will be a no-op.

Removes a previously added TextSelectionManager.OnTextSelectionModeChangeListener, which gets notified when entering and exiting a text selection in the document. Upon calling this method the listener will no longer be notified. If the listener has not been added, this method will be a no-op.

Removes a previously added OverlayViewProvider. If the provider hasn't been added previously, this method will be a no-op.

Using this API requires the current license to contain the annotations component.

This API is still experimental. While it is tested, and doesn't contain any known bugs, it might be changed or removed with any minor release.

Saves the file held by the document view back to it's original location. The save operation will be successful only if all document listeners return true in onDocumentSave(PdfDocument, DocumentSaveOptions) and the document was actually modified.

Scrolls to the given pdfRect, if necessary changing to the page. This will keep the current zoom level. If scrollWhenVisible is false this method will be a no-op if the pdfRect is already completely visible.

Sets the annotation overlay render strategy. This strategy defines how annotations that are displayed in overlay mode (i.e. views which are rendered as views inside the activities view hierarchy) should be rendered. By default, PSPDFKit uses PLATFORM_RENDERING for all annotations. You can override this behavior by setting a custom strategy using this method. For more information about the available render strategies please see AnnotationOverlayRenderStrategy.

Note: Render strategy is used whenever annotation is extracted to overlay - i.e. after changing set of overlaid annotations (or types), creating new annotations or when loading page after opening the document or scrolling to a new page that is not yet cached (PSPDFKit instantiates around 5 pages around the currently visible pages to achieve smooth scrolling). Note that strategy changes are not applied until above events occur.

Sets the background color of the fragment. It's the background of the area behind the pages.

Sets the custom source for the PDF file.

Sets the custom sources for the PDF file.

Enables or disables interaction with the document. When the interaction is disabled you can no longer scroll or zoom the document in any way, any other UI like the thumbnail bar is still enabled.

Sets a new DocumentSigningListener or replaces an existing one. This allows capturing of digital signing events.

If not set or set to null, a default implementation of DocumentSigningListener is used.

Sets insets that will be used as padding for PdfFragment contents.

Sets a OnDocumentLongPressListener for long press document events. Listener registered with this method will be unregistered automatically in onDetach(). Calling this method will replace any previously set listener. You may provide null to switch to the default listener.

Sets the listener that will allow you to get notified when each of the popup toolbars is prepared and ready to be displayed. This allows you to set your own items, change the appearance of the toolbar, etc.

Sets annotation types that should be rendered as overlays.

If annotation is not rendered as overlay, it is rendered within the page image. Rendering as overlay performs better if you frequently change annotations, but might delay page display and increase memory usage.

Following annotation types support overlay mode:

• HIGHLIGHT
• STRIKEOUT
• UNDERLINE
• SQUIGGLY
• FREETEXT
• NOTE
• STAMP
• INK
• LINE
• SQUARE
• CIRCLE
• POLYGON
• POLYLINE

NOTE are always rendered as overlays.

Sets annotations that should be rendered as overlays. This enables overlay rendering for annotations even when their types are not enabled for overlay rendering via setOverlaidAnnotationTypes(EnumSet).

If annotation is not rendered as overlay, it is rendered within the page image. Rendering as overlay is more performant if you frequently change annotations, but might delay page display and increase memory usage.

NOTE, LINK and FILE are always rendered as overlays.

Sets the pageIndex to be displayed (0 is the first one), using our default decision on animating, which is to animate the transition if the page is next/before the current page, and not animate if further away. For custom animation control , use setPageIndex(int, boolean).

This method will throw an exception if pageIndex < 0 || pageIndex >= pageCount (as returned by getPageCount()).

Sets the pageIndex to be displayed (0 is the first one). If animated is set to true, the page jump will be animated. If false, the page will be shown immediately.

This method will throw an exception if pageIndex < 0 || pageIndex >= pageCount (as returned by getPageCount()).

Sets drawable that should be displayed instead of fragment's contents (i.e. loading throbber) until document is loaded and all visible pages are rendered.

Sets password view to be used for the password-protected documents.

Sets redaction annotations preview as redacted.

Enables/disabled the scrolling performed by the user. Enabled by default.

Selects a single Annotation. This will also start annotation editing mode with selected annotation being edited.

Sets the currently selected Annotations. Selecting multiple annotations will not start the annotation editing mode, where selecting a single one will.

Sets the currently selected FormElement.

Sets the signature metadata that will be used when digitally signing the document.

Sets the signature storage that will be used to store signatures when they're added to the document (if saving signatures is enabled).

Replace fragment state.

Enables or disables the user interface. When the user interface is disabled all temporary UI elements (navigation buttons, readaction UI) are hidden, and all user interaction is disabled (no scrolling, no clicking on the thumbnail bar, no annotation editing).

Enables/disabled the zooming performed by the user. Enabled by default.

Zoom by the given scale focused on the given point in PDF coordinates.`

Zoom to the given scale focused on the given point in PDF coordinates.

Zoom to a specific rect on the given page.