Package ro.sync.ecss.extensions.api.callouts

Interface AuthorCalloutsController

@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface AuthorCalloutsController
The callouts are representations of Track Changes insert and delete highlights, review comment highlights and custom review highlights in the Author mode on a side bar.
This controller can be used to decide what types of callouts must be presented in Author mode. It must be provided through AuthorReviewController.getAuthorCalloutsController() method.

To render a custom highlight as a callout in Author mode, a callout information provider must be set from setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider) method.

By default, the callouts visibility in Author mode is controlled from Oxygen Preferences but it can be changed by using the methods in this class. The Preferences will not be affected by the API.
Since:
14

  • Method Details

    • isShowingCommentsCallouts

      boolean isShowingCommentsCallouts()
      Check if the callouts corresponding to review comments and Change Tracking deletions and insertions with comments are visible in Author mode.
      By default, the comments callouts visibility in Author mode is controlled from Oxygen Preferences but it can be changed by using the setShowCommentsCallouts(Boolean) method.
      Note that when there are no review callouts, the callouts side bar is collapsed.
      Returns:
      true if the callouts with comments are visible.

    • setShowCommentsCallouts

      void setShowCommentsCallouts(Boolean showCommentsCallouts)
      The Track Changes insert and delete markers, the review comment markers and the custom review markers can be presented in Author mode as callouts.
      This method can be used to override the default option from Oxygen Preferences that controls if the callouts corresponding to review comments and Change Tracking deletions and insertions with comments are displayed in Author mode.
      Note that when there are no review callouts, the callouts side bar is collapsed.
      Parameters:
      showCommentsCallouts - If true, the review callouts with comments are displayed in Author mode. The callouts with comments are hidden when the provided value is false.
      When the value is set to null, the option from Oxygen Preferences is taken into consideration.

    • isShowingDeletionsCallouts

      boolean isShowingDeletionsCallouts()
      Check if the callouts corresponding to Change Tracking deletions are visible in Author mode.
      By default, the Change Tracking deletions callouts visibility in Author mode is controlled from Oxygen Preferences but it can be changed by using the setShowDeletionsCallouts(Boolean) method.
      Note that when there are no review callouts, the callouts side bar is collapsed.
      Returns:
      true if the Track Changes deletions callouts are displayed in Author mode.

    • setShowDeletionsCallouts

      void setShowDeletionsCallouts(Boolean showDeletionsCallouts)
      The Track Changes insert and delete markers, the review comment markers and the custom review markers can be presented in Author mode as callouts.
      This method can be used to override the default option from Oxygen Preferences that controls if the callouts corresponding to Change Tracking deletions are displayed in Author mode.
      Note that when there are no review callouts, the callouts side bar is collapsed.
      Parameters:
      showDeletionsCallouts - If true, the Track Changes deletions callouts are displayed in Author mode. The deletions callouts are hidden when the provided value is false.
      When the value is set to null, the option from Oxygen Preferences is taken into consideration.

    • isShowingInsertionsCallouts

      boolean isShowingInsertionsCallouts()
      Check if the callouts corresponding to Change Tracking insertions are visible in Author mode.
      By default, the Change Tracking insertions callouts visibility in Author mode is controlled from Oxygen Preferences but it can be changed by using the setShowInsertionsCallouts(Boolean) method.
      Note that when there are no review callouts, the callouts side bar is collapsed.
      Returns:
      true if the Track Changes insertions callouts are visible.

    • setShowInsertionsCallouts

      void setShowInsertionsCallouts(Boolean showInsertionsCallouts)
      The Track Changes insert and delete markers, the review comment markers and the custom review markers can be presented in Author mode as callouts.
      This method can be used to override the default option from Oxygen Preferences that controls if the callouts corresponding to Change Tracking insertions are displayed in Author mode.
      Note that when there are no review callouts, the callouts side bar is collapsed.
      Parameters:
      showInsertionsCallouts - If true, the Track Changes insertions callouts are displayed in Author mode. The insertions callouts are hidden when the provided value is false.
      When the value is set to null, the option from Oxygen Preferences is taken into consideration.

    • setCalloutsRenderingInformationProvider

      void setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider provider)
      Set the provider for data that will be rendered as a callout, in Author mode, for a specific highlight.
      The callouts are representations of Track Changes insert and delete highlights, review comment highlights and custom review highlights in Author mode.
      By default, the callouts visibility in Author mode is controlled from Oxygen Preferences but it can be changed by using the AuthorCalloutsController methods.
      Parameters:
      provider - The highlights callout rendering information provider.
      Throws:
      IllegalArgumentException - Thrown when a property name is not a valid XML attribute name.
      Since:
      14

    • getCalloutRectangle

      Rectangle getCalloutRectangle(AuthorPersistentHighlight persistentHighlight)
      Retrieves the bounds of the callout box associated with an Author persistent highlight.
      Parameters:
      persistentHighlight - The Author persistent highlight.
      Returns:
      The bounds of the callout box associated with the given Author persistent highlight, relative to the editor area's origins, or null if there is no corresponding callout box.
      Since:
      14.2

    • addCalloutActionsProvider

      void addCalloutActionsProvider(CalloutActionsProvider actionsProvider)
      Add a callout actions provider.
      Parameters:
      actionsProvider - The callout actions provider.
      Since:
      17

    • removeCalloutActionsProvider

      void removeCalloutActionsProvider(CalloutActionsProvider actionsProvider)
      Remove a callout actions provider.
      Parameters:
      actionsProvider - The callout actions provider.
      Since:
      17

    • getDefaultAuthorCalloutRenderingInformation

      AuthorCalloutRenderingInformation getDefaultAuthorCalloutRenderingInformation(AuthorPersistentHighlight highlight)
      Return the default rendering information for built-in persistent highlights (comment, insertion or deletion change). You can change the rendering information for such highlights by setting a CalloutsRenderingInformationProvider and overriding its method CalloutsRenderingInformationProvider.handlesAlsoDefaultHighlights() to return true.
      The callouts are representations of Track Changes insert and delete highlights, review comment highlights and custom review highlights in Author mode.
      Parameters:
      highlight - The Author persistent highlight. The type of the highlight can be obtained by using the AuthorPersistentHighlight.getType()
      Returns:
      the default rendering information for built-in persistent highlights (comment, insertion or deletion change).
      Since:
      17.1