@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface AuthorReviewController extends AuthorChangeTrackingController, AuthorReviewerNameController
Modifier and Type | Method and Description |
---|---|
AuthorCalloutsController |
getAuthorCalloutsController()
The callouts are representations of Track Changes insert and delete highlights,
review comment highlights and the custom review highlights in Author mode.
|
AuthorReviewViewController |
getAuthorReviewViewController()
The entries in the Review View are representations of Track Changes insert and delete highlights,
review comment highlights in Author mode.
|
AuthorPersistentHighlight[] |
getCommentHighlights()
Fetches the list of comment highlights.
|
AuthorPersistentHighlight[] |
getCommentHighlights(int startOffset,
int endOffset)
Fetches the list of comment highlights that intersect the interval
between the given start offset and end offset.
|
java.lang.String |
getCurrentTimestamp()
Get the current time stamp in a format identical to the one used by Oxygen for
insert and delete review highlights.
|
Color |
getReviewerAutoColor(java.lang.String reviewerAuthorName)
Get a color assigned automatically to the reviewer author name.
|
void |
setReviewRenderer(PersistentHighlightRenderer renderer)
Set a renderer for customizing the way that the review highlights (
Insert , Delete or Comment ) are displayed. |
accept, accept, getAttributeChangeHighlights, getChangeHighlights, getChangeHighlights, isTrackingChanges, reject, reject, toggleTrackChanges
getReviewerAuthorName, setReviewerAuthorName
AuthorCalloutsController getAuthorCalloutsController()
AuthorReviewViewController getAuthorReviewViewController()
Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.
java.lang.String getCurrentTimestamp()
yyyyMMdd'T'HHmmssZ
Color getReviewerAutoColor(java.lang.String reviewerAuthorName)
Insert
, Delete
or Comment
reviews.reviewerAuthorName
- The reviewer author name.void setReviewRenderer(PersistentHighlightRenderer renderer)
Insert
, Delete
or Comment
) are displayed.renderer
- the renderer used to customize painting for the review highlights.AuthorPersistentHighlight[] getCommentHighlights()
AuthorPersistentHighlight[] getCommentHighlights(int startOffset, int endOffset)
startOffset
- The start offset(inclusive).endOffset
- The end offset (inclusive).null
if
no comment highlight intersects the given offsets interval.© Copyright SyncRO Soft SRL 2002 - 2015. All rights reserved.