ro.sync.ecss.extensions.api.highlights
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 the AuthorPersistentHighlight. You can register such a listener using AuthorDocumentController.addAuthorPersistentHighlightListener(AuthorPersistentHighlightsListener),

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.

Constructor Summary

AuthorPersistentHighlightsListener()

Method Summary

abstract void	highlightAdded(AuthorPersistentHighlight highlight) Notified when a AuthorPersistentHighlight is added to the document.
abstract void	highlightRemoved(AuthorPersistentHighlight highlight) Notified when a AuthorPersistentHighlight is removed from the document.
abstract void	highlightsChanged() Event which notifies that the list of highlights (change tracking, comments or custom) has changed in an unpredictable way.
abstract void	highlightUpdated(AuthorPersistentHighlight highlight) Notified when a property of a AuthorPersistentHighlight is updated, for example changing the comment of a change tracking marker.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthorPersistentHighlightsListener

public AuthorPersistentHighlightsListener()

Method Detail

highlightAdded

public abstract void highlightAdded(AuthorPersistentHighlight highlight)

Notified when a AuthorPersistentHighlight is added to the document.

Parameters:

highlight - Added highlight.

highlightRemoved

public abstract void highlightRemoved(AuthorPersistentHighlight highlight)

Notified when a AuthorPersistentHighlight is removed from the document.

Parameters:

highlight - The removed highlight.

highlightUpdated

public abstract void highlightUpdated(AuthorPersistentHighlight highlight)

Notified when a property of a AuthorPersistentHighlight is updated, for example changing the comment of a change tracking marker.

Parameters:

highlight - The updated highlight.

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.