pspdfkit/com.pspdfkit.instant.ui/InstantPdfFragment

InstantPdfFragment

open class InstantPdfFragment : PdfFragment, InstantDocumentListener, AnnotationProvider.OnAnnotationUpdatedListener

Fragment that actually displays instant PDF document. It contains only the document view without any additional views like outline, thumbnail bar, search, etc. Meant to be used if you want full custom implementation and design.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
val PARAM_INSTANT_DOCUMENT_SOURCE: String = "Instant.InstantDocumentSource"

Functions

Link copied to clipboard
open fun addInstantDocumentListener(@NonNull listener: InstantDocumentListener)
Adds a InstantDocumentListener for instant document events.
Link copied to clipboard
@NonNull
open fun getAnnotationPreferences(): AnnotationPreferencesManager
Returns manager for annotation preferences.
Link copied to clipboard
@Nullable
open fun getDocument(): InstantPdfDocument
Gets the loaded document.
Link copied to clipboard
@NonNull
open fun getUndoManager(): UndoManager
Returns this fragment's undo manager instance for performing undo/redo operations of annotation edits.
Link copied to clipboard
@NonNull
open fun newInstance(@NonNull document: InstantPdfDocument, @NonNull configuration: PdfConfiguration): InstantPdfFragment
Creates and returns a new Fragment to display a PDF document from an already opened instance.
@NonNull
open fun newInstance(@NonNull serverUrl: String, @NonNull jwt: String, @NonNull configuration: PdfConfiguration): InstantPdfFragment
Creates and returns a new Fragment to display a PDF document downloaded from Instant Server (PSPDFKit Document Engine).
Link copied to clipboard
open fun onActivityCreated(@Nullable savedInstanceState: Bundle)
Link copied to clipboard
open fun onAnnotationCreated(@NonNull annotation: Annotation)
Called when annotation has been created.
Link copied to clipboard
open fun onAnnotationRemoved(@NonNull annotation: Annotation)
Called when existing annotation has been removed.
Link copied to clipboard
open fun onAnnotationUpdated(@NonNull annotation: Annotation)
Called when existing annotation has changed.
Link copied to clipboard
open fun onAnnotationZOrderChanged(pageIndex: Int, @NonNull oldOrder: List<Annotation>, @NonNull newOrder: List<Annotation>)
Called when the z-order of annotations has changed on a specified page.
Link copied to clipboard
open fun onAttach(@NonNull context: Context)
Link copied to clipboard
@UiThread
open fun onAuthenticationFailed(@NonNull instantDocument: InstantPdfDocument, @NonNull error: InstantException)
Called when authentication with Instant Server (PSPDFKit Document Engine) has failed.
Link copied to clipboard
@UiThread
open fun onAuthenticationFinished(@NonNull instantDocument: InstantPdfDocument, @NonNull validJwt: String)
Called when authentication with Instant Server (PSPDFKit Document Engine) has successfully finished.
Link copied to clipboard
open fun onCreate(savedInstanceState: Bundle)
Link copied to clipboard
@Nullable
open fun onCreateView(@NonNull inflater: LayoutInflater, @Nullable container: ViewGroup, @Nullable savedInstanceState: Bundle): View
Link copied to clipboard
open fun onDestroy()
Link copied to clipboard
open fun onDetach()
Link copied to clipboard
@UiThread
open fun onDocumentCorrupted(@NonNull instantDocument: InstantPdfDocument)
Called when InstantPdfDocument has detected data corruption.
Link copied to clipboard
@UiThread
open fun onDocumentInvalidated(@NonNull instantDocument: InstantPdfDocument)
Called when InstantPdfDocument becomes invalid.
Link copied to clipboard
@UiThread
open fun onDocumentLoaded(@NonNull document: PdfDocument)
Called when document is successfully loaded and the document view has been laid out.
Link copied to clipboard
open fun onDocumentStateChanged(@NonNull instantDocument: InstantPdfDocument, @NonNull state: InstantDocumentState)
Called when the document changes its state.
Link copied to clipboard
open fun onResume()
Link copied to clipboard
open fun onStop()
Link copied to clipboard
@UiThread
open fun onSyncError(@NonNull instantDocument: InstantPdfDocument, @NonNull error: InstantException)
Called when annotation sync has been finished with an error.
Link copied to clipboard
@UiThread
open fun onSyncFinished(@NonNull instantDocument: InstantPdfDocument)
Called when annotation sync has been finished successfully.
Link copied to clipboard
@UiThread
open fun onSyncStarted(@NonNull instantDocument: InstantPdfDocument)
Called when annotation sync has been started.
Link copied to clipboard
Link copied to clipboard
open fun save()
Saves the annotations in opened document back to Instant Server (PSPDFKit Document Engine).
Link copied to clipboard
open fun setHandleCriticalInstantErrors(showCriticalErrors: Boolean)
Sets whether the fragment should automatically handle certain critical Instant errors.
Link copied to clipboard
open fun setListenToServerChangesWhenVisible(listenToServerChangesWhenVisible: Boolean)
Controls whether to listen to server changes for loaded document when the fragment is resumed.
Link copied to clipboard
open fun setOverlaidAnnotationTypes(@NonNull overlayAnnotationTypes: EnumSet<AnnotationType>)
Sets annotation types that should be rendered as overlays.
Link copied to clipboard
open fun syncAnnotations()
Starts syncing annotations back to Instant Server (PSPDFKit Document Engine).