ro.sync.ecss.extensions.api
Interface AuthorReviewController

All Superinterfaces:

AuthorChangeTrackingController

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

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.
java.lang.String	getReviewerAuthorName() Get the current reviewer author name.
Color	getReviewerAutoColor(java.lang.String reviewerAuthorName) Get a color assigned automatically to the reviewer author name.
void	setReviewerAuthorName(java.lang.String authorName) Set the current reviewer author name, used in the processing instruction that results when a Tracked Change (<?oxy_insert_start author="reviewer_name"...?>xml content<?oxy_insert_end?>) or Comment (<?oxy_comment_start author="reviewer_name"...?>xml content<?oxy_comment_end?>) is serialized, as value of the "author" attribute.
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

Method Detail

setReviewerAuthorName

void setReviewerAuthorName(java.lang.String authorName)

Set the current reviewer author name, used in the processing instruction that results when a
Tracked Change
(<?oxy_insert_start author="reviewer_name"...?>xml content<?oxy_insert_end?>)
or
Comment
(<?oxy_comment_start author="reviewer_name"...?>xml content<?oxy_comment_end?>)
is serialized, as value of the "author" attribute. By default the author name specified in the Oxygen Preferences is used for serialization.

Parameters:

authorName - The reviewer author name. If set to null, the default author name (as set in the Oxygen Preferences) will be used in Change Tracking and Comments serialization.

getReviewerAuthorName

java.lang.String getReviewerAuthorName()

Get the current reviewer author name.
By default, the reviewer author name is the author name specified in the Oxygen Preferences but it can be changed by using setReviewerAuthorName(String).

Returns:

The current reviewer author name.

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
*********************************
EXPERIMENTAL - Subject to change
********************************

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.

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

*********************************
EXPERIMENTAL - Subject to change
********************************

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.