pspdfkit/com.pspdfkit.ui.special_mode.controller/AnnotationEditingController

AnnotationEditingController

interface AnnotationEditingController : FragmentSpecialModeController

Default controller given when entering annotation editing mode. Used to control annotation editing mode actions.

Functions

Link copied to clipboard
abstract fun bindAnnotationInspectorController(@NonNull annotationInspectorController: AnnotationInspectorController)
Binds to the annotation inspector controller for managing annotation inspector.
Link copied to clipboard
open fun deleteCurrentlySelectedAnnotation()
Deletes currently selected annotations from the document.
Link copied to clipboard
abstract fun deleteCurrentlySelectedAnnotations()
Deletes currently selected annotations from the document.
Link copied to clipboard
abstract fun enterAudioPlaybackMode()
Starts playback mode for the currently selected sound annotation.
Link copied to clipboard
abstract fun enterAudioRecordingMode()
Starts recording mode for the currently selected sound annotation.
Link copied to clipboard
@NonNull
abstract fun getAnnotationManager(): AnnotationManager
Returns an annotation manager which you can use to register listeners from the controller.
Link copied to clipboard
@NonNull
abstract fun getConfiguration(): PdfConfiguration
Returns an active configuration.
Link copied to clipboard
@Nullable
open fun getCurrentlySelectedAnnotation(): Annotation
Returns the first of the currently edited annotations (if any).
Link copied to clipboard
@NonNull
abstract fun getCurrentlySelectedAnnotations(): List<Annotation>
Returns currently edited annotation (if any).
Link copied to clipboard
@Nullable
open fun getCurrentSingleSelectedAnnotation(): Annotation
Returns the the currently edited annotation - only if there's just a single one being edited.
Link copied to clipboard
open fun hasCurrentlySelectedAnnotations(): Boolean
Returns whether there are any currently selected annotations.
Link copied to clipboard
open fun isCopyEnabled(): Boolean
Checks if all currently edited annotations can be copied.
abstract fun isCopyEnabled(@Nullable annotations: List<Annotation>): Boolean
Checks if all provided annotations can be copied.
Link copied to clipboard
open fun isCutEnabled(): Boolean
Checks if all currently edited annotations can be cut.
open fun isCutEnabled(@Nullable annotations: List<Annotation>): Boolean
Checks if all provided annotations can be cut.
Link copied to clipboard
open fun isDeleteEnabled(): Boolean
Checks if all currently edited annotations can be deleted.
abstract fun isDeleteEnabled(@Nullable annotations: List<Annotation>): Boolean
Checks if all provided annotations can be deleted.
Link copied to clipboard
abstract fun recordAnnotationZIndexEdit(@NonNull annotation: Annotation, oldZIndex: Int, newZIndex: Int)
Records the z-index being changed on the specified annotation.
Link copied to clipboard
open fun saveCurrentlySelectedAnnotation()
Saves currently selected annotations to the document.
Link copied to clipboard
open fun saveCurrentlySelectedAnnotations()
Saves currently selected annotations to the document.
Link copied to clipboard
abstract fun shouldDisplayPicker(): Boolean
Whether annotation inspector toolbar icon should be visible.
Link copied to clipboard
abstract fun shouldDisplayPlayAudioButton(): Boolean
Whether play button should be displayed for the selected sound annotation.
Link copied to clipboard
abstract fun shouldDisplayRecordAudioButton(): Boolean
Whether record button should be displayed for the selected sound annotation.
Link copied to clipboard
abstract fun showAnnotationEditor(@NonNull annotation: Annotation)
Shows annotation editor for the passed annotation.
Link copied to clipboard
abstract fun showEditedAnnotationPositionOnThePage(pageIndex: Int)
Temporarily hides the selected/edited annotation view and shows its relative position on the page.
Link copied to clipboard
abstract fun startRecording()
Starts recording the edits.
Link copied to clipboard
abstract fun stopRecording()
Stops recording the edits, notifies the result and clears current record, so calling startRecording will start from clean state.
Link copied to clipboard
abstract fun toggleAnnotationInspector()
Displays/hides an annotation inspector for the selected annotation.
Link copied to clipboard
abstract fun unbindAnnotationInspectorController()
Unbinds from previously bound annotation inspector controller.