ro.sync.ecss.extensions.api.highlights

Interface AuthorPersistentHighlight

All Superinterfaces:

AuthorPersistentHighlightConstants

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface AuthorPersistentHighlight
extends AuthorPersistentHighlightConstants

Defines the Author Persistent Highlight which get serialized in the XML as processing instruction. The Author Persistent Highlight has one of the following types defined in AuthorPersistentHighlight.PersistentHighlightType:

• AuthorPersistentHighlight.PersistentHighlightType.CUSTOM_HIGHLIGHT represents the Custom defined highlights that can be managed by using the AuthorPersistentHighlighter. The name of the processing instruction markers corresponding to this type of highlight are oxy_custom_start and oxy_custom_end
• AuthorPersistentHighlight.PersistentHighlightType.COMMENT represents the Comment highlights which get serialized using the oxy_comment_start and oxy_comment_end processing instruction names.
• AuthorPersistentHighlight.PersistentHighlightType.CHANGE_INSERT represents the Insert highlight from Change Tracking, with the oxy_insert_start and oxy_insert_end corresponding processing instruction names.
• AuthorPersistentHighlight.PersistentHighlightType.CHANGE_DELETE represents the Delete highlight from Change Tracking, which get serialized by using the oxy_delete processing instruction name.
  

The Comment, Insert and Delete persistent highlights can be accessed and customized by using the AuthorReviewController.

Since:

12

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AuthorPersistentHighlight.PersistentHighlightType The Author Persistent Highlight type.

Field Summary

Fields inherited from interface ro.sync.ecss.extensions.api.highlights.AuthorPersistentHighlightConstants

AUTHOR_NAME_ATTRIBUTE, COMMENT_ATTRIBUTE, COMMENT_ID, COMMENT_PARENT_ID, DONE_ATTRIBUTE_VALUE, FLAG_ATTRIBUTE, MODIFICATION_TIME

Method Summary

Modifier and Type	Method and Description
java.util.LinkedHashMap<java.lang.String,java.lang.String>	getClonedProperties() Returns a copy of the internal properties map.
int	getEndOffset() Get the highlight end offset.
int	getStartOffset() Get the highlight start offset.
AuthorPersistentHighlight.PersistentHighlightType	getType() The persistent highlight type.

Method Detail

getStartOffset

int getStartOffset()

Get the highlight start offset.

Returns:

The start offset (inclusive).

getEndOffset

int getEndOffset()

Get the highlight end offset.

Returns:

The end offset (inclusive).

getClonedProperties

java.util.LinkedHashMap<java.lang.String,java.lang.String> getClonedProperties()

Returns a copy of the internal properties map. The properties can contain details about the highlight author or the highlight modification timestamp, depending on the highlight type:

• The properties names for change tracking highlights are: AuthorPersistentHighlightConstants.AUTHOR_NAME_ATTRIBUTE, AuthorPersistentHighlightConstants.MODIFICATION_TIME
• For comment highlights the properties names are: AuthorPersistentHighlightConstants.AUTHOR_NAME_ATTRIBUTE, AuthorPersistentHighlightConstants.MODIFICATION_TIME, AuthorPersistentHighlightConstants.COMMENT_ATTRIBUTE and AuthorPersistentHighlightConstants.COMMENT_PARENT_ID (if it is a reply)
• Both comment highlights and insert and delete highlights can also have the AuthorPersistentHighlightConstants.COMMENT_ID property set
• The properties for custom persistent highlights are specified when the highlight is added (@see AuthorPersistentHighlighter.addHighlight(int, int, LinkedHashMap)) and can be changed using the AuthorPersistentHighlighter.setProperties(AuthorPersistentHighlight, LinkedHashMap) method.

Returns:

The copy of highlight properties.

getType

AuthorPersistentHighlight.PersistentHighlightType getType()

The persistent highlight type.

Returns:

The AuthorPersistentHighlight.PersistentHighlightType corresponding to this author persistent highlight.