Constructor Detail

Method Detail

• setOnSearchSelectedTextListener

   abstract void setOnSearchSelectedTextListener(@Nullable() TextSelectionController.OnSearchSelectedTextListener searchSelectedTextListener)

  Sets a new OnSearchSelectedTextListener or replaces an existing one. This allows custom handling for selected text search.

  Parameters:

  searchSelectedTextListener - New listener or null to clear the listener.

• getTextSelection

  @Nullable() abstract TextSelection getTextSelection()

  Returns the current text selection.

  Returns:

  Currently selected text.

• setTextSelection

   abstract void setTextSelection(@Nullable() TextSelection textSelection)

  Sets the selected text.

  Parameters:

  textSelection - Text selection to select.

• getTextSelectionManager

  @NonNull() abstract TextSelectionManager getTextSelectionManager()

  Gets text selection manager for registering text selection listeners from the controller.

  Returns:

  A text selection manager for managing the text selection listeners.

• highlightSelectedText

   abstract void highlightSelectedText()

  Highlight currently selected text.

• highlightSelectedTextAndBeginCommenting

   void highlightSelectedTextAndBeginCommenting()

  Highlight the currently selected text and begin editing its comments.

  Only useful in the context of Instant.

• redactSelectedText

   abstract void redactSelectedText()

  Redact currently selected text.

• strikeoutSelectedText

   abstract void strikeoutSelectedText()

  Strike out currently selected text.

• underlineSelectedText

   abstract void underlineSelectedText()

  Underline currently selected text.

• searchSelectedText

   abstract void searchSelectedText()

  Search currently selected text.

• createLinkAboveSelectedText

   abstract void createLinkAboveSelectedText()

  Creates link above the selected text.

• isTextHighlightingEnabledByConfiguration

   abstract boolean isTextHighlightingEnabledByConfiguration()

  Indicates whether annotation editing (text highlights are annotations) is enabled by configuration.

  Returns:

  true if adding highlight annotations is enabled by configuration, false otherwise.

• isLinkCreationEnabledByConfiguration

   abstract boolean isLinkCreationEnabledByConfiguration()

  Indicates whether annotation editing is enabled by configuration and link annotations are editable.

  Returns:

  true if adding links is enabled by configuration, false otherwise.

• isTextSharingEnabledByConfiguration

   abstract boolean isTextSharingEnabledByConfiguration()

  Indicates whether text sharing is enabled by configuration.

  Returns:

  true if text sharing is enabled by configuration, false otherwise.

• isTextExtractionEnabledByDocumentPermissions

   abstract boolean isTextExtractionEnabledByDocumentPermissions()

  Indicates whether the text extraction is enabled by document permissions, meaning the document contains EXTRACT permission.

  Returns:

  true if text extraction is enabled, false otherwise.

• isTextSpeakEnabledByDocumentPermissions

   abstract boolean isTextSpeakEnabledByDocumentPermissions()

  Indicates whether the text extraction for accessibility purposes is enabled by document permissions, meaning the document contains EXTRACT_ACCESSIBILITY permission.

  Returns:

  true if text extraction for accessibility purposes is enabled, false otherwise.

• isRedactionEnabledByConfiguration

   abstract boolean isRedactionEnabledByConfiguration()

  Indicates whether text redaction is enabled by configuration-

  Returns:

  true if text redaction is enabled, false otherwise.

• isInstantHighlightCommentingEnabledByConfiguration

   boolean isInstantHighlightCommentingEnabledByConfiguration()

  Indicates whether Instant Comments on text highlights are enabled by configuration

  Returns:

  true if creating an Instant Comment thread from a text highlight is enabled, false otherwise.