pspdfkit/com.pspdfkit.ui/DocumentCoordinator

DocumentCoordinator

interface DocumentCoordinator

Coordinates loading and display of multiple documents in com.pspdfkit.ui.PdfActivity. Use it to modify the list of loaded documents and to switch between them.

See also

Types

Link copied to clipboard
interface OnDocumentCoordinatorEmptyListener
Listener for the last document being removed from the DocumentCoordinator.
Link copied to clipboard
interface OnDocumentsChangedListener
Listener for changes made to documents managed by DocumentCoordinator.
Link copied to clipboard
interface OnDocumentVisibleListener
Listener for document becoming visible in the DocumentCoordinator.

Functions

Link copied to clipboard
@UiThread
abstract fun addDocument(@NonNull documentDescriptor: DocumentDescriptor): Boolean
Inserts a new document at the end of the documents list.
@UiThread
abstract fun addDocument(@NonNull documentDescriptor: DocumentDescriptor, index: Int): Boolean
Inserts a new document at the specified index.
Link copied to clipboard
@UiThread
abstract fun addDocumentAfterVisibleDocument(@NonNull documentDescriptor: DocumentDescriptor): Boolean
Inserts a document after the current visible document.
Link copied to clipboard
abstract fun addOnDocumentCoordinatorEmptyListener(@NonNull listener: DocumentCoordinator.OnDocumentCoordinatorEmptyListener)
Registers a OnDocumentCoordinatorEmptyListener to get notified when document gets visible in the manager.
Link copied to clipboard
abstract fun addOnDocumentsChangedListener(@NonNull listener: DocumentCoordinator.OnDocumentsChangedListener)
Registers a OnDocumentsChangedListener to get notified when items in document coordinator change.
Link copied to clipboard
abstract fun addOnDocumentVisibleListener(@NonNull listener: DocumentCoordinator.OnDocumentVisibleListener)
Registers a OnDocumentVisibleListener to get notified when document gets visible in the manager.
Link copied to clipboard
@UiThread
@NonNull
abstract fun getDocuments(): List<DocumentDescriptor>
Returns all documents managed by this coordinator.
Link copied to clipboard
@UiThread
@Nullable
abstract fun getVisibleDocument(): DocumentDescriptor
Returns currently visible document (if any).
Link copied to clipboard
@UiThread
abstract fun moveDocument(@NonNull documentToMove: DocumentDescriptor, targetIndex: Int): Boolean
Moves documents in the document list to specified position.
Link copied to clipboard
@UiThread
abstract fun removeAllDocuments(): Boolean
Removes all documents managed by this coordinator.
Link copied to clipboard
@UiThread
abstract fun removeAllDocumentsExceptVisible(): Boolean
Removes all documents managed by this coordinator except for the currently visible one.
Link copied to clipboard
@UiThread
abstract fun removeDocument(@NonNull documentDescriptor: DocumentDescriptor): Boolean
Removes the document if it's managed by this coordinator.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
@UiThread
abstract fun setDocument(@NonNull documentDescriptor: DocumentDescriptor): Boolean
Replaces currently visible document with another document.
Link copied to clipboard
@UiThread
abstract fun setVisibleDocument(@NonNull visibleDocument: DocumentDescriptor): Boolean
Changes currently visible document.