pspdfkit/com.pspdfkit.ui.toolbar/AnnotationCreationToolbar

AnnotationCreationToolbar

open class AnnotationCreationToolbar : ContextualToolbar<T> , AnnotationManager.OnAnnotationCreationModeSettingsChangeListener, AnnotationManager.OnAnnotationCreationModeChangeListener, OnUndoHistoryChangeListener

A toolbar used for creating annotations.

Constructors

Link copied to clipboard
constructor(context: Context)
constructor(context: Context, attrs: AttributeSet)
constructor(context: Context, attrs: AttributeSet, defStyleAttr: Int)

Types

Link copied to clipboard
interface ItemToAnnotationToolMapper
A mapper that allows you to map the IDs of AnnotationCreationToolbar menu items with the annotation tool (and variant) you want it to activate/deactivate.

Properties

Link copied to clipboard
@Nullable
open var itemToAnnotationToolMapper: AnnotationCreationToolbar.ItemToAnnotationToolMapper
Mapper for mapping annotation creation tool menu items with the tool/variant they want to activate.

Functions

Link copied to clipboard
open fun bindController(@NonNull controller: AnnotationCreationController)
Binds controller for managing annotation creation mode.
Link copied to clipboard
open fun isControllerBound(): Boolean
Returns true if the controller is bound.
Link copied to clipboard
open fun onAnnotationCreationModeSettingsChange(@NonNull controller: AnnotationCreationController)
Called when the settings changed in the active annotation creation mode.
Link copied to clipboard
open fun onChangeAnnotationCreationMode(@NonNull controller: AnnotationCreationController)
Called when the annotation creation mode has changed, meaning another annotation type is being selected for creation.
Link copied to clipboard
open fun onEnterAnnotationCreationMode(@NonNull controller: AnnotationCreationController)
Called when the annotation creation mode has been entered.
Link copied to clipboard
open fun onExitAnnotationCreationMode(@NonNull controller: AnnotationCreationController)
Called when the annotation creation mode has been exited.
Link copied to clipboard
@NonNull
open fun onMenuItemsGrouped(@NonNull menuItems: List<ContextualToolbarMenuItem>): List<ContextualToolbarMenuItem>
Called when the menu items are being grouped.
Link copied to clipboard
open fun onUndoHistoryChanged(@NonNull undoManager: UndoManager)
Notifies the observer that the undo history has changed inside the undo manager.
Link copied to clipboard
open fun setItemToAnnotationToolMapper(@Nullable itemToAnnotationToolMapper: AnnotationCreationToolbar.ItemToAnnotationToolMapper)
Mapper for mapping annotation creation tool menu items with the tool/variant they want to activate.
Link copied to clipboard
open fun setShouldShowStylusButton(shouldShow: Boolean)
Whether to show the stylus button on the annotation toolbar when a stylus is detected as connected.
Link copied to clipboard
open fun unbindController()
Unbinds controller for managing annotation creation mode.