Oxygen XML Editor 16.1 Author API

ro.sync.ecss.extensions.api
Interface AuthorReviewController

All Superinterfaces:
AuthorChangeTrackingController, AuthorReviewerNameController

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorReviewController
extends AuthorChangeTrackingController, AuthorReviewerNameController

Controller that can be used to toggle the change tracking state, modify the review highlight author name, the highlight painting or to obtain information about the properties used in the serialization and representation of the review highlight (author name, reviewer auto color or the current time stamp in a format identical to the one used by Oxygen for insert, delete and comment review highlights).

Since:
12

Method Summary
 AuthorCalloutsController getAuthorCalloutsController()
          The callouts are representations of Track Changes insert and delete highlights, review comment highlights and the custom review 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.
 
Methods inherited from interface ro.sync.ecss.extensions.api.AuthorChangeTrackingController
accept, accept, getChangeHighlights, getChangeHighlights, isTrackingChanges, reject, reject, toggleTrackChanges
 
Methods inherited from interface ro.sync.ecss.extensions.api.AuthorReviewerNameController
getReviewerAuthorName, setReviewerAuthorName
 

Method Detail

getAuthorCalloutsController

AuthorCalloutsController getAuthorCalloutsController()
The callouts are representations of Track Changes insert and delete highlights, review comment highlights and the custom review highlights in Author mode.
This controller can be used to check what types of callouts are presented in Author mode. It also can be used to override the callouts display options from Oxygen Preferences.

Returns:
The Author review callouts controller.
Since:
14

getCurrentTimestamp

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.
Form: yyyyMMdd'T'HHmmssZ

Returns:
the current time stamp.

getReviewerAutoColor

Color getReviewerAutoColor(java.lang.String reviewerAuthorName)
Get a color assigned automatically to the reviewer author name.
It is used when in the Oxygen Preferences Auto coloring is set for the Insert, Delete or Comment reviews.

Parameters:
reviewerAuthorName - The reviewer author name.
Returns:
The color automatically assigned to the specified author. Never null.

setReviewRenderer

void setReviewRenderer(PersistentHighlightRenderer renderer)
Set a renderer for customizing the way that the review highlights (Insert, Delete or Comment) are displayed.

Parameters:
renderer - the renderer used to customize painting for the review highlights.

getCommentHighlights

AuthorPersistentHighlight[] getCommentHighlights()
Fetches the list of comment highlights.

Returns:
The comment highlights array.
Since:
12

getCommentHighlights

AuthorPersistentHighlight[] getCommentHighlights(int startOffset,
                                                 int endOffset)
Fetches the list of comment highlights that intersect the interval between the given start offset and end offset.

Parameters:
startOffset - The start offset(inclusive).
endOffset - The end offset (inclusive).
Returns:
The comment highlights array. Can be null if no comment highlight intersects the given offsets interval.
Since:
14.1

Oxygen XML Editor 16.1 Author API

© Copyright SyncRO Soft SRL 2002 - 2014. All rights reserved.