pspdfkit/com.pspdfkit.ui.special_mode.controller/TextSelectionController

TextSelectionController

interface TextSelectionController : FragmentSpecialModeController

Default controller given when entering text selection mode. Used to control text selection actions.

Types

Link copied to clipboard
interface OnSearchSelectedTextListener
Listener invoked when TextSelectionController wants to perform search for the selected text.

Functions

Link copied to clipboard
abstract fun createLinkAboveSelectedText()
Creates link above the selected text.
Link copied to clipboard
@Nullable
abstract fun getTextSelection(): TextSelection
Returns the current text selection.
Link copied to clipboard
@NonNull
abstract fun getTextSelectionManager(): TextSelectionManager
Gets text selection manager for registering text selection listeners from the controller.
Link copied to clipboard
abstract fun highlightSelectedText()
Highlight currently selected text.
Link copied to clipboard
open fun highlightSelectedTextAndBeginCommenting()
Highlight the currently selected text and begin editing its comments.
open fun isInstantHighlightCommentingEnabledByConfiguration(): Boolean
Indicates whether Instant Comments on text highlights are enabled by configuration
Link copied to clipboard
abstract fun isLinkCreationEnabledByConfiguration(): Boolean
Indicates whether annotation editing is enabled by configuration and link annotations are editable.
Link copied to clipboard
abstract fun isRedactionEnabledByConfiguration(): Boolean
Indicates whether text redaction is enabled by configuration-
abstract fun isTextExtractionEnabledByDocumentPermissions(): Boolean
Indicates whether the text extraction is enabled by document permissions, meaning the document contains EXTRACT permission.
Link copied to clipboard
abstract fun isTextHighlightingEnabledByConfiguration(): Boolean
Indicates whether annotation editing (text highlights are annotations) is enabled by configuration.
Link copied to clipboard
abstract fun isTextSharingEnabledByConfiguration(): Boolean
Indicates whether text sharing is enabled by configuration.
Link copied to clipboard
abstract fun isTextSpeakEnabledByDocumentPermissions(): Boolean
Indicates whether the text extraction for accessibility purposes is enabled by document permissions, meaning the document contains EXTRACT_ACCESSIBILITY permission.
Link copied to clipboard
abstract fun redactSelectedText()
Redact currently selected text.
Link copied to clipboard
abstract fun searchSelectedText()
Search currently selected text.
Link copied to clipboard
abstract fun setOnSearchSelectedTextListener(@Nullable searchSelectedTextListener: TextSelectionController.OnSearchSelectedTextListener)
Sets a new OnSearchSelectedTextListener or replaces an existing one.
Link copied to clipboard
abstract fun setTextSelection(@Nullable textSelection: TextSelection)
Sets the selected text.
Link copied to clipboard
abstract fun strikeoutSelectedText()
Strike out currently selected text.
Link copied to clipboard
abstract fun underlineSelectedText()
Underline currently selected text.