Class AuthorPersistentHighlightsListener
- java.lang.Object
-
- ro.sync.ecss.extensions.api.highlights.AuthorPersistentHighlightsListener
-
@API(type=EXTENDABLE, src=PUBLIC) public abstract class AuthorPersistentHighlightsListener extends java.lang.Object
Listener for all the events related to theAuthorPersistentHighlight
. You can register such a listener usingAuthorReviewController.addAuthorPersistentHighlightListener(AuthorPersistentHighlightsListener)
,- Since:
- 14
-
-
Constructor Summary
Constructors Constructor Description AuthorPersistentHighlightsListener()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
highlightAdded(AuthorPersistentHighlight highlight)
Notified when aAuthorPersistentHighlight
is added to the document.void
highlightRangeReconfiguredUpdated(AuthorPersistentHighlight highlight, int oldStartOffset, int oldEndOffset)
Notified when the range of aAuthorPersistentHighlight
is updated, for example the start or end offsets might have changed.abstract void
highlightRemoved(AuthorPersistentHighlight highlight)
Notified when aAuthorPersistentHighlight
is removed from the document.void
highlightsAdded(java.util.List<AuthorPersistentHighlight> highlights)
Notified when a list ofAuthorPersistentHighlight
are added to the document.abstract void
highlightsChanged()
Event which notifies that the list of highlights (change tracking, comments or custom) has changed in an unpredictable way.void
highlightsRemoved(java.util.List<AuthorPersistentHighlight> highlights)
Notified when a list ofAuthorPersistentHighlight
are removed from the document.abstract void
highlightUpdated(AuthorPersistentHighlight highlight)
Notified when a property of aAuthorPersistentHighlight
is updated, for example changing the comment of a change tracking marker.
-
-
-
Method Detail
-
highlightAdded
public abstract void highlightAdded(AuthorPersistentHighlight highlight)
Notified when aAuthorPersistentHighlight
is added to the document.- Parameters:
highlight
- Added highlight.
-
highlightsAdded
public void highlightsAdded(java.util.List<AuthorPersistentHighlight> highlights)
Notified when a list ofAuthorPersistentHighlight
are added to the document.- Parameters:
highlights
- Added highlights.
-
highlightRemoved
public abstract void highlightRemoved(AuthorPersistentHighlight highlight)
Notified when aAuthorPersistentHighlight
is removed from the document.- Parameters:
highlight
- The removed highlight.
-
highlightsRemoved
public void highlightsRemoved(java.util.List<AuthorPersistentHighlight> highlights)
Notified when a list ofAuthorPersistentHighlight
are removed from the document.- Parameters:
highlights
- The list of highlights to be removed.
-
highlightUpdated
public abstract void highlightUpdated(AuthorPersistentHighlight highlight)
Notified when a property of aAuthorPersistentHighlight
is updated, for example changing the comment of a change tracking marker.- Parameters:
highlight
- The updated highlight.
-
highlightRangeReconfiguredUpdated
public void highlightRangeReconfiguredUpdated(AuthorPersistentHighlight highlight, int oldStartOffset, int oldEndOffset)
Notified when the range of aAuthorPersistentHighlight
is updated, for example the start or end offsets might have changed.- Parameters:
highlight
- The updated highlight.oldStartOffset
- The old start range for the highlight.oldEndOffset
- The old end range for the highlight- Since:
- 23
-
highlightsChanged
public abstract void highlightsChanged()
Event which notifies that the list of highlights (change tracking, comments or custom) has changed in an unpredictable way. API code which inserts or deletes multiple fragments in one operation like:
ro.sync.ecss.extensions.api.AuthorDocumentController.insertMultipleFragments(AuthorElement, AuthorDocumentFragment[], int[])
ro.sync.ecss.extensions.api.AuthorDocumentController.insertMultipleElements(AuthorElement, String[], int[], String)
ro.sync.ecss.extensions.api.AuthorDocumentController.multipleDelete(AuthorElement, int[], int[])
will not fire atomic events each time a highlight is reconfigured.
Instead, they will fire a single event after the operation has finished notifying the listener to reconfigure all its highlight data.
This event will follow an:
ro.sync.ecss.dom.AuthorDocumentListener.authorNodeStructureChanged(AuthorNodeStructureChangedEvent)
event.
-
-