nutrient/com.pspdfkit.ui.toolbar/AnnotationEditingToolbar

AnnotationEditingToolbar

class AnnotationEditingToolbar : ContextualToolbar<AnnotationEditingController> , AnnotationProvider.OnAnnotationUpdatedListener, OnAnnotationEditingModeChangeListener, UndoRedoToolbarHelper.UndoRedoToolbarHost

Toolbar shown when annotations are being edited.

Constructors

constructor(context: Context)

constructor(context: Context, attrs: AttributeSet?)

constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int)

Types

Companion

object Companion

Companion object containing style attributes for the annotation editing toolbar.

Properties

configuration

open override val configuration: PdfConfiguration?

The PDF configuration used by this toolbar's controller.

controller

var controller: AnnotationEditingController?

The currently bound annotation editing controller, or {@code null} if unbound.

fragment

open override val fragment: PdfFragment?

The PDF fragment associated with this toolbar's controller.

isControllerBound

open override val isControllerBound: Boolean

Functions

bindController

open override fun bindController(controller: AnnotationEditingController)

Bind annotation editing controller.

getLifecycleOwner

open override fun getLifecycleOwner(): LifecycleOwner?

Returns the lifecycle owner for coroutine scope management.

isControllerBound

open override fun isControllerBound(): Boolean

Returns true if the controller is bound.

onAnnotationCreated

open override fun onAnnotationCreated(annotation: Annotation)

Called when annotation has been created.

onAnnotationRemoved

open override fun onAnnotationRemoved(annotation: Annotation)

Called when existing annotation has been removed.

onAnnotationUpdated

open override fun onAnnotationUpdated(annotation: Annotation)

Called when existing annotation has changed.

onAnnotationZOrderChanged

open override fun onAnnotationZOrderChanged(pageIndex: Int, oldOrder: List<Annotation>, newOrder: List<Annotation>)

Called when the z-order of annotations has changed on a specified page.

onChangeAnnotationEditingMode

open override fun onChangeAnnotationEditingMode(controller: AnnotationEditingController)

Called then annotation editing mode changes, meaning another annotation is being selected for editing.

onEnterAnnotationEditingMode

open override fun onEnterAnnotationEditingMode(controller: AnnotationEditingController)

Called when annotation editing mode has been entered.

onExitAnnotationEditingMode

open override fun onExitAnnotationEditingMode(controller: AnnotationEditingController)

Called when annotation editing mode has been exited.

unbindController

open override fun unbindController()

Unbind current annotation editing controller (if any).