addOverlayViewProvider

open fun addOverlayViewProvider(@NonNull overlayViewProvider: OverlayViewProvider)

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.

Parameters

overlayViewProvider

OverlayViewProvider whose view instances should be added to the document view.

See also

Throws

If the current license doesn't contain the annotations component.