pspdfkit/com.pspdfkit.ui.special_mode.controller/AnnotationCreationController

AnnotationCreationController

interface AnnotationCreationController : FragmentSpecialModeController

Default controller given when entering annotation creation mode. Used to control annotation creation mode properties and 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
abstract fun changeAnnotationCreationMode(@NonNull annotationTool: AnnotationTool, @NonNull annotationToolVariant: AnnotationToolVariant)
Starts an annotation creation mode with different annotation tool selected.
Link copied to clipboard
abstract fun displayScalePicker()
Displays/hides an annotation inspector for the measurement annotation types.
Link copied to clipboard
@Nullable
abstract fun getActiveAnnotationTool(): AnnotationTool
Returns annotation creation tool that is currently active.
Link copied to clipboard
@Nullable
abstract fun getActiveAnnotationToolVariant(): AnnotationToolVariant
Returns the variant of the annotation creation tool that is currently active.
Link copied to clipboard
@FloatRange(from = 0.0, to = 1.0)
abstract fun getAlpha(): Float
Gets alpha set to the annotation creation mode.
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 getAnnotationPreferences(): AnnotationPreferencesManager
Returns an annotation editing preferences.
Link copied to clipboard
@NonNull
abstract fun getBorderStylePreset(): BorderStylePreset
Gets border style preset set to the annotation creation mode.
Link copied to clipboard
@ColorInt
abstract fun getColor(): Int
Gets current color set to the annotation creation mode.
Link copied to clipboard
@NonNull
abstract fun getConfiguration(): PdfConfiguration
Returns an active configuration.
Link copied to clipboard
@ColorInt
abstract fun getFillColor(): Int
Gets fill color set to the annotation creation mode.
Link copied to clipboard
abstract fun getFont(): Font
Gets the font set to the annotation creation mode.
Link copied to clipboard
@NonNull
abstract fun getLineEnds(): Pair<LineEndType, LineEndType>
Returns current line ending styles for drawn lines.
Link copied to clipboard
abstract fun getMeasurementValueConfiguration(): MeasurementValueConfiguration
Gets the MeasurementValueConfiguration for measurement annotations.
Link copied to clipboard
@ColorInt
abstract fun getOutlineColor(): Int
Gets outline color set to the annotation creation mode.
Link copied to clipboard
@NonNull
abstract fun getOverlayText(): String
Gets the overlay text set to the annotation creation mode.
Link copied to clipboard
abstract fun getRepeatOverlayText(): Boolean
Returns whether the overlay text should be repeated or not.
Link copied to clipboard
@FloatRange(from = 1)
abstract fun getTextSize(): Float
Gets text size set to the annotation creation mode.
Link copied to clipboard
@FloatRange(from = 1)
abstract fun getThickness(): Float
Gets thickness set to the annotation creation mode.
Link copied to clipboard
abstract fun setAlpha(@FloatRange(from = 0.0, to = 1.0) alpha: Float)
Sets alpha to the annotation creation mode.
Link copied to clipboard
abstract fun setBorderStylePreset(@NonNull borderPreset: BorderStylePreset)
Sets border preset to the annotation creation mode.
Link copied to clipboard
abstract fun setColor(@ColorInt color: Int)
Sets color for the annotation creation mode.
Link copied to clipboard
abstract fun setFillColor(@ColorInt fillColor: Int)
Sets fill color for the annotation creation mode.
Link copied to clipboard
abstract fun setFont(@NonNull font: Font)
Sets the font to the annotation creation mode.
Link copied to clipboard
abstract fun setLineEnds(@NonNull lineEnd1: LineEndType, @NonNull lineEnd2: LineEndType)
Sets line ending style for drawn lines.
Link copied to clipboard
abstract fun setMeasurementValueConfiguration(@Nullable configuration: MeasurementValueConfiguration)
Sets the MeasurementValueConfiguration for measurement annotations.
Link copied to clipboard
abstract fun setOutlineColor(@ColorInt outlineColor: Int)
Sets outline color for the annotation creation mode.
Link copied to clipboard
abstract fun setOverlayText(@NonNull overlayText: String)
Sets the overlay text to the annotation creation mode.
Link copied to clipboard
abstract fun setRepeatOverlayText(repeatOverlayText: Boolean)
Sets if the overlay text should be repeated.
Link copied to clipboard
abstract fun setTextSize(@FloatRange(from = 1) textSize: Float)
Sets text size to the annotation creation mode.
Link copied to clipboard
abstract fun setThickness(@FloatRange(from = 1) thickness: Float)
Sets thickness to the annotation creation mode.
Link copied to clipboard
abstract fun shouldDisplayPicker(): Boolean
Whether annotation inspector toolbar icon should be visible.
Link copied to clipboard
abstract fun showAnnotationEditor(@NonNull annotation: Annotation)
Shows annotation editor for the passed annotation.
Link copied to clipboard
abstract fun toggleAnnotationInspector()
Displays/hides an annotation inspector for the selected annotation type.
Link copied to clipboard
abstract fun unbindAnnotationInspectorController()
Unbinds from previously bound annotation inspector controller.