A-index

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A

AbstractFormAction - class in com.pspdfkit.annotations.actions

Base class for form related actions.

AbstractMediaAction - class in com.pspdfkit.annotations.actions

Base class for media annotation related actions.

AbstractPropertyInspectorController - class in com.pspdfkit.ui.inspector

Abstract base class for all inspector controllers.

ACCEPTED - enum entry in com.pspdfkit.annotations.note.AuthorState

The user agrees with the change.

ACCEPTED - enum entry in com.pspdfkit.annotations.stamps.PredefinedStampType

Action - class in com.pspdfkit.annotations.actions

Represents a PDF action used to describe what happens when annotations, bookmarks, etc.

ActionAccessors - class in com.pspdfkit.annotations.actions

Exposes action methods that are not part of the public API.

ActionAccessors.Companion - class in com.pspdfkit.annotations.actions.ActionAccessors

ActionMenu - class in com.pspdfkit.ui.actionmenu

Bottom sheet menu showing a list of actions.

ActionMenuItem - class in com.pspdfkit.ui.actionmenu

Represents item inside ActionMenu.

ActionMenuItem.MenuItemType - class in com.pspdfkit.ui.actionmenu.ActionMenuItem

Supported types of action menu items.

ActionMenuListener - class in com.pspdfkit.ui.actionmenu

Listener for action menu lifecycle and click events.

ActionResolver - class in com.pspdfkit.annotations.actions

Action resolver for running a Action.

ActionSender - class in com.pspdfkit.annotations.actions

Object that triggered the execution of action, such as an annotation or a form element.

ActionType - class in com.pspdfkit.annotations.actions

Currently supported PDF action types.

activityClass(java.lang.Class) - function in com.pspdfkit.instant.ui.InstantPdfActivityIntentBuilder

Sets a custom activity class used for document display.

activityClass(kotlin.reflect.KClass) - function in com.pspdfkit.instant.ui.InstantPdfActivityIntentBuilder

Sets a custom activity class used for document display.

activityClass(java.lang.Class) - function in com.pspdfkit.ui.PdfActivityIntentBuilder

Sets a custom activity class used for document display.

activityClass(kotlin.reflect.KClass) - function in com.pspdfkit.ui.PdfActivityIntentBuilder

Sets a custom activity class used for document display.

adaptSubmenuIndicatorToParentPosition(com.pspdfkit.ui.toolbar.ToolbarCoordinatorLayout.LayoutParams.Position) - function in com.pspdfkit.ui.toolbar.ContextualToolbarMenuItem

Used to allow parent to notify child items of it's new position so the submenu indicator arrow can be placed correctly.

add(android.content.Context,com.pspdfkit.annotations.measurements.MeasurementValueConfiguration,com.pspdfkit.ui.inspector.views.MeasurementValueConfigurationPickerListener) - function in com.pspdfkit.annotations.measurements.MeasurementValueConfigurationEditor

Adds the provided configuration to the document.

add(com.pspdfkit.annotations.measurements.MeasurementValueConfiguration,boolean) - function in com.pspdfkit.annotations.measurements.MeasurementValueConfigurationEditor

Adds the `value` configuration to the document's configuration list.

ADD_ANNOTATION - enum entry in com.pspdfkit.undo.edit.annotations.AnnotationAddRemoveEdit.Type

The annotation was added to the document.

addActionMenuListener(com.pspdfkit.ui.actionmenu.ActionMenuListener) - function in com.pspdfkit.ui.actionmenu.ActionMenu

Adds new listener for action menu lifecycle and events.

addAnalyticsClient(com.pspdfkit.analytics.AnalyticsClient) - function in com.pspdfkit.PSPDFKit

Add a AnalyticsClient to receive analytics events from PSPDFKit.

addAnnotationToPage(com.pspdfkit.annotations.Annotation) - function in com.pspdfkit.annotations.AnnotationProvider

Adds annotation to the owner PDF document.

addAnnotationToPage(com.pspdfkit.annotations.Annotation,int) - function in com.pspdfkit.annotations.AnnotationProvider

Adds annotation to the owner PDF document at the specified z-index.

addAnnotationToPage(com.pspdfkit.annotations.Annotation,java.lang.Boolean) - function in com.pspdfkit.jetpack.compose.interactors.DocumentConnection

addAnnotationToPage(com.pspdfkit.annotations.Annotation,boolean) - function in com.pspdfkit.ui.PdfFragment

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

addAnnotationToPage(com.pspdfkit.annotations.Annotation,boolean,java.lang.Runnable) - function in com.pspdfkit.ui.PdfFragment

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

addAnnotationToPageAsync(com.pspdfkit.annotations.Annotation) - function in com.pspdfkit.annotations.AnnotationProvider

Adds annotation to the owner PDF document asynchronously.

addAnnotationToPageAsync(com.pspdfkit.annotations.Annotation,int) - function in com.pspdfkit.annotations.AnnotationProvider

Adds annotation to the owner PDF document asynchronously, at the specified z-index.

addAnnotationViewsListener(com.pspdfkit.ui.annotations.AnnotationViewsListener) - function in com.pspdfkit.ui.PdfFragment

Adds an AnnotationViewsListener to the list of listeners that will be notified when the internal views factory creates an EditText widget for editing a freetext annotation

addAppearanceStreamGenerator(com.pspdfkit.annotations.appearance.AppearanceStreamGenerator) - function in com.pspdfkit.annotations.AnnotationProvider

Adds appearance stream generator to the list of global appearance stream generators.

addAppearanceStreamGenerator(com.pspdfkit.annotations.appearance.AppearanceStreamGenerator,boolean) - function in com.pspdfkit.annotations.AnnotationProvider

Adds appearance stream generator to the list of global appearance stream generators.

addAppearanceStreamGenerator(java.lang.String,com.pspdfkit.annotations.appearance.AppearanceStreamGenerator) - function in com.pspdfkit.annotations.stamps.CustomStampAppearanceStreamGenerator

Adds new appearance stream generator for stamp annotations with given subject.

addAudioPlaybackListener(com.pspdfkit.ui.audio.AudioPlaybackController.AudioPlaybackListener) - function in com.pspdfkit.ui.audio.AudioPlaybackController

Registers a AudioPlaybackListener to get notified when audio playback state changes.

addAudioPlaybackModeChangeListener(com.pspdfkit.ui.audio.AudioModeListeners.AudioPlaybackModeChangeListener) - function in com.pspdfkit.ui.audio.AudioModeListeners

Registers a AudioPlaybackModeChangeListener to get notified when audio playback mode gets updated.

addAudioRecordingListener(com.pspdfkit.ui.audio.AudioRecordingController.AudioRecordingListener) - function in com.pspdfkit.ui.audio.AudioRecordingController

Registers a AudioRecordingListener to get notified when audio recording state changes.

addAudioRecordingModeChangeListener(com.pspdfkit.ui.audio.AudioModeListeners.AudioRecordingModeChangeListener) - function in com.pspdfkit.ui.audio.AudioModeListeners

Registers a AudioRecordingModeChangeListener to get notified when audio recording mode gets updated.

addBackStackListener(com.pspdfkit.ui.navigation.NavigationBackStack.BackStackListener) - function in com.pspdfkit.ui.navigation.NavigationBackStack

Adds a back stack listener to be notified of changes.

addBookmark(com.pspdfkit.bookmarks.Bookmark) - function in com.pspdfkit.bookmarks.BookmarkProvider

Adds a new bookmark to the document.

addBookmarkAsync(com.pspdfkit.bookmarks.Bookmark) - function in com.pspdfkit.bookmarks.BookmarkProvider

Adds bookmark to the document.

addBookmarkListener(com.pspdfkit.bookmarks.BookmarkProvider.BookmarkListener) - function in com.pspdfkit.bookmarks.BookmarkProvider

Adds a BookmarkListener for being notified when bookmarks have been changed.

addBookmarkListener(com.pspdfkit.bookmarks.BookmarkProvider.BookmarkListener) - function in com.pspdfkit.ui.outline.BookmarkViewAdapter

Adds this view to bookmark change events via BookmarkListener interface.

addBookmarkListener(com.pspdfkit.bookmarks.BookmarkProvider.BookmarkListener) - function in com.pspdfkit.ui.outline.DefaultBookmarkAdapter

Adds this view to bookmark change events via BookmarkListener interface.

addCanvasDrawingToPage(com.pspdfkit.document.processor.PageCanvas,int) - function in com.pspdfkit.document.processor.PdfProcessorTask

Merges content of canvas drawing on top (or below) the destination page content.

addChangeListener(com.pspdfkit.annotations.measurements.MeasurementValueConfigurationEditor.ChangeListener) - function in com.pspdfkit.annotations.measurements.MeasurementValueConfigurationEditor

addDocument(com.pspdfkit.ui.DocumentDescriptor) - function in com.pspdfkit.ui.DocumentCoordinator

Inserts a new document at the end of the documents list.

addDocument(com.pspdfkit.ui.DocumentDescriptor,int) - function in com.pspdfkit.ui.DocumentCoordinator

Inserts a new document at the specified index.

addDocumentActionListener(com.pspdfkit.document.DocumentActionListener) - function in com.pspdfkit.annotations.actions.ActionResolver

Adds a DocumentActionListener that can handle actions bound to PDF objects.

addDocumentActionListener(com.pspdfkit.document.DocumentActionListener) - function in com.pspdfkit.ui.PdfFragment

Adds a DocumentActionListener that can handle actions bound to PDF objects.

addDocumentAfterVisibleDocument(com.pspdfkit.ui.DocumentDescriptor) - function in com.pspdfkit.ui.DocumentCoordinator

Inserts a document after the current visible document.

addDocumentListener(com.pspdfkit.listeners.DocumentListener) - function in com.pspdfkit.ui.PdfFragment

Adds a DocumentListener for listening to document events.

addDocumentScrollListener(com.pspdfkit.listeners.scrolling.DocumentScrollListener) - function in com.pspdfkit.ui.PdfFragment

Adds a DocumentScrollListener for listening to scrolling events on the document.

addDrawableProvider(com.pspdfkit.ui.drawable.PdfDrawableProvider) - function in com.pspdfkit.ui.PdfFragment

Adds a PdfDrawableProvider to be managed by this object.

addDrawableProvider(com.pspdfkit.ui.drawable.PdfDrawableProvider) - function in com.pspdfkit.ui.PdfOutlineView

Adds a PdfDrawableProvider to be managed by this object.

addDrawableProvider(com.pspdfkit.ui.drawable.PdfDrawableProvider) - function in com.pspdfkit.ui.PdfThumbnailBar

Adds a PdfDrawableProvider to be managed by this object.

addDrawableProvider(com.pspdfkit.ui.drawable.PdfDrawableProvider) - function in com.pspdfkit.ui.PdfThumbnailGrid

Adds a PdfDrawableProvider to be managed by this object.

addDrawableProvider(com.pspdfkit.ui.drawable.PdfDrawableProvider) - function in com.pspdfkit.ui.drawable.PdfDrawableManager

Adds a PdfDrawableProvider to be managed by this object.

addFormElementsToPage(java.lang.String,java.util.List) - function in com.pspdfkit.forms.FormProvider

Allows to programmatically create and insert a form field into the document.

addFormElementsToPageAsync(java.lang.String,java.util.List) - function in com.pspdfkit.forms.FormProvider

Allows to programmatically create and insert a form field into the document, asynchronously.

addFormElementToPage(java.lang.String,T) - function in com.pspdfkit.forms.FormProvider

Allows to programmatically create and insert a form field into the document.

addFormElementToPageAsync(java.lang.String,T) - function in com.pspdfkit.forms.FormProvider

Allows to programmatically create and insert a form field into the document, asynchronously.

addImageToPage(com.pspdfkit.document.processor.PageImage,int) - function in com.pspdfkit.document.processor.PdfProcessorTask

Adds an image on top (or below) the destination page content.

addInsets(int,int,int,int) - function in com.pspdfkit.ui.PdfFragment

Offset PdfFragment insets by specified amount.

addInspectorView(com.pspdfkit.ui.inspector.PropertyInspectorView) - function in com.pspdfkit.ui.inspector.PropertyInspector

Add new view to inspector layout.

addInspectorView(com.pspdfkit.ui.inspector.PropertyInspectorView,int) - function in com.pspdfkit.ui.inspector.PropertyInspector

Add new view to inspector layout.

addInstantDocumentListener(com.pspdfkit.instant.listeners.InstantDocumentListener) - function in com.pspdfkit.instant.document.InstantPdfDocument

Adds listener for instant document events.

addInstantDocumentListener(com.pspdfkit.instant.listeners.InstantDocumentListener) - function in com.pspdfkit.instant.ui.InstantPdfFragment

Adds a InstantDocumentListener for instant document events.

addItem(T) - function in com.pspdfkit.ui.navigation.NavigationBackStack

Adds a new item depending on if we are currently going back or forward.

addItemDecoration(com.pspdfkit.ui.inspector.PropertyInspector.ItemDecoration) - function in com.pspdfkit.ui.inspector.PropertyInspector

Adds an ItemDecoration to this inspector.

addItemDecoration(com.pspdfkit.ui.inspector.PropertyInspector.ItemDecoration,int) - function in com.pspdfkit.ui.inspector.PropertyInspector

Adds an ItemDecoration to this inspector.

addLibraryIndexingListener(com.pspdfkit.document.library.LibraryIndexingListener) - function in com.pspdfkit.document.library.PdfLibrary

Adds a LibraryIndexingListener to monitor document indexing status.

addLogger(com.pspdfkit.utils.PdfLog.Logger) - function in com.pspdfkit.utils.PdfLog

Adds new logger that will be notified of all logs emitted by PdfLog.

addLongTermValidation(com.pspdfkit.forms.SignatureFormElement,java.util.List) - function in com.pspdfkit.document.PdfDocument

This adds long term validation to an existing signature form element that has already been signed or refreshes that information if the signature is already LTV enabled.

addMenuItem(com.pspdfkit.ui.actionmenu.ActionMenuItem) - function in com.pspdfkit.ui.actionmenu.ActionMenu

Add menu item to action menu.

addMenuItems(java.util.List) - function in com.pspdfkit.ui.actionmenu.ActionMenu

Add all menu items to action menu.

addNewPage(com.pspdfkit.document.processor.NewPage,int) - function in com.pspdfkit.document.processor.PdfProcessorTask

Adds a new page to the document at passed index.

addNonAnnotationChangeListener(com.pspdfkit.instant.annotations.InstantAnnotationProvider.OnNonAnnotationChangeListener) - function in com.pspdfkit.instant.annotations.InstantAnnotationProvider

Registers the given object to be notified of non-annotation changes.

addOnAnnotationCreationModeChangeListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationCreationModeChangeListener) - function in com.pspdfkit.ui.PdfFragment

addOnAnnotationCreationModeChangeListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationCreationModeChangeListener) - function in com.pspdfkit.ui.special_mode.manager.AnnotationManager

addOnAnnotationCreationModeSettingsChangeListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationCreationModeSettingsChangeListener) - function in com.pspdfkit.ui.PdfFragment

addOnAnnotationCreationModeSettingsChangeListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationCreationModeSettingsChangeListener) - function in com.pspdfkit.ui.special_mode.manager.AnnotationManager

addOnAnnotationDeselectedListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationDeselectedListener) - function in com.pspdfkit.ui.PdfFragment

addOnAnnotationDeselectedListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationDeselectedListener) - function in com.pspdfkit.ui.special_mode.manager.AnnotationManager

addOnAnnotationEditingModeChangeListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationEditingModeChangeListener) - function in com.pspdfkit.ui.PdfFragment

addOnAnnotationEditingModeChangeListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationEditingModeChangeListener) - function in com.pspdfkit.ui.special_mode.manager.AnnotationManager

addOnAnnotationSelectedListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationSelectedListener) - function in com.pspdfkit.ui.PdfFragment

addOnAnnotationSelectedListener(com.pspdfkit.ui.special_mode.manager.AnnotationManager.OnAnnotationSelectedListener) - function in com.pspdfkit.ui.special_mode.manager.AnnotationManager

addOnAnnotationUpdatedListener(com.pspdfkit.annotations.AnnotationProvider.OnAnnotationUpdatedListener) - function in com.pspdfkit.annotations.AnnotationProvider

Adds an OnAnnotationUpdatedListener for being notified of updates to annotations.

addOnAnnotationUpdatedListener(com.pspdfkit.annotations.AnnotationProvider.OnAnnotationUpdatedListener) - function in com.pspdfkit.ui.PdfFragment

addOnAnnotationUpdatedListener(com.pspdfkit.annotations.AnnotationProvider.OnAnnotationUpdatedListener) - function in com.pspdfkit.ui.special_mode.manager.AnnotationManager

addOnAudioInspectorLifecycleListener(com.pspdfkit.ui.audio.AudioView.AudioInspectorLifecycleListener) - function in com.pspdfkit.ui.audio.AudioView

Adds an AudioInspectorLifecycleListener for listening to the view lifecycle.

addOnButtonFormFieldUpdatedListener(com.pspdfkit.forms.FormListeners.OnButtonFormFieldUpdatedListener) - function in com.pspdfkit.forms.FormProvider

Adds OnButtonFormFieldUpdatedListener to get notified when button fields get updated.

addOnChoiceFormFieldUpdatedListener(com.pspdfkit.forms.FormListeners.OnChoiceFormFieldUpdatedListener) - function in com.pspdfkit.forms.FormProvider

Adds OnChoiceFormFieldUpdatedListener to get notified when choice fields get updated.

addOnContentEditingBarLifecycleListener(com.pspdfkit.ui.contentediting.ContentEditingStylingBar.OnContentEditingBarLifecycleListener) - function in com.pspdfkit.ui.contentediting.ContentEditingStylingBar

Adds an OnContentEditingBarLifecycleListener for listening to the content editing bar lifecycle.

addOnContentEditingContentChangeListener(com.pspdfkit.ui.special_mode.manager.ContentEditingManager.OnContentEditingContentChangeListener) - function in com.pspdfkit.ui.PdfFragment

addOnContentEditingContentChangeListener(com.pspdfkit.ui.special_mode.manager.ContentEditingManager.OnContentEditingContentChangeListener) - function in com.pspdfkit.ui.special_mode.manager.ContentEditingManager

addOnContentEditingModeChangeListener(com.pspdfkit.ui.special_mode.manager.ContentEditingManager.OnContentEditingModeChangeListener) - function in com.pspdfkit.ui.PdfFragment

addOnContentEditingModeChangeListener(com.pspdfkit.ui.special_mode.manager.ContentEditingManager.OnContentEditingModeChangeListener) - function in com.pspdfkit.ui.special_mode.manager.ContentEditingManager

addOnDocumentCoordinatorEmptyListener(com.pspdfkit.ui.DocumentCoordinator.OnDocumentCoordinatorEmptyListener) - function in com.pspdfkit.ui.DocumentCoordinator

Registers a OnDocumentCoordinatorEmptyListener to get notified when document gets visible in the manager.

addOnDocumentEditingModeChangeListener(com.pspdfkit.ui.special_mode.manager.DocumentEditingManager.OnDocumentEditingModeChangeListener) - function in com.pspdfkit.ui.special_mode.manager.DocumentEditingManager

Adds a OnDocumentEditingModeChangeListener to get notified when document editing mode has changed.

addOnDocumentEditingPageSelectionChangeListener(com.pspdfkit.ui.special_mode.manager.DocumentEditingManager.OnDocumentEditingPageSelectionChangeListener) - function in com.pspdfkit.ui.special_mode.manager.DocumentEditingManager

Adds a OnDocumentEditingPageSelectionChangeListener to get notified when document page selection has changed.

addOnDocumentInfoViewModeChangeListener(com.pspdfkit.ui.documentinfo.OnDocumentInfoViewModeChangeListener) - function in com.pspdfkit.ui.PdfOutlineView

Adds the listener for the editing mode changes on this document info view.

addOnDocumentInfoViewSaveListener(com.pspdfkit.ui.documentinfo.OnDocumentInfoViewSaveListener) - function in com.pspdfkit.ui.PdfOutlineView

Adds the listener for saving the document info changes.

addOnDocumentSavedListener(com.pspdfkit.ui.PdfThumbnailGrid.OnDocumentSavedListener) - function in com.pspdfkit.ui.PdfThumbnailGrid

Adds a listener that will be notified about document saves inside the thumbnail grid.

addOnDocumentsChangedListener(com.pspdfkit.ui.DocumentCoordinator.OnDocumentsChangedListener) - function in com.pspdfkit.ui.DocumentCoordinator

Registers a OnDocumentsChangedListener to get notified when items in document coordinator change.

addOnDocumentVisibleListener(com.pspdfkit.ui.DocumentCoordinator.OnDocumentVisibleListener) - function in com.pspdfkit.ui.DocumentCoordinator

Registers a OnDocumentVisibleListener to get notified when document gets visible in the manager.

addOnFormEditingBarLifecycleListener(com.pspdfkit.ui.forms.FormEditingBar.OnFormEditingBarLifecycleListener) - function in com.pspdfkit.ui.forms.FormEditingBar

Adds an OnFormEditingBarLifecycleListener for listening to the form editing bar lifecycle.

addOnFormElementClickedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementClickedListener) - function in com.pspdfkit.ui.PdfFragment

Adds a OnFormElementClickedListener to get notified when form element has been clicked.

addOnFormElementClickedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementClickedListener) - function in com.pspdfkit.ui.special_mode.manager.FormManager

Adds a OnFormElementClickedListener to get notified when form element has been clicked.

addOnFormElementDeselectedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementDeselectedListener) - function in com.pspdfkit.ui.PdfFragment

Adds a OnFormElementDeselectedListener to get notified when form element gets deselected.

addOnFormElementDeselectedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementDeselectedListener) - function in com.pspdfkit.ui.special_mode.manager.FormManager

Adds a OnFormElementDeselectedListener to get notified when form element gets deselected.

addOnFormElementEditingModeChangeListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementEditingModeChangeListener) - function in com.pspdfkit.ui.PdfFragment

Adds a OnFormElementEditingModeChangeListener to get notified when form element editing mode gets updated.

addOnFormElementEditingModeChangeListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementEditingModeChangeListener) - function in com.pspdfkit.ui.special_mode.manager.FormManager

Adds a OnFormElementEditingModeChangeListener to get notified when form element editing mode gets updated.

addOnFormElementSelectedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementSelectedListener) - function in com.pspdfkit.ui.PdfFragment

Adds a OnFormElementSelectedListener to get notified when form element gets selected.

addOnFormElementSelectedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementSelectedListener) - function in com.pspdfkit.ui.special_mode.manager.FormManager

Adds a OnFormElementSelectedListener to get notified when form element gets selected.

addOnFormElementUpdatedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementUpdatedListener) - function in com.pspdfkit.ui.PdfFragment

Adds a OnFormElementUpdatedListener to get notified when form element gets updated.

addOnFormElementUpdatedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementUpdatedListener) - function in com.pspdfkit.ui.special_mode.manager.FormManager

Adds a OnFormElementUpdatedListener to get notified when form element gets updated.

addOnFormElementViewUpdatedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementViewUpdatedListener) - function in com.pspdfkit.ui.PdfFragment

Adds a OnFormElementViewUpdatedListener to get notified about form element view update events.

addOnFormElementViewUpdatedListener(com.pspdfkit.ui.special_mode.manager.FormManager.OnFormElementViewUpdatedListener) - function in com.pspdfkit.ui.special_mode.manager.FormManager

Adds a OnFormElementViewUpdatedListener to get notified about form element view update events.

addOnFormFieldUpdatedListener(com.pspdfkit.forms.FormListeners.OnFormFieldUpdatedListener) - function in com.pspdfkit.forms.FormProvider

Adds OnFormFieldUpdatedListener to get notified when any form field gets updated.

addOnFormTabOrderUpdatedListener(com.pspdfkit.forms.FormListeners.OnFormTabOrderUpdatedListener) - function in com.pspdfkit.forms.FormProvider

Adds OnFormTabOrderUpdatedListener to get notified when form tab order has been recalculated.

addOnPageClickListener(com.pspdfkit.ui.PdfThumbnailGrid.OnPageClickListener) - function in com.pspdfkit.ui.PdfThumbnailGrid

Adds a listener that will be notified when a page on the ThumbnailGrid was clicked.

addOnTabClickedListener(com.pspdfkit.ui.tabs.PdfTabBar.OnTabClickedListener) - function in com.pspdfkit.ui.tabs.PdfTabBar

Registers OnTabClickedListener to get notified about clicks on tabs in this tab bar.

addOnTabsChangedListener(com.pspdfkit.ui.tabs.PdfTabBar.OnTabsChangedListener) - function in com.pspdfkit.ui.tabs.PdfTabBar

Registers OnTabsChangedListener to get notified when tabs list changes.

addOnTextFormFieldUpdatedListener(com.pspdfkit.forms.FormListeners.OnTextFormFieldUpdatedListener) - function in com.pspdfkit.forms.FormProvider

Adds OnTextFormFieldUpdatedListener to get notified when text fields get updated.

addOnTextSelectionChangeListener(com.pspdfkit.ui.special_mode.manager.TextSelectionManager.OnTextSelectionChangeListener) - function in com.pspdfkit.ui.PdfFragment

Adds a OnTextSelectionChangeListener, which gets notified when text selection changes in the document, such as different text is selected.

addOnTextSelectionChangeListener(com.pspdfkit.ui.special_mode.manager.TextSelectionManager.OnTextSelectionChangeListener) - function in com.pspdfkit.ui.special_mode.manager.TextSelectionManager

Adds a OnTextSelectionChangeListener, which gets notified when text selection changes in the document, such as different text is selected.

addOnTextSelectionModeChangeListener(com.pspdfkit.ui.special_mode.manager.TextSelectionManager.OnTextSelectionModeChangeListener) - function in com.pspdfkit.ui.PdfFragment

Adds a OnTextSelectionModeChangeListener, which gets notified when entering and exiting a text selection in the document.

addOnTextSelectionModeChangeListener(com.pspdfkit.ui.special_mode.manager.TextSelectionManager.OnTextSelectionModeChangeListener) - function in com.pspdfkit.ui.special_mode.manager.TextSelectionManager

Adds a OnTextSelectionModeChangeListener, which gets notified when entering and exiting a text selection in the document.

addOnUndoHistoryChangeListener(com.pspdfkit.undo.OnUndoHistoryChangeListener) - function in com.pspdfkit.undo.UndoManager

Adds an OnUndoHistoryChangeListener for being notified of changes to the undo manager's edit history (i.e.

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.listeners.OnVisibilityChangedListenerManager

Adds a listener to the collection.

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.PSPDFKitViews

Add on visibility changed listener to every instantiated view.

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.PSPDFKitViews.PSPDFView

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.PdfOutlineView

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.PdfReaderView

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.PdfThumbnailBar

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.PdfThumbnailGrid

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.search.PdfSearchViewLazy

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.thumbnail.PdfScrollableThumbnailBar

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.thumbnail.PdfStaticThumbnailBar

addOnVisibilityChangedListener(com.pspdfkit.listeners.OnVisibilityChangedListener) - function in com.pspdfkit.ui.thumbnail.PdfThumbnailBarController

Adds a listener to be notified of visibility change.

addOverlayViewProvider(com.pspdfkit.ui.overlay.OverlayViewProvider) - function in com.pspdfkit.ui.PdfFragment

Adds an OverlayViewProvider for adding overlay views to this fragment.

addOverlayViewProviderObserver(com.pspdfkit.ui.overlay.OverlayViewProvider.OverlayViewProviderObserver) - function in com.pspdfkit.ui.overlay.OverlayViewProvider

addPage(int,com.pspdfkit.document.processor.NewPage) - function in com.pspdfkit.document.editor.PdfDocumentEditor

Adds a new page at the specified pageIndex, with the configuration options specified in newPageConfiguration.

addPages(int,java.util.List) - function in com.pspdfkit.document.editor.PdfDocumentEditor

Adds a new collection of pages at the specified pageIndex, with the configuration options specified in newPageConfigurations for every page.

addPropertyInspectorLifecycleListener(com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener) - function in com.pspdfkit.ui.PdfUi

Adds the listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing.

addPropertyInspectorLifecycleListener(com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayoutController.PropertyInspectorLifecycleListener) - function in com.pspdfkit.ui.inspector.PropertyInspectorCoordinatorLayout

Adds the listener for lifecycle changes of the PropertyInspector as it goes through the PropertyInspectorCoordinatorLayout - preparing, displaying, removing.

addSearchResults(java.util.List) - function in com.pspdfkit.ui.search.SearchResultHighlighter

Adds the given results to the set of previously added results.

addSignature(com.pspdfkit.signatures.Signature) - function in com.pspdfkit.signatures.storage.DatabaseSignatureStorage

Adds the given signature to the signature storage.

addSignature(com.pspdfkit.signatures.Signature) - function in com.pspdfkit.signatures.storage.SignatureStorage

Adds the given signature to the signature storage.

addSignatures(java.util.List) - function in com.pspdfkit.signatures.storage.DatabaseSignatureStorage

Adds the given signatures to the signature storage.

addSignatures(java.util.List) - function in com.pspdfkit.signatures.storage.SignatureStorage

Adds the given signatures to the signature storage.

addTrustedCertificates(java.util.List) - function in com.pspdfkit.signatures.TrustedKeyStore

Add trusted certificates here.

adjustBoundsForRotation() - function in com.pspdfkit.annotations.FreeTextAnnotation

This adjusts the annotations bounding box to the smallest possible size that will encompass the rotated annotations at it's default size.

adjustBoundsForRotation() - function in com.pspdfkit.annotations.StampAnnotation

This adjusts the annotations bounding box to the smallest possible size that will encompass the rotated annotations at it's default size.

afterTextChanged(android.text.Editable) - function in com.pspdfkit.ui.FloatingHintEditText.EditTextListener

Called after each Editable text change.

afterTextChanged(android.text.Editable) - function in com.pspdfkit.ui.PdfPasswordView

Called after each Editable text change.

afterTextChanged(android.text.Editable) - function in com.pspdfkit.ui.inspector.views.OptionPickerInspectorView

ALAW - enum entry in com.pspdfkit.annotations.sound.AudioEncoding

G.711A encoding. Playback of audio clips in this encoding is not supported.

AlignedAnnotationHinterDrawable - class in com.pspdfkit.ui.note

Note hinter drawable with configurable note alignment in both horizontal and vertical dimensions.

AlignedAnnotationHinterDrawable.HorizontalAlignment - class in com.pspdfkit.ui.note.AlignedAnnotationHinterDrawable

Enum with possible horizontal icon alignments.

AlignedAnnotationHinterDrawable.VerticalAlignment - class in com.pspdfkit.ui.note.AlignedAnnotationHinterDrawable

Enum with possible vertical icon alignments.

all() - function in com.pspdfkit.configuration.sharing.ShareFeatures

Creates an enum set containing all share features.

allFeatures() - function in com.pspdfkit.configuration.annotations.CopyPasteFeatures

Returns an EnumSet with all CopyPasteFeatures enabled.

allowMultipleBookmarksPerPage(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Sets whether multiple bookmarks per page can be added or not.

allowMultipleBookmarksPerPage(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets whether multiple bookmarks per page can be added or not.

ALREADY_AUTHENTICATING - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode

The operation cannot be performed at this time, because the document is busy authenticating.

You will encounter this error code when you call reauthenticateWithJwtAsync, syncAnnotationsAsync, or their synchronous counterparts on a document that is in the process of authenticating.

ALREADY_SYNCING - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode

A new sync request has not been initiated because there already was one running.

ALWAYS_SAVE - enum entry in com.pspdfkit.configuration.signatures.SignatureSavingStrategy

Always saves the signature. Does not display the save signature checkbox to give the user the option.

Analytics - class in com.pspdfkit.analytics

PSPDFKit analytics API.

Analytics.Data - class in com.pspdfkit.analytics.Analytics

Analytics event data keys.

Analytics.Event - class in com.pspdfkit.analytics.Analytics

Analytics event.

AnalyticsClient - class in com.pspdfkit.analytics

Interface of a client that can receive analytics data.

animateScrollOnEdgeTaps(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Sets whether page changes triggered by tapping the page edge cause an animation.

animateScrollOnEdgeTaps(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets whether page changes triggered by tapping the page edge cause an animation.

Annotation - class in com.pspdfkit.annotations

Represents a generic annotation in the PDF document.

ANNOTATION_ALPHA - enum entry in com.pspdfkit.annotations.configuration.AnnotationProperty

Alpha value of the annotation. Controls alpha slider in the annotation inspector.

ANNOTATION_COPY_PASTE_SYSTEM_INTEGRATION - enum entry in com.pspdfkit.configuration.policy.ApplicationPolicy.PolicyEvent

Annotation copy/paste system clipboard integration policy event. If this is enabled:

The text of copied free-text annotation will be put in the system clipboard and text copied to the system clipboard can be pasted as FreeTextAnnotations.
The image of copied image stamp annotation will be put in the system clipboard and image copied to the system clipboard can be pasted as image annotations.

ANNOTATION_EDITING - enum entry in com.pspdfkit.LicenseFeature

Edit/Create annotations.

ANNOTATION_MULTI_SELECTION - enum entry in com.pspdfkit.ui.special_mode.controller.AnnotationTool

Allows selection of multiple annotations

ANNOTATION_NOTE - enum entry in com.pspdfkit.annotations.configuration.AnnotationProperty

Annotation note. Controls whether note editing should be enabled.

ANNOTATION_REPLIES - enum entry in com.pspdfkit.LicenseFeature

Allows annotation replies and reviews.

AnnotationAddRemoveEdit - class in com.pspdfkit.undo.edit.annotations

Edit that represents adding or removing annotation from the document.

AnnotationAddRemoveEdit.Type - class in com.pspdfkit.undo.edit.annotations.AnnotationAddRemoveEdit

Possible types of AnnotationAddRemoveEdit objects.

AnnotationAggregationStrategy - class in com.pspdfkit.configuration.annotations

Defines how INK splits drawn lines into new annotations.

AnnotationAggregationStrategyConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation aggregation strategy used to control strategy for creating annotations from drawn lines.

AnnotationAggregationStrategyConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationAggregationStrategyConfiguration

Builder for AnnotationAggregationStrategyConfiguration.

AnnotationAlphaConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation alpha (ANNOTATION_ALPHA).

AnnotationAlphaConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationAlphaConfiguration

Builder for AnnotationAlphaConfiguration.

AnnotationBorderStyleConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation border style (BORDER_STYLE).

AnnotationBorderStyleConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationBorderStyleConfiguration

Builder for AnnotationBorderStyleConfiguration.

AnnotationColorConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation foreground color (COLOR).

AnnotationColorConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationColorConfiguration

Builder for AnnotationColorConfiguration.

AnnotationConfiguration - class in com.pspdfkit.annotations.configuration

Base for all annotation configuration classes.

AnnotationConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationConfiguration

Builder for AnnotationConfiguration.

AnnotationConfigurationRegistry - class in com.pspdfkit.annotations.configuration

Interface for objects that manage a list of AnnotationConfiguration for supported annotation types.

AnnotationCreationController - class in com.pspdfkit.ui.special_mode.controller

Default controller given when entering annotation creation mode.

AnnotationCreationInspectorController - class in com.pspdfkit.ui.inspector.annotation

Interface for annotation inspector shown when creating annotations.

AnnotationCreationToolbar - class in com.pspdfkit.ui.toolbar

A toolbar used for creating annotations.

AnnotationCreationToolbar.ItemToAnnotationToolMapper - class in com.pspdfkit.ui.toolbar.AnnotationCreationToolbar

A mapper that allows you to map the IDs of AnnotationCreationToolbar menu items with the annotation tool (and variant) you want it to activate/deactivate.

AnnotationCreationToolbarGroupingRule - class in com.pspdfkit.ui.toolbar.grouping.presets

Default grouping rule of the AnnotationCreationToolbar.

AnnotationCreationToolbarItemGroups - class in com.pspdfkit.ui.toolbar.grouping.presets

MenuItem groups used in the numbered items groupings in AnnotationCreationToolbarItemPresets

AnnotationCreationToolbarItemPresets - class in com.pspdfkit.ui.toolbar.grouping.presets

List of different presets for the AnnotationCreationToolbar (based on the available space of icons visible on the current device).

AnnotationCreatorInputDialogFragment - class in com.pspdfkit.ui

AnnotationCreatorInputDialogFragment facilitates setting the annotation creator.

AnnotationCreatorInputDialogFragment.OnAnnotationCreatorSetListener - class in com.pspdfkit.ui.AnnotationCreatorInputDialogFragment

This listener interface needs to be implemented by any class that wishes to handle AnnotationCreatorInputDialogFragment specific dialog events.

AnnotationEdit - class in com.pspdfkit.undo.edit.annotations

Represents a single edit performed on the annotation.

AnnotationEditingController - class in com.pspdfkit.ui.special_mode.controller

Default controller given when entering annotation editing mode.

annotationEditingEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Enable/disable annotation editing functionality.

annotationEditingEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Enable/disable annotation editing functionality.

AnnotationEditingInspectorController - class in com.pspdfkit.ui.inspector.annotation

Interface for annotation inspector shown when editing annotations.

AnnotationEditingToolbar - class in com.pspdfkit.ui.toolbar

Toolbar shown when annotations are being edited.

AnnotationEditingToolbarGroupingRule - class in com.pspdfkit.ui.toolbar.grouping.presets

Default grouping rule of the AnnotationEditingToolbar.

AnnotationEditingToolbarItemPresets - class in com.pspdfkit.ui.toolbar.grouping.presets

List of different presets for the AnnotationEditingToolbar (based on the available space of icons visible on the current device).

AnnotationEditor - class in com.pspdfkit.ui.editor

For internal usage only.

AnnotationEditor.OnDismissedListener - class in com.pspdfkit.ui.editor.AnnotationEditor

Listener to be called once the annotation editor has been dismissed.

AnnotationFillColorConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation fill color (FILL_COLOR).

AnnotationFillColorConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationFillColorConfiguration

Builder for AnnotationFillColorConfiguration.

AnnotationFlags - class in com.pspdfkit.annotations

Specifies various characteristics of the annotation.

AnnotationFontConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation font (FONT).

AnnotationFontConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationFontConfiguration

Builder for AnnotationFontConfiguration.

AnnotationInspectorController - class in com.pspdfkit.ui.special_mode.controller

Controller responsible for managing annotation inspector.

AnnotationLineEndsConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation line ends (LINE_ENDS).

AnnotationLineEndsConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationLineEndsConfiguration

Builder for AnnotationLineEndsConfiguration.

annotationListEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Enable/disable the list of annotations.

AnnotationListener - class in com.pspdfkit.jetpack.compose.interactors

Wrapper for holding AnnotationListener callbacks

annotationListeners(kotlin.jvm.functions.Function3,kotlin.jvm.functions.Function2,kotlin.jvm.functions.Function2,kotlin.jvm.functions.Function2) - function in com.pspdfkit.jetpack.compose.interactors.DefaultListeners

annotationListReorderingEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets whether reordering annotations in the annotation list is enabled.

AnnotationManager - class in com.pspdfkit.ui.special_mode.manager

Interface for objects that manage a list of annotation listener instances.

AnnotationManager.OnAnnotationCreationModeChangeListener - class in com.pspdfkit.ui.special_mode.manager.AnnotationManager

Listener for annotation creation mode enter/exit.

AnnotationManager.OnAnnotationCreationModeSettingsChangeListener - class in com.pspdfkit.ui.special_mode.manager.AnnotationManager

Listener for annotation creation mode settings changes.

AnnotationManager.OnAnnotationDeselectedListener - class in com.pspdfkit.ui.special_mode.manager.AnnotationManager

Listener for annotation deselection.

AnnotationManager.OnAnnotationEditingModeChangeListener - class in com.pspdfkit.ui.special_mode.manager.AnnotationManager

Listener for annotation editing mode enter/exit.

AnnotationManager.OnAnnotationSelectedListener - class in com.pspdfkit.ui.special_mode.manager.AnnotationManager

Listener for annotation selection.

AnnotationNoteHinter - class in com.pspdfkit.ui.note

PdfDrawableProvider creating visual contents hints for supported Annotation.

AnnotationNoteHinterThemeConfiguration - class in com.pspdfkit.ui.note

Wrapper class for extracting annotation note hinter theme attributes.

AnnotationNoteIconConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for note annotation icons (NOTE_ICON).

AnnotationNoteIconConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationNoteIconConfiguration

Builder for AnnotationNoteIconConfiguration.

AnnotationOutlineColorConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation outline color (OUTLINE_COLOR).

AnnotationOutlineColorConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationOutlineColorConfiguration

Builder for AnnotationOutlineColorConfiguration.

AnnotationOverlayRenderStrategy - class in com.pspdfkit.ui.rendering

Strategy that controls how annotations are rendered inside annotation overlay.

AnnotationOverlayRenderStrategy.Strategy - class in com.pspdfkit.ui.rendering.AnnotationOverlayRenderStrategy

Enum with possible annotation overlay rendering strategies.

AnnotationOverlayTextConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation overlay text (OVERLAY_TEXT and REPEAT_OVERLAY_TEXT).

AnnotationOverlayTextConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationOverlayTextConfiguration

Builder for AnnotationOverlayTextConfiguration.

annotationPopupToolbarEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Sets whether the annotation popup toolbar is enabled or not.

annotationPopupToolbarEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Sets whether the annotation popup toolbar is enabled or not.

AnnotationPrecisionConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation precision (MEASUREMENT_PRECISION).

AnnotationPrecisionConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationPrecisionConfiguration

Builder for AnnotationPrecisionConfiguration.

AnnotationPreferencesManager - class in com.pspdfkit.annotations.defaults

Manager providing access to annotation editing preferences.

AnnotationPreviewConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for preview in annotation inspector.

AnnotationPreviewConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationPreviewConfiguration

Builder for AnnotationOverlayTextConfiguration.

AnnotationProperty - class in com.pspdfkit.annotations.configuration

Supported annotation properties.

AnnotationPropertyEdit - class in com.pspdfkit.undo.edit.annotations

Annotation edit performed on the existing annotation property.

AnnotationProvider - class in com.pspdfkit.annotations

Handles all annotation related operations on the owning document.

AnnotationProvider.OnAnnotationUpdatedListener - class in com.pspdfkit.annotations.AnnotationProvider

Listener for annotation update events inside AnnotationProvider.

AnnotationRenderConfiguration - class in com.pspdfkit.configuration.rendering

Advanced configuration for annotation rendering.

AnnotationRenderConfiguration.Builder - class in com.pspdfkit.configuration.rendering.AnnotationRenderConfiguration

Builder to create a instance.

annotationReplyFeatures(com.pspdfkit.configuration.annotations.AnnotationReplyFeatures) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Configures which part of the annotation replies UI is enabled.

annotationReplyFeatures(com.pspdfkit.configuration.annotations.AnnotationReplyFeatures) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Configures which part of the annotation replies UI is enabled.

AnnotationReplyFeatures - class in com.pspdfkit.configuration.annotations

Which features of annotation replies should be enabled.

AnnotationReviewSummary - class in com.pspdfkit.annotations.note

Summarizes the information about an annotation’s review state.

annotationRotationEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Enable/disable annotation rotation functionality.

annotationRotationEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Enable/disable annotation rotation functionality.

ANNOTATIONS_AND_FORMS - enum entry in com.pspdfkit.document.DocumentPermissions

Add or modify text annotations, fill in interactive form fields, and, if bit 4 is also set, create or modify interactive form fields (including signature fields).

AnnotationScaleConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation scale (SCALE).

AnnotationScaleConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationScaleConfiguration

Builder for AnnotationScaleConfiguration.

AnnotationSelectionController - class in com.pspdfkit.ui.special_mode.controller

Controls configurable properties on annotation selection layout that allows touch based editing (i.e.

AnnotationSelectionViewThemeConfiguration - class in com.pspdfkit.configuration.theming

Configuration class holding all resolved theme configuration properties related to the annotation selection view.

AnnotationSelectionViewThemeConfiguration.Builder - class in com.pspdfkit.configuration.theming.AnnotationSelectionViewThemeConfiguration

Builder used to construct the AnnotationSelectionViewThemeConfiguration instance.

AnnotationStateChange - class in com.pspdfkit.annotations.note

A structure that represents any change of review status for a markup annotation.

AnnotationTextResizingConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for automatic text resizing of com.pspdfkit.annotations.FreeTextAnnotation.

AnnotationTextResizingConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationTextResizingConfiguration

Builder for AnnotationTextResizingConfiguration.

AnnotationTextSizeConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation text size (TEXT_SIZE).

AnnotationTextSizeConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationTextSizeConfiguration

Builder for AnnotationTextSizeConfiguration.

AnnotationThicknessConfiguration - class in com.pspdfkit.annotations.configuration

Configuration for annotation thickness (THICKNESS).

AnnotationThicknessConfiguration.Builder - class in com.pspdfkit.annotations.configuration.AnnotationThicknessConfiguration

Builder for AnnotationThicknessConfiguration.

AnnotationTool - class in com.pspdfkit.ui.special_mode.controller

All currently supported tools when creating annotations.

AnnotationToolVariant - class in com.pspdfkit.ui.special_mode.controller

Annotation tools can have variants represented by the name.

AnnotationToolVariant.Preset - class in com.pspdfkit.ui.special_mode.controller.AnnotationToolVariant

Annotation tool variants defined by the framework.

AnnotationTriggerEvent - class in com.pspdfkit.annotations.actions

Type of the annotation trigger events.

AnnotationType - class in com.pspdfkit.annotations

All currently supported annotation types.

AnnotationViewsListener - class in com.pspdfkit.ui.annotations

AnnotationZIndexEdit - class in com.pspdfkit.undo.edit.annotations

Represents a single edit of an annotation z-index.

AnnotationZIndexMove - class in com.pspdfkit.annotations

The possible z-index moves that can be applied on the annotation.

AP_STREAM_RENDERING - enum entry in com.pspdfkit.ui.rendering.AnnotationOverlayRenderStrategy.Strategy

Display rendered PDF appearance for annotation (i.e. its AP stream) in overlay.

Note that some annotation types (sound) are always displayed in overlay.

Annotations rendered using the AP stream are rendered as specified in the PDF document and are therefore displayed the exact same way on all PDF spec compliant PDF readers. Since documents can store arbitrary appearances for annotations, this means that PSPDFKit has to switch to non-AP stream rendering upon editing an annotation. This can lead to slightly slower annotation selection speeds than using PLATFORM_RENDERING in trade-off for higher rendering accuracy.

AppCompatTextViewTint - class in com.pspdfkit.ui

TextView class that extends support to drawable tint for Android API lower than 23 by using style attribute pspdf__drawableTint.

AppearanceStreamGenerator - class in com.pspdfkit.annotations.appearance

Interface for custom annotation appearance stream generators.

AppearanceStreamGenerator.AppearanceStreamGenerationOptions - class in com.pspdfkit.annotations.appearance.AppearanceStreamGenerator

Options for appearance stream generation.

APPEND_TO_FILE - enum entry in com.pspdfkit.document.providers.WritableDataProvider.WriteMode

Changes must only be appended to existing file.

appendAnnotationState(com.pspdfkit.annotations.Annotation,com.pspdfkit.annotations.note.AnnotationStateChange) - function in com.pspdfkit.annotations.AnnotationProvider

Appends a new annotation state for the given annotation (adds it to the review history).

appendAnnotationStateAsync(com.pspdfkit.annotations.Annotation,com.pspdfkit.annotations.note.AnnotationStateChange) - function in com.pspdfkit.annotations.AnnotationProvider

Appends a new annotation state for the given annotation asynchronously (adds it to the review history).

APPLE_PENCIL - enum entry in com.pspdfkit.signatures.BiometricSignatureData.InputMethod

An Apple Pencil used for creating the signature.

ApplicationPolicy - class in com.pspdfkit.configuration.policy

Application policy.

ApplicationPolicy.PolicyEvent - class in com.pspdfkit.configuration.policy.ApplicationPolicy

Currently supported policy events.

apply(android.graphics.Bitmap) - function in com.pspdfkit.ui.PdfThumbnailBar.ConvertToDrawable

applyRedactions() - function in com.pspdfkit.document.processor.PdfProcessorTask

Applies the redact annotations for the given page index.

APPROVED - enum entry in com.pspdfkit.annotations.stamps.PredefinedStampType

AREA - enum entry in com.pspdfkit.annotations.measurements.MeasurementMode

Area measurement.

areGeneratedGroupItemsSelectable() - function in com.pspdfkit.ui.toolbar.grouping.DefaultMenuItemGroupingRule

Indicates whether the group items (that are generated to fit items when not enough space) are selectable or not.

areGeneratedGroupItemsSelectable() - function in com.pspdfkit.ui.toolbar.grouping.MenuItemGroupingRule

Indicates whether the group items (that are generated to fit items when not enough space) are selectable or not.

areGeneratedGroupItemsSelectable() - function in com.pspdfkit.ui.toolbar.grouping.presets.AnnotationCreationToolbarGroupingRule

Indicates whether the group items (that are generated to fit items when not enough space) are selectable or not.

ARRAY - enum entry in com.pspdfkit.document.PdfValue.PdfValueType

ARROW - enum entry in com.pspdfkit.ui.special_mode.controller.AnnotationToolVariant.Preset

Preset for the 'arrow' variant, used with the LINE in the framework.

AS_IS - enum entry in com.pspdfkit.annotations.stamps.PredefinedStampType

ASSEMBLE - enum entry in com.pspdfkit.document.DocumentPermissions

(Security handlers of revision 3 or greater) Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if bit 4 is clear.

AssetAnnotation - class in com.pspdfkit.annotations

Abstract subclass that contains an asset from a link.

AssetAppearanceStreamGenerator - class in com.pspdfkit.annotations.appearance

Annotation appearance stream generator that supplies a PDF file in app assets to be used as annotation appearance stream.

AssetDataProvider - class in com.pspdfkit.document.providers

Data provider for opening PDF documents directly from the app's assets.

AssetDownloadSource - class in com.pspdfkit.document.download.source

A source for copying a PDF document from the app assets to the filesystem.

AssetsContentProvider - class in com.pspdfkit.media

A content provider that serves files from the app's assets.

attachBinaryInstantJsonAttachment(com.pspdfkit.document.providers.DataProvider,java.lang.String) - function in com.pspdfkit.annotations.Annotation

Attaches a binary instant JSON attachment to the annotation.

attachContextualToolbar() - function in com.pspdfkit.ui.toolbar.ToolbarCoordinatorLayout

Attach current contextual toolbar (if any) to the layout so it's unable to move.

attachContextualToolbar() - function in com.pspdfkit.ui.toolbar.ToolbarCoordinatorLayoutController

Attach current contextual toolbar (if any) to the layout so it's unable to move.

ATTACHMENT_ALREADY_TRANSFERRED - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode

Internal error code — if you ever see this reported, please file a bug.

ATTACHMENT_NOT_LOADED - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode

An attachment with the given ID does not exist in the disk cache.

To find out whether or not the attachment actually exists, try downloading it from the server.

ATTACHMENT_TRANSFER_IN_PROGRESS - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode

Internal error code — if you ever see this reported, please file a bug.

AudioEncoding - class in com.pspdfkit.annotations.sound

The encoding format for the audio samples data.

AudioExtractor - class in com.pspdfkit.annotations.sound

Extracts audio from media files into EmbeddedAudioSource that is usable for creating SoundAnnotation.

AudioModeListeners - class in com.pspdfkit.ui.audio

Interface for objects that manage a list of audio mode listener instances.

AudioModeListeners.AudioPlaybackModeChangeListener - class in com.pspdfkit.ui.audio.AudioModeListeners

Listener for audio playback mode changes.

AudioModeListeners.AudioRecordingModeChangeListener - class in com.pspdfkit.ui.audio.AudioModeListeners

Listener for audio recording mode changes.

AudioModeManager - class in com.pspdfkit.ui.audio

Interface for objects managing audio modes.

AudioPlaybackController - class in com.pspdfkit.ui.audio

Controller given when entering audio playback mode.

AudioPlaybackController.AudioPlaybackListener - class in com.pspdfkit.ui.audio.AudioPlaybackController

Listener for audio playback events.

AudioRecordingController - class in com.pspdfkit.ui.audio

Controller given when entering audio recording mode.

AudioRecordingController.AudioRecordingListener - class in com.pspdfkit.ui.audio.AudioRecordingController

Listener for audio recording events.

AudioResourceEdit - class in com.pspdfkit.undo.edit.annotations

Annotation edit performed on sound annotation's resource.

AudioView - class in com.pspdfkit.ui.audio

Bottom auxiliary bar displayed when interacting with sound annotations.

AudioView.AudioInspectorLifecycleListener - class in com.pspdfkit.ui.audio.AudioView

Listener for the lifecycle of the AudioView.

AUTHENTICATION_FAILED - enum entry in com.pspdfkit.instant.exceptions.InstantErrorCode

The process could not be completed because the authentication failed.

This typically means either the user no longer has access to the document or the authentication token (JWT) expired. Your own server should be able to say if the user still has access. If the user still has access, obtain a new authentication token from your server and call reauthenticateWithJwtAsync on your document. If the user no longer has access, stop showing this document to the user.

Note that the document’s storage will not be removed from disk! You can still access that document, and even continue to make edits to it. These will, however, not be synced anymore.

You need to obtain a new authentication token, and retry your operation. Until then, anything that would hit the Instant Server (PSPDFKit Document Engine) will fail again.

AuthorState - class in com.pspdfkit.annotations.note

Author review and marking states that can be set on the note annotation content and replies.

AUTO - enum entry in com.pspdfkit.configuration.page.PageLayoutMode

Pages will be adapted to the screen, so on the larger devices in landscape orientation a double page mode will be used, compared to a single page mode otherwise.

AUTO_PLAY - enum entry in com.pspdfkit.annotations.actions.MediaOptions

Specifies that the media should be auto-played.

AUTOMATIC - enum entry in com.pspdfkit.configuration.activity.TabBarHidingMode

Hide the tabbed bar only when there are no documents.

AUTOMATIC - enum entry in com.pspdfkit.configuration.annotations.AnnotationAggregationStrategy

Stokes that are drawn close together without too much delay are merged.

AUTOMATIC - enum entry in com.pspdfkit.configuration.forms.SignaturePickerOrientation

Default value, locks to landscape on phones and follows screen orientation on bigger devices.

AUTOMATIC_HIDE_SINGLE - enum entry in com.pspdfkit.configuration.activity.TabBarHidingMode

Hide the tabbed bar when there is a single document or no documents.

automaticallyGenerateLinks(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Enables or disables automatic link generation.

automaticallyGenerateLinks(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Enables or disables automatic link generation.

autosaveEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Enables or disables auto-saving of PDF document changes.

autosaveEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.activity.PdfActivityConfiguration.Builder

Enables or disables autosaving of modified PDF documents.

autoSelectNextFormElementEnabled(java.lang.Boolean) - function in com.pspdfkit.configuration.PdfConfiguration.Builder

Enable/disable functionality that automatically selects next form element.

awakenScrollBar() - function in com.pspdfkit.ui.scrollbar.VerticalScrollBar

Manually shows the scroll indicator, hiding it after some time.

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z