Package ro.sync.ecss.extensions.api.review

Class ReviewsRenderingInformationProvider

java.lang.Object

ro.sync.ecss.extensions.api.review.ReviewsRenderingInformationProvider

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class ReviewsRenderingInformationProvider
extends Object

Provider for data that will be rendered in the review view, in Author mode for highlights.

Since:

17.1

Constructor Summary

Constructors

Constructor	Description
ReviewsRenderingInformationProvider()

Method Summary

Modifier and Type	Method	Description
abstract AuthorReviewRenderingInformation	getReviewRenderingInformation(AuthorPersistentHighlight highlight)	Get the review rendering information associated with a highlight.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReviewsRenderingInformationProvider

public ReviewsRenderingInformationProvider()

Method Details

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.