@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface ReviewController extends AuthorChangeTrackingController, AuthorReviewerNameController
Modifier and Type | Method and Description |
---|---|
void |
addComment(int startOffset,
int endOffset,
java.lang.String comment)
Adds a comment marker at given offsets.
|
boolean |
addCommentOnSelection(int startOffset,
int endOffset,
java.lang.String comment)
Add comment on a selection.
|
AuthorPersistentHighlight |
addPersistentMarker(AuthorPersistentHighlight.PersistentHighlightType type,
int startOffset,
int endOffset,
java.util.Map<java.lang.String,java.lang.String> properties)
Add comment on a selection.
|
void |
addReply(java.util.Map<java.lang.String,java.lang.String> properties,
AuthorPersistentHighlight parentHighlight)
Adds a reply to the specified highlight.
|
void |
addReply(java.lang.String replyComment,
AuthorPersistentHighlight parentHighlight)
Adds a reply to the specified highlight.
|
void |
editComment(AuthorPersistentHighlight highlight,
java.lang.String newComment)
Edits the comment of a marker (comment and tracked change).
|
java.util.List<AuthorPersistentHighlight> |
getAllHighlights() |
java.lang.Integer |
getAuthorNumber(java.lang.String author)
Returns a number representing the author number.
|
void |
removeComment(AuthorPersistentHighlight highlight)
Removes a comment marker.
|
void |
toggleMarkAsDone(AuthorPersistentHighlight highlight)
Toggle the "done" state of the specified highlight.
|
accept, accept, acceptSelection, getAttributeChangeHighlights, getChangeHighlights, getChangeHighlights, isTrackingChanges, reject, reject, rejectSelection, toggleTrackChanges
getReviewerAuthorName, setReviewerAuthorName
void toggleMarkAsDone(AuthorPersistentHighlight highlight)
highlight
- The highlight to toggle the done state for.void addReply(java.lang.String replyComment, AuthorPersistentHighlight parentHighlight)
AuthorPersistentHighlight.PersistentHighlightType.CHANGE_INSERT
AuthorPersistentHighlight.PersistentHighlightType.CHANGE_DELETE
AuthorPersistentHighlight.PersistentHighlightType.COMMENT
AuthorPersistentHighlightConstants.COMMENT_ID
.
All its replies will have the AuthorPersistentHighlightConstants.COMMENT_PARENT_ID
property set, with the same value as the id of the parent.replyComment
- The reply comment.parentHighlight
- The parent highlight.void addReply(java.util.Map<java.lang.String,java.lang.String> properties, AuthorPersistentHighlight parentHighlight)
AuthorPersistentHighlight.PersistentHighlightType.CHANGE_INSERT
AuthorPersistentHighlight.PersistentHighlightType.CHANGE_DELETE
AuthorPersistentHighlight.PersistentHighlightType.COMMENT
AuthorPersistentHighlightConstants.COMMENT_ID
.
All its replies will have the AuthorPersistentHighlightConstants.COMMENT_PARENT_ID
property set, with the same value as the id of the parent.
The AuthorPersistentHighlightConstants.COMMENT_PARENT_ID
property in the given map is
ignored. The ID of the parent highlight is used instead.properties
- The reply properties. See
AuthorPersistentHighlightConstants
for properties that are meaningful in Oxygen.parentHighlight
- The parent highlight.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.
void addComment(int startOffset, int endOffset, java.lang.String comment)
startOffset
- The start offset of the marker (inclusive).endOffset
- The end offset of the marker (exclusive).comment
- The comment of the marker.boolean addCommentOnSelection(int startOffset, int endOffset, java.lang.String comment)
false
if the comment
cannot be added.startOffset
- The selection start offset.endOffset
- Interval end offset. Inclusivecomment
- The comment.true
if the comment is added.AuthorPersistentHighlight addPersistentMarker(AuthorPersistentHighlight.PersistentHighlightType type, int startOffset, int endOffset, java.util.Map<java.lang.String,java.lang.String> properties)
false
if the comment
cannot be added.type
- The persistent highlight type (custom or comment)startOffset
- The selection start offset.endOffset
- Interval end offset. Inclusiveproperties
- The comment properties. See
AuthorPersistentHighlightConstants
for properties that are meaningful in Oxygen.true
if the comment is added.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.
void removeComment(AuthorPersistentHighlight highlight)
highlight
- The comment marker.void editComment(AuthorPersistentHighlight highlight, java.lang.String newComment)
highlight
- The marker.newComment
- The new comment.java.util.List<AuthorPersistentHighlight> getAllHighlights()
java.lang.Integer getAuthorNumber(java.lang.String author)
author
- The name of the author.© Copyright Syncro Soft SRL 2002 - 2021. All rights reserved.