Class ReviewsRenderingInformationProvider


  • @API(type=EXTENDABLE,
         src=PUBLIC)
    public abstract class ReviewsRenderingInformationProvider
    extends java.lang.Object
    Provider for data that will be rendered in the review view, in Author mode for highlights.
    Since:
    17.1
    • Constructor Detail

      • ReviewsRenderingInformationProvider

        public ReviewsRenderingInformationProvider()
    • Method Detail

      • getReviewRenderingInformation

        public abstract AuthorReviewRenderingInformation getReviewRenderingInformation​(AuthorPersistentHighlight highlight)
        Get the review rendering information associated with a highlight.
        The review entries are representations of Track Changes insert and delete highlights and review comment highlights in Author mode.
        Parameters:
        highlight - The Author persistent highlight. You can use the AuthorPersistentHighlight.getType() method to obtain its type.
        Returns:
        The review rendering information associated with a persistent highlight.