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

Class CalloutsRenderingInformationProvider

  • @API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class CalloutsRenderingInformationProvider
extends java.lang.Object
    Provider for data that will be rendered as callouts, in Author mode. By default it only handles custom persistent highlights but you can override the method handlesAlsoDefaultHighlights() to handle also built-in persistent highlights (comment, insertion or deletion change).
    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.
    The callouts rendering provider can be set from AuthorCalloutsController.setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider)
    Since:
    14

    • Constructor Detail

      • CalloutsRenderingInformationProvider

        public CalloutsRenderingInformationProvider()

    • Method Detail

      • getCalloutRenderingInformation

        public abstract AuthorCalloutRenderingInformation getCalloutRenderingInformation​(AuthorPersistentHighlight highlight)
        Get the callout rendering information associated with a persistent highlight.
        For custom highlights the callout rendering information is requested only for that custom persistent highlights for which the shouldRenderAsCallout(AuthorPersistentHighlight)
        For built-in persistent highlights (comment, insertion or deletion change) the rendering can be requested only you override the handlesAlsoDefaultHighlights() method 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 callout rendering information associated with a custom persistent highlight or null if the highlight must not be rendered in Author as a callout.

      • shouldRenderAsCallout

        public abstract boolean shouldRenderAsCallout​(AuthorPersistentHighlight highlight)
        Asks if a custom persistent highlight should be rendered as a callout in the Author mode.
        The callouts are representations of Track Changes insert and delete highlights, review comment highlights and custom persistent highlights in Author mode.
        If this method returns true, the callout rendering information for this callout must be provided by getCalloutRenderingInformation(AuthorPersistentHighlight) method.
        The implementation of this method must be fast, being called frequently.
        Parameters:
        highlight - The Author custom persistent highlight.
        Returns:
        true if the highlight can be rendered as a callout in Author mode.

      • handlesAlsoDefaultHighlights

        public boolean handlesAlsoDefaultHighlights()
        Return true if you want the rendering information provider to be also called for built-in persistent highlights (comment, insertion or deletion change). The callout rendering information is requested only if the application preferences are configured to show callouts for these highlight types. By default the rendering information provider is called only for custom highlights.
        The callouts are representations of Track Changes insert and delete highlights, review comment highlights and custom review highlights in Author mode.
        Returns:
        true if the getCalloutRenderingInformation(AuthorPersistentHighlight) method should be called also for built-in persistent highlights (comment, insertion or deletion change).
        Since:
        17.1